1. Epic GamesDeveloper
  3. UNiagaraGraph

UNiagaraGraph

API > API/Plugins > API/Plugins/NiagaraEditor

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;MinimalAPI&41;  
class UNiagaraGraph : public UEdGraph

Variables

  Type Name Description
Protected variable bool bNeedNumericCacheRebuilt  
Protected variable TMap< TPair< FGuid, UEdGraphNode * >, FNiagaraTypeDefinition > CachedNumericConversions  

Constructors

  Type Name Description
Public function  

UNiagaraGraph ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function FDelegateHandle

AddOnGraphNeedsRecompileHandler ( const FOnGraphChanged::FDelegate& InHandler
)

 Add a listener for OnGraphNeedsRecompile events
Public function UNiagaraScriptVariable *

AddParameter ( const FNiagaraVariable& Parameter,
const FNiagaraVariableMetaData& ParameterMetaData,
bool bIsStaticSwitch,
bool bNotifyChanged
)

 Adds parameter to the VariableToScriptVariable map.
Public function UNiagaraScriptVariable *

AddParameter ( const FNiagaraVariable& Parameter,
bool bIsStaticSwitch
)

 Adds parameter to the VariableToScriptVariable map.
Public function UNiagaraScriptVariable *

AddParameter ( const UNiagaraScriptVariable* InScriptVar
)

 Adds parameter to the VariableToScriptVariable map.
Public function void

AddParameterReference ( const FNiagaraVariable& Parameter,
FNiagaraGraphParameterReference& NewParameterReference
)

 Adds an FNiagaraGraphParameterReference to the ParameterToReferenceMap.
Protected function Const bool

AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor,
const TArray< UNiagaraNode* >& InTraversal
)

  
Public function Static void

BuildTraversal ( TArray< class UNiagaraNode* >& OutNodesTraversed,
UNiagaraNode* FinalNode,
bool bEvaluateStaticSwitches
)

 Get an in-order traversal of a graph by the specified target output script usage.
Public function Const void

BuildTraversal ( TArray< class UNiagaraNode* >& OutNodesTraversed,
ENiagaraScriptUsage TargetUsage,
FGuid TargetUsageId,
bool bEvaluateStaticSwitches
)

 Get an in-order traversal of a graph by the specified target output script usage.
Public function void

ChangeParameterType ( const TArray< FNiagaraVariable >& ParametersToChange,
const FNiagaraTypeDefinition& NewType,
bool bAllowOrphanedPins
)

 Changes the type of existing graph parameters.
Public function Const const TMap< FNiagaraVariable, FInputPinsAndOutputPins > Helper to get a map of variables to all input/output pins with the same name.
Public function void In order to support reducing the number of times we need to fully generate the CompileId this function is introduced to work with LastBuiltScriptVersionId & bHasValidLastBuiltScriptVersionId.
Public function void Rebuilds the internally stored ParameterRefrenceMap if it has been marked dirty.
Public function void  
Public function UNiagaraGraph *

CreateCompilationCopy ( const TArray< ENiagaraScriptUsage >& CompileUsages
)

 Creates a transient copy of this graph for compilation purposes.
Protected function UNiagaraScriptVariable *

CreateScriptVariableInternal ( const FNiagaraVariable& Parameter,
const FNiagaraVariableMetaData& ParameterMetaData,
bool bIsStaticSwitch
)

  
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function Const UNiagaraNodeOutput *

FindEquivalentOutputNode ( ENiagaraScriptUsage TargetUsageType,
FGuid TargetUsageId
)

 Implements a globally unique identifier.
Public function Const void  
Public function Const void

FindInputNodes ( TArray< class UNiagaraNodeInput* >& OutInputNodes,
FFindInputNodeOptions Options
)

 Finds input nodes in the graph with.
Public function Const UNiagaraNodeOutput *

FindOutputNode ( ENiagaraScriptUsage TargetUsageType,
FGuid TargetUsageId
)

 Find the first output node bound to the target usage type.
Public function Const void

FindOutputNodes ( ENiagaraScriptUsage TargetUsageType,
TArray< UNiagaraNodeOutput* >& OutputNodes
)

 Find all output nodes.
Public function Const void Find all output nodes.
Public function Const 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.
Public function Const TArray< UEdGraphPin * >

FindParameterMapDefaultValuePins ( const FName VariableName
)

 Find all matching default pins for VariableName, irrespective of usage.
Public function Const TArray< FNiagaraVariable >

FindStaticSwitchInputs ( bool bReachableOnly,
const TArray< FNiagaraVariable >& InStaticVars
)

 Returns a list of variable inputs for all static switch nodes in the graph.
Public function void

ForceBaseId ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId,
const FGuid InForcedBaseId
)

 Forces the base compile id for the supplied script.
Public function void  
Public function void

GatherExternalDependencyData ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId,
TArray< FNiagaraCompileHash >& InReferencedCompileHashes,
TArray< FString >& InReferencedObjs
)

 Gather all the change ids of external references for this specific graph traversal.
Public function Const const FScriptVariableMap &  
Public function FScriptVariableMap &  
Public function Const void Get all referenced graphs in this specified graph, including this graph.
Public function Const void

GetAllScriptVariableGuids ( TArray< FGuid >& VariableGuids
)

  
Public function Const void  
Public function Const FGuid

GetBaseId ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId
)

 Gets the current base id associated with the output node traversal specified by InUsage and InUsageId.
Public function FNiagaraTypeDefinition  
Public function Const FGuid Each graph is given a Change Id that occurs anytime the graph's content is manipulated.
Public function Const TArray< FGuid >  
Public function Const TArray< UNiagaraScriptVariable * >  
Public function Const FNiagaraCompileHash

GetCompileDataHash ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId
)

 Gets the current compile data hash associated with the output node traversal specified by InUsage and InUsageId.
Public function Const FNiagaraCompileHash Gets the current reference data hash associated with the output node traversal specified by InUsage and InUsageId (Static variables & switches).
Public function Const TOptional< ENiagaraDefaultMode >  
Public function Const FString 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.
Public function Const TOptional< FNiagaraVariableMetaData >

GetMetaData ( const FNiagaraVariable& InVar
)

 Gets the meta-data associated with this variable, if it exists.
Public function Const const UEdGraphSchema_Niagara *  
Public function Const int32 Returns the index of this variable in the output node of the graph.
Public function Const void  
Public function Const void

GetOutputNodeVariables ( ENiagaraScriptUsage InTargetScriptUsage,
TArray< FNiagaraVariable >& OutAttributes
)

  
Public function Const FVersionedNiagaraEmitter  
Public function Const const TMap< FNiagaraVariable, FNiagaraGraphParameterReferenceCollection > &  
Public function Const void Generates a list of unique input and output parameters for when this script is used as a function.
Public function Const bool

GetPropertyMetadata ( FName PropertyName,
FString& OutValue
)

  
Public function Const UNiagaraScriptVariable *  
Public function Const UNiagaraScriptVariable *

GetScriptVariable ( FGuid VariableGuid
)

  
Public function Const UNiagaraScriptVariable *

GetScriptVariable ( FName ParameterName
)

  
Public function Const TOptional< FGuid >  
Public function Const UNiagaraScriptSource * Get the source that owns this graph
Public function Const TOptional< int32 >  
Public function Const TOptional< FNiagaraVariable >

GetVariable ( const FNiagaraVariable& Variable
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool

HasVariable ( const FNiagaraVariable& Variable
)

  
Public function void  
Public function Const bool Returns if this graph is for compilation purposes only.
Public function Const bool

IsEmpty ()

 Determine if there are any nodes in this graph.
Public function Const bool

IsOtherSynchronized ( const FGuid& InChangeId
)

 Determine if another item has been synchronized with this graph.
Public function Const bool  
Public function Const TOptional< bool >

IsStaticSwitch ( const FNiagaraVariable& Variable
)

  
Public function FName

MakeUniqueParameterName ( const FName& InName
)

 Go through all known parameter names in this graph and generate a new unique one.
Public function Static FName  
Public function void Identify that this graph has undergone changes that will require synchronization with a compiled script.
Public function Const void

MultiFindParameterMapDefaultValuePins ( TConstArrayView< FName > VariableNames,
ENiagaraScriptUsage InUsage,
ENiagaraScriptUsage InParentUsage,
TArrayView< UEdGraphPin* > DefaultPins
)

 Walk through the graph for an ParameterMapGet nodes and see if any of them specify a default for VariableName.
Public function void Notifies the graph that a contained data interface has changed.
Public function void Signal to listeners that the graph has changed
Public function FOnDataInterfaceChanged & Gets a delegate which is called whenever a contained data interfaces changes.
Public function FOnSubObjectSelectionChanged & Gets a delegate which is called whenever a custom subobject in the graph is selected
Public function void  
Protected function void  
Public function Const bool  
Public function void  
Public function void Remove a listener for OnGraphNeedsRecompile events
Public function void

RemoveParameter ( const FNiagaraVariable& Parameter,
bool bAllowDeleteStaticSwitch
)

 Remove parameter from map and all the pins associated.
Public function void

RenameAssignmentAndSetNodePins ( const FName OldName,
const FName NewName
)

 Rename all assignment and map set node pins.
Public function bool

RenameParameter ( const FNiagaraVariable& Parameter,
FName NewName,
bool bRenameRequestedFromStaticSwitch,
bool* bMerged,
bool bSuppressEvents
)

 Rename parameter from map and all the pins associated.
Public function bool

RenameParameterFromPin ( const FNiagaraVariable& Parameter,
FName NewName,
UEdGraphPin* InPin
)

 Rename a pin inline in a graph.
Public function bool

RenameStaticSwitch ( UNiagaraNodeStaticSwitch* SwitchNode,
FName NewName
)

  
Public function void  
Protected function void

ResolveNumerics ( TMap< UNiagaraNode*, bool >& VisitedNodes,
UEdGraphNode* Node
)

  
Public function void  
Public function void

SetIsStaticSwitch ( const FNiagaraVariable& Variable,
bool InValue
)

  
Public function void

SetMetaData ( const FNiagaraVariable& InVar,
const FNiagaraVariableMetaData& MetaData
)

 Sets the meta-data associated with this variable.
Public function Static FName

StandardizeName ( FName Name,
ENiagaraScriptUsage Usage,
bool bIsGet,
bool bIsSet
)

  
Public function bool Find a script variable with the same key as RemovedScriptVarId and unmark it as being sourced from a parameter definitions.
Public function void 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.
Public function bool

SynchronizeScriptVariable ( const UNiagaraScriptVariable* SourceScriptVar,
UNiagaraScriptVariable* DestScriptVar,
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

  Type Name Description
Public function Virtual void A change was made to the graph that external parties should take note of.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name Description
FFindInputNodeOptions  
FOnDataInterfaceChanged  
FOnGetParameterDefinitionsForDetailsCustomization  
FOnSubObjectSelectionChanged  
FScriptVariableMap These functions are not supported for compilation copies.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page