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

Light Theme

Dark Theme

UNiagaraGraph

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEdGraph

UNiagaraGraph

References

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

Syntax

UCLASS(MinimalAPI)
class UNiagaraGraph : public UEdGraph

Variables

		Name	Description
	bool	bNeedNumericCacheRebuilt
	TMap< TPair< FG...	CachedNumericConversions

Constructors

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

Functions

	Name	Description
FDelegateHan...	AddOnGraphNeedsRecompileHandler ( const FOnGraphChanged::FDelegate& ... )	Add a listener for OnGraphNeedsRecompile events
UNiagaraScri...	AddParameter ( const FNiagaraVariable& Parameter, const FNiagaraVariableMetaData& Pa..., bool bIsStaticSwitch, bool bNotifyChanged )	Adds parameter to the VariableToScriptVariable map.
UNiagaraScri...	AddParameter ( const FNiagaraVariable& Parameter, bool bIsStaticSwitch )	Adds parameter to the VariableToScriptVariable map.
UNiagaraScri...	AddParameter ( const UNiagaraScriptVariable* ... )	Adds parameter to the VariableToScriptVariable map.
void	AddParameterReference ( const FNiagaraVariable& Parameter, FNiagaraGraphParameterReference& N... )	Adds an FNiagaraGraphParameterReference to the ParameterToReferenceMap.
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* In..., const TArray< UNiagaraNode* > ... )
void	BuildTraversal ( TArray< class UNiagaraNode* > ..., UNiagaraNode* FinalNode, bool bEvaluateStaticSwitches )	Get an in-order traversal of a graph by the specified target output script usage.
void	BuildTraversal ( TArray< class UNiagaraNode* > ..., ENiagaraScriptUsage TargetUsage, FGuid TargetUsageId, bool bEvaluateStaticSwitches )	Get an in-order traversal of a graph by the specified target output script usage.
const TMap< ...	CollectVarsToInOutPinsMap()	Helper to get a map of variables to all input/output pins with the same name.
void	CopyCachedReferencesMap ( UNiagaraGraph* TargetGraph )
UNiagaraGrap...	CreateCompilationCopy ( const TArray< ENiagaraScriptUsage >... )	Creates a transient copy of this graph for compilation purposes.
UNiagaraNode...	FindEquivalentOutputNode ( ENiagaraScriptUsage TargetUsageType, FGuid TargetUsageId )	Implements a globally unique identifier.
void	FindEquivalentOutputNodes ( ENiagaraScriptUsage TargetUsageType, TArray< UNiagaraNodeOutput* > ... )
void	FindInputNodes ( TArray< class UNiagaraNodeInput..., FFindInputNodeOptions Options )	Finds input nodes in the graph with.
UNiagaraNode...	FindOutputNode ( ENiagaraScriptUsage TargetUsageType, FGuid TargetUsageId )	Find the first output node bound to the target usage type.
void	FindOutputNodes ( ENiagaraScriptUsage TargetUsageType, TArray< UNiagaraNodeOutput* > ... )	Find all output nodes.
void	FindOutputNodes ( TArray< UNiagaraNodeOutput* > ... )	Find all output nodes.
UEdGraphPin ...	FindParameterMapDefaultValuePin ( const FName VariableName, ENiagaraScriptUsage InUsage, ENiagaraScriptUsage InParentUsage )	Walk through the graph for an ParameterMapGet nodes and see if any of them specify a default for VariableName.
TArray< UEdG...	FindParameterMapDefaultValuePins ( const FName VariableName )	Walk through the graph for an ParameterMapGet nodes and find all matching default pins for VariableName, irrespective of usage.
TArray< FNia...	FindStaticSwitchInputs ( bool bReachableOnly )	Returns a list of variable inputs for all static switch nodes in the graph.
void	ForceBaseId ( ENiagaraScriptUsage InUsage, const FGuid& InUsageId, const FGuid InForcedBaseId )	Forces the base compile id for the supplied script.
void	ForceGraphToRecompileOnNextCheck()
void	GatherExternalDependencyData ( ENiagaraScriptUsage InUsage, const FGuid& InUsageId, TArray< FNiagaraCompileHash >& InR..., TArray< FString >& InReferencedObj... )	Gather all the change ids of external references for this specific graph traversal.
TMap< FNiaga...	GetAllMetaData()
const TMap< ...	GetAllMetaData()
void	GetAllReferencedGraphs ( TArray< const UNiagaraGraph* >... )	Get all referenced graphs in this specified graph, including this graph.
FGuid	GetBaseId ( ENiagaraScriptUsage InUsage, const FGuid& InUsageId )	Gets the current base id associated with the output node traversal specified by InUsage and InUsageId.
FNiagaraType...	GetCachedNumericConversion ( UEdGraphPin* InPin )
FGuid	GetChangeID()	Each graph is given a Change Id that occurs anytime the graph's content is manipulated.
FNiagaraComp...	GetCompileDataHash ( ENiagaraScriptUsage InUsage, const FGuid& InUsageId )	Gets the current compile data hash associated with the output node traversal specified by InUsage and InUsageId.
FString	GetFunctionAliasByContext ( const FNiagaraGraphFunctionAliasCon... )	If this graph is the source of a function call, it can add a string to the function name to discern it from different function calls to the same graph.
TOptional< F...	GetMetaData ( const FNiagaraVariable& InVar )	Gets the meta-data associated with this variable, if it exists.
const UEdGra...	GetNiagaraSchema()
int32	GetOutputNodeVariableIndex ( const FNiagaraVariable& Attr )	Returns the index of this variable in the output node of the graph.
void	GetOutputNodeVariables ( ENiagaraScriptUsage InTargetScriptU..., TArray< FNiagaraVariable >& OutAtt... )
void	GetOutputNodeVariables ( TArray< FNiagaraVariable >& OutAtt... )
const TMap< ...	GetParameterReferenceMap()
void	GetParameters ( TArray< FNiagaraVariable >& Inputs, TArray< FNiagaraVariable >& Output... )	Generates a list of unique input and output parameters for when this script is used as a function.
bool	GetPropertyMetadata ( FName PropertyName, FString& OutValue )
UNiagaraScri...	GetScriptVariable ( FName ParameterName, bool bUpdateIfPending )
UNiagaraScri...	GetScriptVariable ( FNiagaraVariable Parameter, bool bUpdateIfPending )
UNiagaraScri...	GetSource()	Get the source that owns this graph
bool	HasNumericParameters()
bool	HasParameterMapParameters()
void	InvalidateNumericCache()
bool	IsEmpty()	Determine if there are any nodes in this graph.
bool	IsOtherSynchronized ( const FGuid& InChangeId )	Determine if another item has been synchronized with this graph.
bool	IsPinVisualWidgetProviderRegistered()
FName	MakeUniqueParameterName ( const FName& InName )	Go through all known parameter names in this graph and generate a new unique one.
FName	MakeUniqueParameterNameAcrossGraphs ( const FName& InName, TArray< TWeakObjectPtr< UNiagaraGra... )
void	MarkGraphRequiresSynchronization ( FString Reason )	Identify that this graph has undergone changes that will require synchronization with a compiled script.
void	NotifyGraphDataInterfaceChanged()	Notifies the graph that a contained data interface has changed.
void	NotifyGraphNeedsRecompile()	Signal to listeners that the graph has changed
FOnDataInter...	OnDataInterfaceChanged()	Gets a delegate which is called whenever a contained data interfaces changes.
FOnSubObject...	OnSubObjectSelectionChanged()	Gets a delegate which is called whenever a custom subobject in the graph is selected
void	RebuildCachedCompileIds ( bool bForce )
void	RebuildNumericCache()
void	ReleaseCompilationCopy()
void	RemoveOnGraphNeedsRecompileHandler ( FDelegateHandle Handle )	Remove a listener for OnGraphNeedsRecompile events
void	RemoveParameter ( const FNiagaraVariable& Parameter, bool bAllowDeleteStaticSwitch )	Remove parameter from map and all the pins associated.
void	RenameAssignmentAndSetNodePins ( const FName OldName, const FName NewName )	Rename all assignment and map set node pins.
bool	RenameParameter ( const FNiagaraVariable& Parameter, FName NewName, bool bRenameRequestedFromStaticSwit..., bool* bMerged, bool bSuppressEvents )	Rename parameter from map and all the pins associated.
bool	RenameParameterFromPin ( const FNiagaraVariable& Parameter, FName NewName, UEdGraphPin* InPin )	Rename a pin inline in a graph.
void	ResolveNumerics ( TMap< UNiagaraNode, bool >& ..., UEdGraphNode Node )
void	ScriptVariableChanged ( FNiagaraVariable Variable )
void	SetMetaData ( const FNiagaraVariable& InVar, const FNiagaraVariableMetaData& Me... )	Sets the meta-data associated with this variable.
FName	StandardizeName ( FName Name, ENiagaraScriptUsage Usage, bool bIsGet, bool bIsSet )
bool	SynchronizeParameterDefinitionsScriptVariableRemoved ( const FGuid RemovedScriptVarId )	Find a script variable with the same key as RemovedScriptVarId and unmark it as being sourced from a parameter definitions.
void	SynchronizeParametersWithParameterDefinitions ( const TArray< UNiagaraParameterDefi..., const TArray< UNiagaraParameterDefi..., const TSet< FGuid >& AllDefinition..., INiagaraParameterDefinitionsSubscri..., FSynchronizeWithParameterDefinition... )	Synchronize all source script variables that have been changed or removed from the parameter definitions to all eligible destination script variables owned by the graph.
bool	SynchronizeScriptVariable ( const UNiagaraScriptVariable* ..., UNiagaraScriptVariable* DestSc..., bool bIgnoreChangeId )	Synchronize all the properties of DestScriptVar to those of SourceScriptVar, as well as propagating those changes through the graph (pin variable names and default values on pins.) If DestScriptVar is not set, find a script variable with the same key as the SourceScriptVar.

Overridden from UEdGraph

		Name	Description
	void	NotifyGraphChanged()	A change was made to the graph that external parties should take

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
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.

Classes

	Name	Description
	FFindInputNodeOptions	Options for the FindInputNodes function

Typedefs

Name	Description
FOnDataInterfaceChanged
FOnGetParameterDefinitionsForDetailsCustomization
FOnSubObjectSelectionChanged