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 > UNiagaraNode

Light Theme

Dark Theme

UNiagaraNode

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEdGraphNode

UNiagaraNode

UNiagaraNodeDataSetBase

	UNiagaraNodeReadDataSet
	UNiagaraNodeWriteDataSet

UNiagaraNodeInput

UNiagaraNodeOutput

UNiagaraNodeWithDynamicPins

UNiagaraNodeFunctionCall

	UNiagaraNodeAssignment
	UNiagaraNodeCustomHlsl

UNiagaraNodeOp

References

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

Syntax

UCLASS()
class UNiagaraNode : public UEdGraphNode

Variables

	Name	Description
FGuid	ChangeId	The current change identifier for this node. Used to sync status with UNiagaraScripts.
TArray< FGuid >	PinsGuidsWithRenamePending
FOnNodeVisualsC...	VisualsChangedDelegate

Constructors

	Name	Description
	UNiagaraNode ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddWidgetsToInputBox ( TSharedPtr< SVerticalBox > InputBox )	Virtual function to allow for custom widgets in the input or output box
void	AddWidgetsToOutputBox ( TSharedPtr< SVerticalBox > OutputBo... )
bool	AllowExternalPinTypeChanges ( const UEdGraphPin* InGraphPin )	Determine whether we are allowed to change a pin's type from UI.
bool	AllowNiagaraTypeForPinTypeChange ( const FNiagaraTypeDefinition& InTy..., UEdGraphPin* Pin )	Determine whether or not a pin can be changed to a certain type.
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* In... )	Entry point for generating the compile hash.
void	AppendFunctionAliasForContext ( const FNiagaraGraphFunctionAliasCon..., FString& InOutFunctionAlias, bool& OutOnlyOncePerNodeType )
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.
bool	CancelEditablePinName ( const FText& InName, UEdGraphPin* InGraphPinObj )	Notify the rename was cancelled.
bool	CommitEditablePinName ( const FText& InName, UEdGraphPin* InGraphPinObj, bool bSuppressEvents )	Verify that the potential rename has produced acceptable results for a pin.
void	Compile ( FHlslNiagaraTranslator* Transl..., TArray< int32 >& Outputs )
int32	CompileInputPin ( FHlslNiagaraTranslator* Transl..., UEdGraphPin* Pin )
bool	CompileInputPins ( FHlslNiagaraTranslator* Transl..., TArray< int32 >& OutCompiledInputs )
bool	ConvertNumericPinToType ( UEdGraphPin* InGraphPin, FNiagaraTypeDefinition TypeDef )	Convert the type of an existing numeric pin to a more known type.
void	ForceChangeId ( const FGuid& InId, bool bRaiseGraphNeedsRecompile )	Set the change id for his node to an explicit value. This should only be called by internal code.
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.
bool	GenerateCompileHashForClassMembers ( const UClass* InClass, FNiagaraCompileHashVisitor* In... )	Go through all class members for a given UClass on this object and hash them into the visitor.
const FGuid ...	GetChangeId()	Get the change id for this node.
UEdGraphPin ...	GetInputPin ( int32 InputIndex )
void	GetInputPins ( ContainerType& OutInputPins )
void	GetInputPinsInternal ( ContainerType& OutInputPins )
bool	GetIsPinRenamePending ( const UEdGraphPin* Pin )	Returns whether or not the supplied pin has a rename pending.
UNiagaraGrap...	GetNiagaraGraph()	Get the Niagara graph that owns this node
const UNiaga...	GetNiagaraGraph()	Get the Niagara graph that owns this node
ENiagaraNume...	GetNumericOutputTypeSelectionMode()	Gets which mode to use when deducing the type of numeric output pins from the types of the input pins.
UEdGraphPin ...	GetOutputPin ( int32 OutputIndex )
void	GetOutputPins ( ContainerType& OutOutputPins )
void	GetOutputPinsInternal ( ContainerType& OutOutputPins )
UEdGraphPin ...	GetPassThroughPin ( const UEdGraphPin* LocallyOwne..., ENiagaraScriptUsage MasterUsage )
UEdGraphPin ...	GetPinByPersistentGuid ( const FGuid& InGuid )
UObject *...	GetReferencedAsset()	Gets the asset referenced by this node, or nullptr if there isn't one.
UNiagaraScri...	GetSource()	Get the source object
bool	GetTooltipTextForKnownPin ( const UEdGraphPin& Pin, FText& OutTooltip )	If the pin is a known name (like Engine.DeltaTime) this tries to return a default tooltip for it.
UEdGraphPin ...	GetTracedOutputPin ( UEdGraphPin* LocallyOwnedOutpu..., bool bFilterForCompilation, TArray< const UNiagaraNode* > ... )	Traces one of this node's output pins to its source output pin.
void	GetWildcardPinHoverConnectionTextAddition ( const UEdGraphPin* WildcardPin, const UEdGraphPin* OtherPin, ECanCreateConnectionResponse Connec..., FString& OutString )
bool	IsParameterMapPin ( const UEdGraphPin* Pin )
bool	IsPinNameEditable ( const UEdGraphPin* GraphPinObj )	Determine whether or not a pin should be renamable.
bool	IsPinNameEditableUponCreation ( const UEdGraphPin* GraphPinObj )	Determine whether or not a specific pin should immediately be opened for rename.
bool	IsValidPinToCompile ( UEdGraphPin* Pin )
void	MarkNodeRequiresSynchronization ( FString Reason, bool bRaiseGraphNeedsRecompile )	Identify that this node has undergone changes that will require synchronization with a compiled script.
bool	NestedPropertiesAppendCompileHash ( const void* Container, const UStruct* Struct, EFieldIteratorFlags::SuperClassFlag..., const FString& BaseName, FNiagaraCompileHashVisitor* In... )	Helper function to hash arbitrary UProperty entries (Arrays, Maps, Structs, etc).
bool	NiagaraNodeAppendCompileHash ( FNiagaraCompileHashVisitor* In... )	Write out the specific entries for UNiagaraNode into the visitor hash.
void	NumericResolutionByPins ( const UEdGraphSchema_Niagara* ..., TArrayView< UEdGraphPinconst ..., TArrayView< UEdGraphPinconst ..., bool bFixInline, TMap< TPair< FGuid, UEdGraphNode&#... )
bool	OnNewPinTypeRequested ( UEdGraphPin* PinToChange, FNiagaraTypeDefinition NewType )	Pin type changes are handled by the individual subclasses to account for pin sets (like the if node or select node)
void	OnPostSynchronizationInReallocatePins()
FOnNodeVisua...	OnVisualsChanged()
bool	PinAppendCompileHash ( const UEdGraphPin* InPin, FNiagaraCompileHashVisitor* In... )	Write out the specific entries of this pin to the visitor hash.
bool	PODPropertyAppendCompileHash ( const void* Container, FProperty* Property, const FString& PropertyName, FNiagaraCompileHashVisitor* In... )	For a simple Plain old data type UProperty, hash the data.
bool	ReallocatePins ( bool bMarkNeedsResynchronizeOnChang... )
bool	RefreshFromExternalChanges()	Refreshes the node due to external changes, e.g. the underlying function changed for a function call node.
void	RegisterPassthroughPin ( FNiagaraParameterMapHistoryBuilder ..., UEdGraphPin* InputPin, UEdGraphPin* OutputPin, bool bFilterForCompilation, bool bVisitInputPin )	Basically routes the pin through the parameter map builder so that it looks like a regular pin.
void	RequestNewPinType ( UEdGraphPin* PinToChange, FNiagaraTypeDefinition NewType )	Request a pin type change to a specific type.
void	ResolveNumerics ( const UEdGraphSchema_Niagara* ..., bool bSetInline, TMap< TPair< FGuid, UEdGraphNode&#... )
void	RouteParameterMapAroundMe ( FNiagaraParameterMapHistoryBuilder ..., bool bRecursive )	Route input parameter map to output parameter map if it exists.
void	SetIsPinRenamePending ( const UEdGraphPin* Pin, bool bInIsRenamePending )	Sets whether or not the supplied pin has a rename pending.
bool	SetPinDefaultToTypeDefaultIfUnset ( UEdGraphPin* InPin )
bool	SubstituteCompiledPin ( FHlslNiagaraTranslator* Transl..., UEdGraphPin** LocallyOwned... )	Allows a node to replace a pin that is about to be compiled with another pin.
UEdGraphPin ...	TraceOutputPin ( UEdGraphPin* LocallyOwnedOutpu..., bool bFilterForCompilation, TArray< const UNiagaraNode* > ... )	Traces a node's output pins to its source output pin.
void	UpdateCompileHashForNode ( FSHA1& HashState )	Old style compile hash code. To be removed in the future.
bool	VerifyEditablePinName ( const FText& InName, FText& OutErrorMessage, const UEdGraphPin* InGraphPinO... )	Verify that the potential rename has produced acceptable results for a pin.

Overridden from UEdGraphNode

	Name	Description
void	AutowireNewNode ( UEdGraphPin* FromPin )	Autowire a newly created node.
bool	CanCreateUnderSpecifiedSchema ( const UEdGraphSchema* Schema )	Determine if this node can be created under the specified schema
TSharedPtr< ...	CreateVisualWidget()	Create a visual widget to represent this node in a graph editor or graph panel.
void	GatherForLocalization ( FPropertyLocalizationDataGatherer&..., const EPropertyLocalizationGatherer... )
void	GetNodeContextMenuActions ( UToolMenu* Menu, UGraphNodeContextMenuContext* ... )	Gets a list of actions that can be done to this particular node
UEdGraphPin ...	GetPassThroughPin ( const UEdGraphPin* FromPin )	Return the matching "pass-through" pin for the given pin (if supported by this node)
void	GetPinHoverText ( const UEdGraphPin& Pin, FString& HoverTextOut )	Fetch the hover text for a pin when the graph is being edited.
void	NodeConnectionListChanged()	Called when something external to this node has changed the connection list of any of the pins in the node
void	OnPinRemoved ( UEdGraphPin* InRemovedPin )	Called when a pin is removed
void	OnRenameNode ( const FString& NewName )	Called when this node is being renamed after a successful name validation
void	PinConnectionListChanged ( UEdGraphPin* Pin )	Called when the connection list of one of the pins of this node is changed in the editor
void	PinDefaultValueChanged ( UEdGraphPin* Pin )	Called when the DefaultValue of one of the pins of this node is changed in the editor
void	PinTypeChanged ( UEdGraphPin* Pin )	Called when one of the pins of this node has had its' pin type changed from an external source (like the SPinTypeSelector in the case of kismet)
void	PostPlacedNewNode()	A chance to initialize a new node; called just once when a new node is created, before AutowireNewNode or AllocateDefaultPins is called.

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name	Description
FOnNodeVisualsChanged