1. Epic GamesDeveloper
  3. UNiagaraNodeFunctionCall

UNiagaraNodeFunctionCall

API > API/Plugins > API/Plugins/NiagaraEditor

Inheritance Hierarchy

References

   
Module NiagaraEditor
Header /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNodeFunctionCall.h
Include #include "NiagaraNodeFunctionCall.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraNodeFunctionCall : public UNiagaraNodeWithDynamicPins

Variables

  Type 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, FName > BoundPinNames  
Protected variable UProperty Meta FGuid CachedChangeId Adjusted every time that we compile this script.
Public variable UProperty ENiagaraFunctionDebugState DebugState  
Protected variable UProperty FString FunctionDisplayName  
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< 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, FName > 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 FNiagaraMessageStore MessageStore  
Protected variable FOnInputsChanged 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< FNiagaraPropagatedVariable > 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 FNiagaraFunctionSignature Signature Some functions can be provided a signature directly rather than a script.
Protected variable UProperty Meta TArray< FNiagaraStackMessage > StackMessages  

Functions

  Type Name Description
Public function void

AddOrphanedStaticSwitchPinForDataRetention ( FNiagaraVariableBase StaticSwitchVariable,
const FString& StaticSwitchPinDefault
)

 Adds a static switch pin to this function call node by variable id and sets it's default value using the supplied data and marks it as orphaned.
Protected function UEdGraphPin *  
Public function Virtual void  
Public function void

ChangeScriptVersion ( FGuid NewScriptVersion,
const FNiagaraScriptVersionUpgradeContext& UpgradeContext,
bool bShowNotesInStack,
bool bDeferOverridePinUpdate
)

 If bDeferOverridePinUpdate is true then it is the caller's responsibility to call UpdateOverridePins()
Public function void  
Protected function void

ComputeNodeName ( FString SuggestedName,
bool bForceSuggestion
)

 Resets the node name based on the referenced script or signature.
Public function Const bool Checks to see if this called function contains any debug switches
Public function Const bool

FindAutoBoundInput ( const UNiagaraNodeInput* InputNode,
const UEdGraphPin* PinToAutoBind,
FNiagaraVariable& OutFoundVar,
ENiagaraInputNodeUsage& OutNodeUsage
)

  
Public function Const UEdGraphPin *

FindParameterMapDefaultValuePin ( const FName VariableName,
ENiagaraScriptUsage InParentUsage,
FCompileConstantResolver ConstantResolver
)

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

FindParameterMapDefaultValuePins ( TConstArrayView< FName > VariableNames,
ENiagaraScriptUsage InParentUsage,
const FCompileConstantResolver& ConstantResolver,
TArrayView< UEdGraphPin* > DefaultPins
)

  
Public function FNiagaraPropagatedVariable *  
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  
Public function Const TArray< FGuid >  
Public function Const UNiagaraGraph *  
Public function Const ENiagaraScriptUsage  
Public function Const const TArray< FNiagaraStackMessage > & Custom Notes API - Deprecated. Used for transferring to stack editor data.
Public function Const UClass * If this is a DI function call, return the UClass of the DI. returns null for non DI function calls.
Public function Const FString  
Public function Const UNiagaraScriptSource *  
Public function FNiagaraMessageStore & Messages API.
Public function Virtual Const FText

GetNodeTitle ( ENodeTitleType::Type TitleType
)

  
Public function Virtual Const FLinearColor  
Public function Const FVersionedNiagaraScriptData *  
Public function Virtual Const FText  
Public function Virtual Const bool  
Public function Const bool  
Protected function Const bool

IsBaseSignatureOfDataInterfaceFunction ( const UEdGraphPin* Pin
)

  
Public function Virtual Const bool Returns true if this node is deprecated
Protected function Const bool  
Public function FOnInputsChanged &  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function void  
Public function void  
Public function void  
Public function void  
Protected function void

SetPinAutoGeneratedDefaultValue ( UEdGraphPin& FunctionInputPin,
UNiagaraNodeInput& FunctionScriptInputNode
)

  
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  
Public function void  
Protected function void  
Public function Virtual Const void  
Protected function void  
Public function void Does any automated data manipulated required to update DI function call nodes to the current version.

Overridden from UNiagaraNodeWithDynamicPins

  Type Name Description
Protected function Virtual Const bool  
Protected function Virtual Const bool

CanModifyPin ( const UEdGraphPin* Pin
)

 Called to determine if this node can modify a given pin at all.
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.
Public function Virtual Const void

CollectAddPinActions ( FNiagaraMenuActionCollector& Collector,
UEdGraphPin* AddPin
)

 Virtual functions to allow for custom actions in Add Pin menus.
Protected function Virtual void

MoveDynamicPin ( UEdGraphPin* Pin,
int32 MoveAmount
)

 Moves a pin among the pins of the same direction. Negative values for up, positive for down.
Protected function Virtual void

OnNewTypedPinAdded ( UEdGraphPin*& NewPin
)

 Called when a new typed pin is added by the user.
Protected function Virtual void

OnPinRenamed ( UEdGraphPin* RenamedPin,
const FString& OldPinName
)

 Called when a pin is renamed.
Protected function Virtual void

RemoveDynamicPin ( UEdGraphPin* Pin
)

 Removes a pin from this node with a transaction.

Overridden from UNiagaraNode

  Type Name Description
Public function Virtual void

AutowireNewNode ( UEdGraphPin* FromPin
)

  
Public function Virtual Const void

BuildParameterMapHistory ( FNiagaraParameterMapHistoryBuilder& OutHistory,
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 Const void

Compile ( FTranslator* Translator,
TArray< int32 >& Outputs
)

  
Public function Virtual TSharedRef< SWidget >  
Public function Virtual TSharedPtr< SGraphNode >  
Public function Virtual Const void Go through all the external dependencies of this node in isolation and add them to the reference id list.
Public function Virtual Const void

GetNodeContextMenuActions ( UToolMenu* Menu,
UGraphNodeContextMenuContext* Context
)

  
Public function Virtual Const ENiagaraNumericOutputTypeSelectionMode 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 * Gets the asset referenced by this node, or nullptr if there isn't one.
Public function Virtual Const void  
Public function Virtual void  
Public function Virtual bool Refreshes the node due to external changes, e.g. the underlying function changed for a function call node.
Public function Virtual Const void Old style compile hash code. To be removed in the future.

Typedefs

Name Description
FOnInputsChanged  

Deprecated Variables

  Type Name Description
Protected variable UProperty Meta TMap< FGuid, TObjectPtr< UNiagaraMessageData > > MessageKeyToMessageMap_DEPRECATED Marking those properties explicitly as editoronly_data will make localization not pick these up.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page