1. Epic GamesDeveloper
  3. UNiagaraNodeFunctionCall

UNiagaraNodeFunctionCall

API > API/Plugins > API/Plugins/NiagaraEditor

   
Name UNiagaraNodeFunctionCall
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNodeFunctionCall.h
Include Path #include "NiagaraNodeFunctionCall.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraNodeFunctionCall : public UNiagaraNodeWithDynamicPins

Inheritance Hierarchy

Derived Classes

Typedefs

Name Type Remarks Include Path
FOnInputsChanged TMulticastDelegate_NoParams< void >   NiagaraNodeFunctionCall.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bInheritDebugStatus bool Controls whether the debug state of the current function gets propagated into this function call. NiagaraNodeFunctionCall.h
  • EditAnywhere
  • Category="Debug"
DebugState ENiagaraFunctionDebugState   NiagaraNodeFunctionCall.h  
FunctionScript TObjectPtr< UNiagaraScript >   NiagaraNodeFunctionCall.h
  • EditAnywhere
  • Category="Function"
  • Meta=(ForceShowEngineContent=true, ForceShowPluginContent=true)
FunctionScriptAssetObjectPath FName A path to a script asset which can be used to assign the function script the first time that default pins are generated. NiagaraNodeFunctionCall.h
  • Transient
  • Meta=(SkipForCompileHash="true")
FunctionSpecifiers TMap< FName, FName >   NiagaraNodeFunctionCall.h
  • VisibleAnywhere
  • Category="Function"
PreviousScriptVersion FGuid Can be used by the ui after a version change to display change notes NiagaraNodeFunctionCall.h
  • Meta=(SkipForCompileHash="true")
PropagatedStaticSwitchParameters TArray< FNiagaraPropagatedVariable > All the input values the function propagates to the next higher caller instead of forcing the user to set them directly. NiagaraNodeFunctionCall.h  
PythonUpgradeScriptWarnings FString Can be used by the ui after a version change to display change notes NiagaraNodeFunctionCall.h
  • Meta=(SkipForCompileHash="true")
SelectedScriptVersion FGuid   NiagaraNodeFunctionCall.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Version Details"
Signature FNiagaraFunctionSignature Some functions can be provided a signature directly rather than a script. NiagaraNodeFunctionCall.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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. NiagaraNodeFunctionCall.h  

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() NiagaraNodeFunctionCall.h  

void CleanupPropagatedSwitchValues()

   NiagaraNodeFunctionCall.h  

bool ContainsDebugSwitch()

 Checks to see if this called function contains any debug switches NiagaraNodeFunctionCall.h  

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

   NiagaraNodeFunctionCall.h  

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

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

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

   NiagaraNodeFunctionCall.h  

FNiagaraPropagatedVariable * FindPropagatedVariable ( const FNiagaraVariable& Variable
)

   NiagaraNodeFunctionCall.h  

UEdGraphPin * FindStaticSwitchInputPin ( const FName& VariableName
) const

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

TArray< FGuid > GetBoundPinGuidsByName ( FName InputName
) const

   NiagaraNodeFunctionCall.h  

UNiagaraGraph * GetCalledGraph()

   NiagaraNodeFunctionCall.h  

ENiagaraScriptUsage GetCalledUsage()

   NiagaraNodeFunctionCall.h  

const TArray< FNiagaraStackMessage > & GetDeprecatedCustomNotes()

 Custom Notes API - Deprecated. Used for transferring to stack editor data. NiagaraNodeFunctionCall.h  

UClass * GetDIClass()

 If this is a DI function call, return the UClass of the DI. returns null for non DI function calls. NiagaraNodeFunctionCall.h  

FString GetFunctionName()

   NiagaraNodeFunctionCall.h  

UNiagaraScriptSource * GetFunctionScriptSource()

   NiagaraNodeFunctionCall.h  

FNiagaraMessageStore & GetMessageStore()

 Messages API. NiagaraNodeFunctionCall.h  

FVersionedNiagaraScriptData * GetScriptData()

   NiagaraNodeFunctionCall.h  

virtual bool GetValidateDataInterfaces()

   NiagaraNodeFunctionCall.h  

bool HasValidScriptAndGraph()

   NiagaraNodeFunctionCall.h  

FOnInputsChanged & OnInputsChanged()

   NiagaraNodeFunctionCall.h  

void RemoveAllDynamicPins()

   NiagaraNodeFunctionCall.h  

void RemovePropagatedVariable ( const FNiagaraVariable& Variable
)

   NiagaraNodeFunctionCall.h  

void SetFunctionSpecifier ( FName Key,
FName Value
)

   NiagaraNodeFunctionCall.h  

void SuggestName ( FString SuggestedName,
bool bForceSuggestion
)

 Tries to rename this function call to a new name. NiagaraNodeFunctionCall.h  

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. NiagaraNodeFunctionCall.h  

void UpdateOverridePins ( const FNiagaraScriptVersionUpgradeContext& UpgradeContext
)

   NiagaraNodeFunctionCall.h  

virtual void UpdateReferencedStaticsHashForNode ( FSHA1& HashState
) const

   NiagaraNodeFunctionCall.h  

void UpgradeDIFunctionCalls()

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

Overridden from UNiagaraNodeWithDynamicPins

Name Remarks Include Path Unreal Specifiers

virtual void CollectAddPinActions ( FNiagaraMenuActionCollector& Collector,
UEdGraphPin* AddPin
) const

 Virtual functions to allow for custom actions in Add Pin menus. NiagaraNodeFunctionCall.h  

Overridden from UNiagaraNode

Name Remarks Include Path Unreal Specifiers

virtual void BuildParameterMapHistory ( FNiagaraParameterMapHistoryBuilder& OutHistory,
bool bRecursive,
bool bFilterForCompilation
) const

 Adds the current node information to the parameter map history NiagaraNodeFunctionCall.h  

virtual bool CanAddToGraph ( UNiagaraGraph* TargetGraph,
FString& OutErrorMsg
) const

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

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

   NiagaraNodeFunctionCall.h  

virtual TSharedRef< SWidget > CreateTitleRightWidget()

   NiagaraNodeFunctionCall.h  

virtual void GatherExternalDependencyData ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId,
FNiagaraScriptHashCollector& HashCollector
) const

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

virtual ENiagaraNumericOutputTypeSelectionMode GetNumericOutputTypeSelectionMode()

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

virtual UObject * GetReferencedAsset()

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

virtual void OpenReferencedAsset()

   NiagaraNodeFunctionCall.h  

virtual bool RefreshFromExternalChanges ()

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

virtual void UpdateCompileHashForNode ( FSHA1& HashState
) const

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

Overridden from UEdGraphNode

Name Remarks Include Path Unreal Specifiers

virtual void AllocateDefaultPins()

   NiagaraNodeFunctionCall.h  

virtual void AutowireNewNode ( UEdGraphPin* FromPin
)

   NiagaraNodeFunctionCall.h  

virtual TSharedPtr< SGraphNode > CreateVisualWidget()

   NiagaraNodeFunctionCall.h  

virtual void GetNodeContextMenuActions ( UToolMenu* Menu,
UGraphNodeContextMenuContext* Context
) const

   NiagaraNodeFunctionCall.h  

virtual FText GetNodeTitle ( ENodeTitleType::Type TitleType
) const

   NiagaraNodeFunctionCall.h  

virtual FLinearColor GetNodeTitleColor()

   NiagaraNodeFunctionCall.h  

virtual FText GetTooltipText()

   NiagaraNodeFunctionCall.h  

virtual bool IsDeprecated()

 Returns true if this node is deprecated NiagaraNodeFunctionCall.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraNodeFunctionCall.h  

virtual void PostLoad()

   NiagaraNodeFunctionCall.h  

Protected

Name Remarks Include Path Unreal Specifiers

UEdGraphPin * AddStaticSwitchInputPin ( FNiagaraVariable Input
)

   NiagaraNodeFunctionCall.h  

void ComputeNodeName ( FString SuggestedName,
bool bForceSuggestion
)

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

void FixupFunctionScriptVersion()

   NiagaraNodeFunctionCall.h  

bool IsBaseSignatureOfDataInterfaceFunction ( const UEdGraphPin* Pin
) const

   NiagaraNodeFunctionCall.h  

bool IsValidPropagatedVariable ( const FNiagaraVariable& Variable
) const

   NiagaraNodeFunctionCall.h  

void RefreshSignature()

   NiagaraNodeFunctionCall.h  

void SetPinAutoGeneratedDefaultValue ( UEdGraphPin& FunctionInputPin,
UNiagaraNodeInput& FunctionScriptInputNode
)

   NiagaraNodeFunctionCall.h  

void UpdateNodeErrorMessage()

   NiagaraNodeFunctionCall.h  

void UpdatePinTooltips()

   NiagaraNodeFunctionCall.h  

void UpdateStaticSwitchPinsWithPersistentGuids()

   NiagaraNodeFunctionCall.h  

Overridden from UNiagaraNodeWithDynamicPins

Name Remarks Include Path Unreal Specifiers

virtual bool AllowDynamicPins()

   NiagaraNodeFunctionCall.h  

virtual bool CanModifyPin ( const UEdGraphPin* Pin
) const

 Called to determine if this node can modify a given pin at all. NiagaraNodeFunctionCall.h  

virtual bool CanMovePin ( const UEdGraphPin* Pin,
int32 DirectionToMove
) const

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

virtual bool CanRemovePin ( const UEdGraphPin* Pin
) const

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

virtual bool CanRenamePin ( const UEdGraphPin* Pin
) const

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

virtual void MoveDynamicPin ( UEdGraphPin* Pin,
int32 MoveAmount
)

 Moves a pin among the pins of the same direction. Negative values for up, positive for down. NiagaraNodeFunctionCall.h  

virtual void OnNewTypedPinAdded ( UEdGraphPin*& NewPin
)

 Called when a new typed pin is added by the user. NiagaraNodeFunctionCall.h  

virtual void OnPinRenamed ( UEdGraphPin* RenamedPin,
const FString& OldPinName
)

 Called when a pin is renamed. NiagaraNodeFunctionCall.h  

virtual void RemoveDynamicPin ( UEdGraphPin* Pin
)

 Removes a pin from this node with a transaction. NiagaraNodeFunctionCall.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
MessageKeyToMessageMap_DEPRECATED TMap< FGuid, TObjectPtr< UNiagaraMessageData > > Marking those properties explicitly as editoronly_data will make localization not pick these up. NiagaraNodeFunctionCall.h
  • Meta=(SkipForCompileHash="true")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page