Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > UNiagaraNodeFunctionCall

Light Theme

Dark Theme

UNiagaraNodeFunctionCall

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEdGraphNode

UNiagaraNode

UNiagaraNodeWithDynamicPins

UNiagaraNodeFunctionCall

	UNiagaraNodeAssignment
	UNiagaraNodeCustomHlsl

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

	Name	Description
bool	bInheritDebugStatus	Controls whether the debug state of the current function gets propagated into this function call.
TMap< FGuid, FN...	BoundPinNames
FGuid	CachedChangeId	Adjusted every time that we compile this script.
ENiagaraFunctio...	DebugState
FString	FunctionDisplayName
TObjectPtr< UNi...	FunctionScript
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.
TMap< FName, FN...	FunctionSpecifiers
FGuid	InvalidScriptVersionReference	If a script version we reference goes away we select a fallback version, but save the original version to generate warnings.
TMap< FGuid, TO...	MessageKeyToMessageMap	Marking those properties explicitly as editoronly_data will make localization not pick these up.
FSimpleDelegate	OnCustomNotesChangedDelegate
FOnInputsChange...	OnInputsChangedDelegate
FGuid	PreviousScriptVersion	Can be used by the ui after a version change to display change notes
TArray< FNiagar...	PropagatedStaticSwitchParameters	All the input values the function propagates to the next higher caller instead of forcing the user to set them directly.
FString	PythonUpgradeScriptWarnings	Can be used by the ui after a version change to display change notes
FGuid	SelectedScriptVersion
FNiagaraFunctio...	Signature	Some functions can be provided a signature directly rather than a script.
TArray< FNiagar...	StackMessages

Functions

	Name	Description
void	AddCustomNote ( const FNiagaraStackMessage& StackM... )
void	AddMessage ( const FGuid& MessageKey, UNiagaraMessageData* NewMessag... )
void	ChangeScriptVersion ( FGuid NewScriptVersion, const FNiagaraScriptVersionUpgradeC..., bool bShowNotesInStack )
void	CleanupPropagatedSwitchValues()
void	ComputeNodeName ( FString SuggestedName, bool bForceSuggestion )	Resets the node name based on the referenced script or signature.
bool	ContainsDebugSwitch()	Checks to see if this called function contains any debug switches
bool	FindAutoBoundInput ( UNiagaraNodeInput* InputNode, UEdGraphPin* PinToAutoBind, FNiagaraVariable& OutFoundVar, ENiagaraInputNodeUsage& OutNodeUsa... )
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.
FNiagaraProp...	FindPropagatedVariable ( const FNiagaraVariable& Variable )
UEdGraphPin ...	FindStaticSwitchInputPin ( const FName& VariableName )	Attempts to find the input pin for a static switch with the given name in the internal script graph.
void	FixupFunctionScriptVersion()
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
TArray< FGui...	GetBoundPinGuidsByName ( FName InputName )
UNiagaraGrap...	GetCalledGraph()
ENiagaraScri...	GetCalledUsage()
const TArray...	GetCustomNotes()	Custom Notes API.
FString	GetFunctionName()
UNiagaraScri...	GetFunctionScriptSource()
const auto &	GetMessages()	Messages API.
FVersionedNi...	GetScriptData()
bool	GetValidateDataInterfaces()
bool	IsValidPropagatedVariable ( const FNiagaraVariable& Variable )
FSimpleDeleg...	OnCustomNotesChanged()
FOnInputsCha...	OnInputsChanged()
void	RemoveCustomNote ( const FGuid& MessageKey )
void	RemoveCustomNoteViaDelegate ( const FGuid MessageKey )
void	RemoveMessage ( const FGuid& MessageKey )
void	RemoveMessageDelegateable ( const FGuid MessageKey )
void	RemovePropagatedVariable ( const FNiagaraVariable& Variable )
bool	ScriptIsValid()
void	SetPinAutoGeneratedDefaultValue ( UEdGraphPin& FunctionInputPin, UNiagaraNodeInput& FunctionScriptI... )
void	SuggestName ( FString SuggestedName, bool bForceSuggestion )	Tries to rename this function call to a new name.
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.
void	UpdateNodeErrorMessage()
void	UpdatePinTooltips()
void	UpgradeDIFunctionCalls()	Does any automated data manipulated required to update DI function call nodes to the current version.

Overridden from UNiagaraNodeWithDynamicPins

	Name	Description
bool	AllowDynamicPins()
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.
bool	CanRemovePin ( const UEdGraphPin* Pin )	Called to determine if a pin can be removed by the user.
bool	CanRenamePin ( const UEdGraphPin* Pin )	Called to determine if a pin can be renamed by the user.

Overridden from UNiagaraNode

	Name	Description
void	BuildParameterMapHistory ( FNiagaraParameterMapHistoryBuilder ..., bool bRecursive, bool bFilterForCompilation )	Adds the current node information to the parameter map history
bool	CanAddToGraph ( UNiagaraGraph* TargetGraph, FString& OutErrorMsg )	Apply any node-specific logic to determine if it is safe to add this node to the graph.
void	Compile ( FHlslNiagaraTranslator* Transl..., TArray< int32 >& Outputs )
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.
ENiagaraNume...	GetNumericOutputTypeSelectionMode()	Gets which mode to use when deducing the type of numeric output pins from the types of the input pins.
UObject *...	GetReferencedAsset()	Gets the asset referenced by this node, or nullptr if there isn't one.
bool	RefreshFromExternalChanges()	Refreshes the node due to external changes, e.g. the underlying function changed for a function call node.
void	UpdateCompileHashForNode ( FSHA1& HashState )	Old style compile hash code. To be removed in the future.

Overridden from UEdGraphNode

	Name	Description
void	AllocateDefaultPins()	Allocate default pins for a given node, based only the NodeType, which should already be filled in.
void	AutowireNewNode ( UEdGraphPin* FromPin )	Autowire a newly created node.
TSharedPtr< ...	CreateVisualWidget()	Create a visual widget to represent this node in a graph editor or graph panel.
FText	GetNodeTitle ( ENodeTitleType::Type TitleType )	Gets the name of this node, shown in title bar
FLinearColor	GetNodeTitleColor()	Gets the draw color of a node's title bar
FText	GetTooltipText()	Gets the tooltip to display when over the node
bool	IsDeprecated()	Returns true if this node is deprecated

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name	Description
FOnInputsChanged