UNiagaraGraph

Windows
MacOS
Linux

Inheritance Hierarchy

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

Protected variable

bool

 

bNeedNumericCacheRebuilt

Protected variable

TMap < TPair < FG ...

 

CachedNumericConversions

Constructors

Name Description

Public function

UNiagaraGraph

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function

FDelegateHan ...

 

AddOnGraphNeedsRecompileHandler

(
    const FOnGraphChanged::FDelegate& ...
)

Add a listener for OnGraphNeedsRecompile events

Public function

UNiagaraScri...

 

AddParameter

(
    FNiagaraVariable & Parameter,
    const FAddParameterOptions Options
)

Public function

UNiagaraScri...

 

AddParameter

(
    const FNiagaraVariable & Parameter,
    bool bIsStaticSwitch
)

Adds parameter to parameters map setting it as created by the user.

Public function

void

 

AddParameterReference

(
    const FNiagaraVariable & Parameter,
    FNiagaraGraphParameterReference & N...
)

Adds an FNiagaraGraphParameterReference to the ParameterToReferenceMap.

Protected function Const

bool

 

AppendCompileHash

(
    FNiagaraCompileHashVisitor * In...,
    const TArray < UNiagaraNode * > ...
)

Public function Static

void

 

BuildTraversal

(
    TArray < class UNiagaraNode * > ...,
    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 * > ...,
    ENiagaraScriptUsage TargetUsage,
    FGuid TargetUsageId,
    bool bEvaluateStaticSwitches
)

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

Public function

void

 

CopyCachedReferencesMap

(
    UNiagaraGraph * TargetGraph
)

Public function Const

UNiagaraNode ...

 

FindEquivalentOutputNode

(
    ENiagaraScriptUsage TargetUsageType,
    FGuid TargetUsageId
)

Implements a globally unique identifier.

Public function Const

void

 

FindEquivalentOutputNodes

(
    ENiagaraScriptUsage TargetUsageType,
    TArray < UNiagaraNodeOutput * > ...
)

Public function Const

void

 

FindInputNodes

(
    TArray < class UNiagaraNodeInput ...,
    FFindInputNodeOptions Options
)

Finds input nodes in the graph with.

Public function Const

UNiagaraNode ...

 

FindOutputNode

(
    ENiagaraScriptUsage TargetUsageType,
    FGuid TargetUsageId
)

Find the first output node bound to the target usage type.

Public function Const

void

 

FindOutputNodes

(
    TArray < UNiagaraNodeOutput * > ...
)

Find all output nodes.

Public function Const

void

 

FindOutputNodes

(
    ENiagaraScriptUsage TargetUsageType,
    TArray < UNiagaraNodeOutput * > ...
)

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 < UEdG ...

 

FindParameterMapDefaultValuePins

(
    const FName VariableName
)

Walk through the graph for an ParameterMapGet nodes and find all matching default pins for VariableName, irrespective of usage.

Public function Const

TArray < FNia ...

 

FindStaticSwitchInputs

(
    bool bReachableOnly
)

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

 

ForceGraphToRecompileOnNextCheck()

Public function

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.

Public function

TMap < FNiaga ...

 

GetAllMetaData()

Public function Const

const TMap < ...

 

GetAllMetaData()

Public function Const

void

 

GetAllReferencedGraphs

(
    TArray < const UNiagaraGraph * >...
)

Get all referenced graphs in this specified graph, including this graph.

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

FNiagaraType ...

 

GetCachedNumericConversion

(
    UEdGraphPin * InPin
)

Public function

FGuid

 

GetChangeID()

Each graph is given a Change Id that occurs anytime the graph's content is manipulated.

Public function Const

FNiagaraComp ...

 

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

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.

Public function Const

TOptional < F ...

 

GetMetaData

(
    const FNiagaraVariable & InVar
)

Gets the meta-data associated with this variable, if it exists.

Public function Const

const UEdGra ...

 

GetNiagaraSchema()

Public function Const

int32

 

GetOutputNodeVariableIndex

(
    const FNiagaraVariable & Attr
)

Returns the index of this variable in the output node of the graph.

Public function Const

void

 

GetOutputNodeVariables

(
    TArray < FNiagaraVariable >& OutAtt...
)

Public function Const

void

 

GetOutputNodeVariables

(
    ENiagaraScriptUsage InTargetScriptU...,
    TArray < FNiagaraVariable >& OutAtt...
)

Public function Const

const TMap < ...

 

GetParameterReferenceMap()

Public function Const

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.

Public function Const

TSharedRef < ...

 

GetPinVisualWidget

(
    const UEdGraphPin * Pin
)

Wrapper to provide visual widgets for pins that are managed by external viewmodels.

Public function Const

UNiagaraScri...

 

GetScriptVariable

(
    FName ParameterName
)

Public function Const

UNiagaraScri...

 

GetScriptVariable

(
    FNiagaraVariable Parameter
)

Public function Const

UNiagaraScri ...

 

GetSource()

Get the source that owns this graph

Public function Const

bool

 

HasNumericParameters()

Public function Const

bool

 

HasParameterMapParameters()

Public function

void

 

InvalidateNumericCache()

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

 

IsPinVisualWidgetProviderRegistered()

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

 

MakeUniqueParameterNameAcrossGraphs

(
    const FName & InName,
    TArray < TWeakObjectPtr < UNiagaraGra ...
)

Public function

void

 

MarkGraphRequiresSynchronization

(
    FString Reason
)

Identify that this graph has undergone changes that will require synchronization with a compiled script.

Public function

void

 

NotifyGraphDataInterfaceChanged()

Notifies the graph that a contained data interface has changed.

Public function

void

 

NotifyGraphNeedsRecompile()

Signal to listeners that the graph has changed

Public function

FOnDataInter ...

 

OnDataInterfaceChanged()

Gets a delegate which is called whenever a contained data interfaces changes.

Public function

FOnSubObject ...

 

OnSubObjectSelectionChanged()

Gets a delegate which is called whenever a custom subobject in the graph is selected

Public function

void

 

RebuildCachedCompileIds

(
    bool bForce
)

Protected function

void

 

RebuildNumericCache()

Public function

FDelegateHan ...

 

RegisterPinVisualWidgetProvider

(
    FOnGetPinVisualWidget OnGetPinVisua...
)

Public function

void

 

RemoveOnGraphNeedsRecompileHandler

(
    FDelegateHandle Handle
)

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

bool

 

RenameParameter

(
    const FNiagaraVariable & Parameter,
    FName NewName,
    bool bRenameRequestedFromStaticSwit...,
    FName NewScopeName,
    bool * bMerged
)

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.

Protected function

void

 

ResolveNumerics

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

Public function

void

 

ScriptVariableChanged

(
    FNiagaraVariable Variable
)

Public function

void

 

SetMetaData

(
    const FNiagaraVariable & InVar,
    const FNiagaraVariableMetaData & Me...
)

Sets the meta-data associated with this variable.

Public function

void

 

SetPerScriptMetaData

(
    const FNiagaraVariable & InVar,
    const FNiagaraVariableMetaData & In...
)

Sets the usage metadata associated with this variable for a given script.

Public function Static

FName

 

StandardizeName

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

Public function

void

 

SubsumeExternalDependencies

(
    TMap < const UObject *, UObject ...
)

Determine if there are any external dependencies wrt to scripts and ensure that those dependencies are sucked into the existing package.

Public function

void

 

UnregisterPinVisualWidgetProvider

(
    const FDelegateHandle & InHandle
)

Public function Const

bool

 

UpdateUsageForScriptVariable

(
    UNiagaraScriptVariable* Script...
)

Sets the ENiagaraScriptParameterUsage on the Metadata of a ScriptVariable depending on its pin usage in the node graph (used on input/output pins).

Overridden from UEdGraph

Name Description

Public function Virtual

void

 

NotifyGraphChanged()

A change was made to the graph that external parties should take note of.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Classes

Name

Description

Public struct

FAddParameterOptions

Options for the AddParameter function.

Public struct

FFindInputNodeOptions

Options for the FindInputNodes function

Typedefs

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback