UNiagaraNodeFunctionCall

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NiagaraEditor

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNodeFunctionCall.h

Include

#include "NiagaraNodeFunctionCall.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI)
class UNiagaraNodeFunctionCall : public UNiagaraNodeWithDynamicPins

Variables

Name Description

Public variable UProperty Category, EditAnywhere

bool

 

bInheritDebugStatus

Controls whether the debug state of the current function gets propagated into this function call.

Protected variable UProperty Meta

TMap< FGuid, FN...

 

BoundPinNames

Protected variable UProperty Meta

FGuid

 

CachedChangeId

Adjusted every time that we compile this script.

Public variable UProperty

ENiagaraFunctio...

 

DebugState

Protected variable UProperty

FString

 

FunctionDisplayName

Public variable UProperty Category, EditAnywhere, Meta

UNiagaraScript ...

 

FunctionScript

Public variable UProperty Meta Transient

FName

 

FunctionScriptAssetObjectPath

A path to a script asset which can be used to assign the function script the first time that default pins are generated.

Public variable UProperty Category visibleanywhere

TMap< FName, FN...

 

FunctionSpecifiers

Protected variable UProperty

FGuid

 

InvalidScriptVersionReference

If a script version we reference goes away we select a fallback version, but save the original version to generate warnings.

Protected variable UProperty Meta

TMap< FGuid, UN...

 

MessageKeyToMessageMap

Protected variable

FSimpleDelegate

 

OnCustomNotesChangedDelegate

Protected variable

FOnInputsChange...

 

OnInputsChangedDelegate

Public variable UProperty Meta

FGuid

 

PreviousScriptVersion

Can be used by the ui after a version change to display change notes

Public variable UProperty

TArray< FNiagar...

 

PropagatedStaticSwitchParameters

All the input values the function propagates to the next higher caller instead of forcing the user to set them directly.

Public variable UProperty Meta

FString

 

PythonUpgradeScriptWarnings

Can be used by the ui after a version change to display change notes

Public variable UProperty Category, AdvancedDisplay visibleanywhere

FGuid

 

SelectedScriptVersion

Public variable UProperty

FNiagaraFunctio...

 

Signature

Some functions can be provided a signature directly rather than a script.

Protected variable UProperty Meta

TArray< FNiagar...

 

StackMessages

Functions

Name Description

Public function

void

 

AddCustomNote

(
    const FNiagaraStackMessage& StackM...
)

Public function

void

 

AddMessage

(
    const FGuid& MessageKey,
    UNiagaraMessageData* NewMessag...
)

Public function

void

 

ChangeScriptVersion

(
    FGuid NewScriptVersion,
    const FNiagaraScriptVersionUpgradeC...,
    bool bShowNotesInStack
)

Public function

void

 

CleanupPropagatedSwitchValues()

Protected function

void

 

ComputeNodeName

(
    FString SuggestedName,
    bool bForceSuggestion
)

Resets the node name based on the referenced script or signature.

Public function Const

bool

 

ContainsDebugSwitch()

Checks to see if this called function contains any debug switches

Public function

bool

 

FindAutoBoundInput

(
    UNiagaraNodeInput* InputNode,
    UEdGraphPin* PinToAutoBind,
    FNiagaraVariable& OutFoundVar,
    ENiagaraInputNodeUsage& OutNodeUsa...
)

Public function Const

UEdGraphPin ...

 

FindParameterMapDefaultValuePin

(
    const FName VariableName,
    ENiagaraScriptUsage InParentUsage,
    FCompileConstantResolver ConstantRe...
)

Walk through the internal script graph for an ParameterMapGet nodes and see if any of them specify a default for VariableName.

Public function

FNiagaraProp...

 

FindPropagatedVariable

(
    const FNiagaraVariable& Variable
)

Public function Const

UEdGraphPin ...

 

FindStaticSwitchInputPin

(
    const FName& VariableName
)

Attempts to find the input pin for a static switch with the given name in the internal script graph.

Protected function

void

 

FixupFunctionScriptVersion()

Public function

bool

 

FixupPinNames()

Checks if the existing pin names match the function script parameter names and try to fix them via guid matching if there is a difference

Protected function Const

TArray< FGui...

 

GetBoundPinGuidsByName

(
    FName InputName
)

Public function Const

UNiagaraGrap...

 

GetCalledGraph()

Public function Const

ENiagaraScri...

 

GetCalledUsage()

Public function Const

const TArray...

 

GetCustomNotes()

Custom Notes API.

Public function Const

FString

 

GetFunctionName()

Public function Const

UNiagaraScri...

 

GetFunctionScriptSource()

Public function Const

const TMap< ...

 

GetMessages()

Messages API.

Public function Const

FVersionedNi...

 

GetScriptData()

Protected function Virtual Const

bool

 

GetValidateDataInterfaces()

Protected function Const

bool

 

IsValidPropagatedVariable

(
    const FNiagaraVariable& Variable
)

Public function

FSimpleDeleg...

 

OnCustomNotesChanged()

Public function

FOnInputsCha...

 

OnInputsChanged()

Public function

void

 

RemoveCustomNote

(
    const FGuid& MessageKey
)

Public function

void

 

RemoveCustomNoteViaDelegate

(
    const FGuid MessageKey
)

Public function

void

 

RemoveMessage

(
    const FGuid& MessageKey
)

Public function

void

 

RemoveMessageDelegateable

(
    const FGuid MessageKey
)

Public function

void

 

RemovePropagatedVariable

(
    const FNiagaraVariable& Variable
)

Public function Const

bool

 

ScriptIsValid()

Protected function

void

 

SetPinAutoGeneratedDefaultValue

(
    UEdGraphPin& FunctionInputPin,
    UNiagaraNodeInput& FunctionScriptI...
)

Public function

void

 

SuggestName

(
    FString SuggestedName,
    bool bForceSuggestion
)

Tries to rename this function call to a new name.

Public function

void

 

UpdateInputNameBinding

(
    const FGuid& BoundVariableGuid,
    const FName& BoundName
)

When overriding an input value, this updates which variable guid was bound to which input name, so it can be reassigned when the input is renamed.

Protected function

void

 

UpdateNodeErrorMessage()

Protected function

void

 

UpdatePinTooltips()

Public function

void

 

UpgradeDIFunctionCalls()

Does any automated data manipulated required to update DI function call nodes to the current version.

Overridden from UNiagaraNodeWithDynamicPins

Name Description

Protected function Virtual Const

bool

 

AllowDynamicPins()

Protected function Virtual Const

bool

 

CanMovePin

(
    const UEdGraphPin* Pin,
    int32 DirectionToMove
)

Called to determine if a pin can be moved by the user. Negative values for up, positive for down.

Protected function Virtual Const

bool

 

CanRemovePin

(
    const UEdGraphPin* Pin
)

Called to determine if a pin can be removed by the user.

Protected function Virtual Const

bool

 

CanRenamePin

(
    const UEdGraphPin* Pin
)

Called to determine if a pin can be renamed by the user.

Overridden from UNiagaraNode

Name Description

Public function Virtual Const

void

 

BuildParameterMapHistory

(
    FNiagaraParameterMapHistoryBuilder ...,
    bool bRecursive,
    bool bFilterForCompilation
)

Adds the current node information to the parameter map history

Public function Virtual Const

bool

 

CanAddToGraph

(
    UNiagaraGraph* TargetGraph,
    FString& OutErrorMsg
)

Apply any node-specific logic to determine if it is safe to add this node to the graph.

Public function Virtual

void

 

Compile

(
    FHlslNiagaraTranslator* Transl...,
    TArray< int32 >& Outputs
)

Public function Virtual Const

void

 

GatherExternalDependencyData

(
    ENiagaraScriptUsage InMasterUsage,
    const FGuid& InMasterUsageId,
    TArray< FNiagaraCompileHash >& InR...,
    TArray< FString >& InReferencedObj...
)

Go through all the external dependencies of this node in isolation and add them to the reference id list.

Public function Virtual Const

ENiagaraNume...

 

GetNumericOutputTypeSelectionMode()

Gets which mode to use when deducing the type of numeric output pins from the types of the input pins.

Public function Virtual Const

UObject *...

 

GetReferencedAsset()

Gets the asset referenced by this node, or nullptr if there isn't one.

Public function Virtual

bool

 

RefreshFromExternalChanges()

Refreshes the node due to external changes, e.g. the underlying function changed for a function call node.

Public function Virtual Const

void

 

UpdateCompileHashForNode

(
    FSHA1& HashState
)

Old style compile hash code. To be removed in the future.

Overridden from UEdGraphNode

Name Description

Public function Virtual

void

 

AllocateDefaultPins()

Allocate default pins for a given node, based only the NodeType, which should already be filled in.

Public function Virtual

void

 

AutowireNewNode

(
    UEdGraphPin* FromPin
)

Autowire a newly created node.

Public function Virtual

TSharedPtr< ...

 

CreateVisualWidget()

Create a visual widget to represent this node in a graph editor or graph panel.

Public function Virtual Const

FText

 

GetNodeTitle

(
    ENodeTitleType::Type TitleType
)

Gets the name of this node, shown in title bar

Public function Virtual Const

FLinearColor

 

GetNodeTitleColor()

Gets the draw color of a node's title bar

Public function Virtual Const

FText

 

GetTooltipText()

Gets the tooltip to display when over the node

Public function Virtual Const

bool

 

IsDeprecated()

Returns true if this node is deprecated

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name

Description

FOnInputsChanged

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss