Stack

Windows
MacOS
Linux

Classes

Name

Description

Public class

FNiagaraParameterHandle

Public class

FNiagaraStackEntryDragDropOp

Public class

FNiagaraStackFunctionInputCondition

Users a condition string to bind to an input on a stack function and determines if the value of that input matches a specific value.

Public struct

FNiagaraStackItemGroupAddOptions

Defines options for adding items to groups in the stack.

Public class

FNiagaraStackItemGroupAddUtilities

Public struct

FNiagaraStackViewModelOptions

Public struct

FStackNodeGroup

Public class

INiagaraStackItemGroupAddAction

Represents a single action for adding an item to a group in the stack.

Public class

INiagaraStackItemGroupAddUtilities

Defines utilities for generically handling adding items to groups in the stack.

Public class

TNiagaraStackItemGroupAddUtilities

Public class UClass

UNiagaraStackEmitterPropertiesItem

Public class UClass

UNiagaraStackEmitterSettingsGroup

Public class UClass

UNiagaraStackEntry

Public class UClass

UNiagaraStackErrorItem

Public class UClass

UNiagaraStackErrorItemDismiss

Public class UClass

UNiagaraStackErrorItemFix

Public class UClass

UNiagaraStackErrorItemLongDescription

Public class UClass

UNiagaraStackEventHandlerGroup

Container for one or more NiagaraStackEventScriptItemGroups, allowing multiple event handlers per script.

Public class UClass

UNiagaraStackEventHandlerPropertiesItem

Public class UClass

UNiagaraStackEventScriptItemGroup

Meant to contain a single binding of a Emitter::EventScriptProperties to the stack.

Public class UClass

UNiagaraStackFunctionInput

Represents a single module input in the module stack view model.

Public class UClass

UNiagaraStackFunctionInputCollection

Public class UClass

UNiagaraStackInputCategory

Public class UClass

UNiagaraStackItem

Public class UClass

UNiagaraStackItemContent

Public class UClass

UNiagaraStackItemFooter

Public class UClass

UNiagaraStackItemGroup

Public class UClass

UNiagaraStackItemGroupFooter

Public class UClass

UNiagaraStackItemTextContent

Public class UClass

UNiagaraStackModuleItem

Public class UClass

UNiagaraStackModuleItemLinkedInputCollection

Public class UClass

UNiagaraStackModuleItemOutput

Represents a single module Output in the module stack view model.

Public class UClass

UNiagaraStackModuleItemOutputCollection

Public class UClass

UNiagaraStackObject

Public class UClass

UNiagaraStackParameterStoreEntry

Represents a single module input in the module stack view model.

Public class UClass

UNiagaraStackParameterStoreItem

Public class UClass

UNiagaraStackPropertyRow

Public class UClass

UNiagaraStackRendererItem

Public class UClass

UNiagaraStackRenderItemGroup

Public class UClass

UNiagaraStackRoot

Public class UClass

UNiagaraStackScriptItemGroup

Public class UClass

UNiagaraStackSelection

Public class UClass

UNiagaraStackSimulationStageGroup

Meant to contain a single binding of a Emitter::EventScriptProperties to the stack.

Public class UClass

UNiagaraStackSimulationStagePropertiesItem

Public class UClass

UNiagaraStackSimulationStagesGroup

Container for one or more NiagaraStackEventScriptItemGroups, allowing multiple event handlers per script.

Public class UClass

UNiagaraStackSystemPropertiesItem

Public class UClass

UNiagaraStackSystemSettingsGroup

Public class UClass

UNiagaraStackViewModel

Enums

Functions

Name Description

Public function

void

 

FNiagaraStackClipboardUtilities::CopySelection

(
    const TArray< UNiagaraStackEntry&#...
)

Public function

void

 

FNiagaraStackClipboardUtilities::CutSelection

(
    const TArray< UNiagaraStackEntry&#...
)

Public function

void

 

FNiagaraStackClipboardUtilities::DeleteSelection

(
    const TArray< UNiagaraStackEntry&#...
)

Public function

void

 

FNiagaraStackClipboardUtilities::PasteSelection

(
    const TArray< UNiagaraStackEntry&#...,
    FText& OutPasteWarning
)

Public function

bool

 

FNiagaraStackClipboardUtilities::TestCanCopySelectionWithMessage

(
    const TArray< UNiagaraStackEntry&#...,
    FText& OutCanCopyMessage
)

Public function

bool

 

FNiagaraStackClipboardUtilities::TestCanCutSelectionWithMessage

(
    const TArray< UNiagaraStackEntry&#...,
    FText& OutCanCutMessage
)

Public function

bool

 

FNiagaraStackClipboardUtilities::TestCanDeleteSelectionWithMessage

(
    const TArray< UNiagaraStackEntry&#...,
    FText& OutMessage
)

Public function

bool

 

FNiagaraStackClipboardUtilities::TestCanPasteSelectionWithMessage

(
    const TArray< UNiagaraStackEntry&#...,
    FText& OutCanPasteMessage
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::AddParameterModuleToStack

(
    const TArray< FNiagaraVariable >& ...,
    UNiagaraNodeOutput& TargetOutputNo...,
    int32 TargetIndex,
    const TArray< FString >& InDefault...
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::AddScriptModuleToStack

(
    UNiagaraScript* ModuleScript,
    UNiagaraNodeOutput& TargetOutputNo...,
    int32 TargetIndex
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::AddScriptModuleToStack

(
    FAssetData ModuleScriptAsset,
    UNiagaraNodeOutput& TargetOutputNo...,
    int32 TargetIndex
)

Public function

void

 

FNiagaraStackGraphUtilities::BreakAllPinLinks

(
    UEdGraphPin* PinA
)

Public function

bool

 

FNiagaraStackGraphUtilities::CanWriteParameterFromUsage

(
    FNiagaraVariable Parameter,
    ENiagaraScriptUsage Usage
)

Public function

void

 

FNiagaraStackGraphUtilities::CleanUpStaleRapidIterationParameters

(
    UNiagaraEmitter& Emitter
)

Public function

void

 

FNiagaraStackGraphUtilities::CleanUpStaleRapidIterationParameters

(
    UNiagaraScript& Script,
    UNiagaraEmitter& OwningEmitter
)

Public function

void

 

FNiagaraStackGraphUtilities::ConnectPinToInputNode

(
    UEdGraphPin& Pin,
    UNiagaraNodeInput& InputNode
)

Public function

void

 

FNiagaraStackGraphUtilities::ConnectStackNodeGroup

(
    const FStackNodeGroup& ConnectGrou...,
    const FStackNodeGroup& NewPrevious...,
    const FStackNodeGroup& NewNextGrou...
)

Public function

FNiagaraVari...

 

FNiagaraStackGraphUtilities::CreateRapidIterationParameter

(
    const FString& UniqueEmitterName,
    ENiagaraScriptUsage ScriptUsage,
    const FName& AliasedInputName,
    const FNiagaraTypeDefinition& Inpu...
)

Public function

void

 

FNiagaraStackGraphUtilities::DisconnectStackNodeGroup

(
    const FStackNodeGroup& DisconnectG...,
    const FStackNodeGroup& PreviousGro...,
    const FStackNodeGroup& NextGroup
)

Public function

bool

 

FNiagaraStackGraphUtilities::DoesDynamicInputMatchDefault

(
    FString EmitterUniqueName,
    UNiagaraScript& OwningScript,
    UNiagaraNodeFunctionCall& OwningFu...,
    UEdGraphPin& OverridePin,
    FName InputName,
    UEdGraphPin& DefaultPin
)

Public function

void

 

FNiagaraStackGraphUtilities::FindAffectedScripts

(
    UNiagaraSystem& System,
    UNiagaraEmitter* Emitter,
    UNiagaraNodeFunctionCall& ModuleNo...,
    TArray< TWeakObjectPtr< UNiagaraScr...
)

Public function

bool

 

FNiagaraStackGraphUtilities::FindScriptModulesInStack

(
    FAssetData ModuleScriptAsset,
    UNiagaraNodeOutput& TargetOutputNo...,
    TArray< UNiagaraNodeFunctionCall&#...
)

Public function

void

 

FNiagaraStackGraphUtilities::GatherRenamedStackFunctionInputAndOutputVariableNames

(
    UNiagaraEmitter* Emitter,
    UNiagaraNodeFunctionCall& Function...,
    const FString& OldFunctionName,
    const FString& NewFunctionName,
    TMap< FName, FName >& OutOldToNewN...
)

Public function

void

 

FNiagaraStackGraphUtilities::GatherRenamedStackFunctionOutputVariableNames

(
    UNiagaraEmitter* Emitter,
    UNiagaraNodeFunctionCall& Function...,
    const FString& OldFunctionName,
    const FString& NewFunctionName,
    TMap< FName, FName >& OutOldToNewN...
)

Public function

FString

 

FNiagaraStackGraphUtilities::GenerateStackFunctionInputEditorDataKey

(
    UNiagaraNodeFunctionCall& Function...,
    FNiagaraParameterHandle InputParame...
)

Public function

FString

 

FNiagaraStackGraphUtilities::GenerateStackModuleEditorDataKey

(
    UNiagaraNodeFunctionCall& ModuleNo...
)

Public function

void

 

FNiagaraStackGraphUtilities::GetAvailableParametersForScript

(
    UNiagaraNodeOutput& ScriptOutputNo...,
    TArray< FNiagaraVariable >& OutAva...
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::GetEmitterInputNodeForStackNode

(
    UNiagaraNode& StackNode
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::GetEmitterOutputNodeForStackNode

(
    UNiagaraNode& StackNode
)

Public function

const UNiaga...

 

FNiagaraStackGraphUtilities::GetEmitterOutputNodeForStackNode

(
    const UNiagaraNode& StackNode
)

Public function

TOptional< b...

 

FNiagaraStackGraphUtilities::GetModuleIsEnabled

(
    UNiagaraNodeFunctionCall& Function...
)

Public function

TOptional< F...

 

FNiagaraStackGraphUtilities::GetNamespaceForScriptUsage

(
    ENiagaraScriptUsage ScriptUsage
)

Public function

void

 

FNiagaraStackGraphUtilities::GetNamespacesForNewReadParameters

(
    EStackEditContext EditContext,
    ENiagaraScriptUsage Usage,
    TArray< FName >& OutNamespacesForN...
)

Gets the valid namespaces which new parameters for this usage can be read from.

Public function

void

 

FNiagaraStackGraphUtilities::GetNamespacesForNewWriteParameters

(
    EStackEditContext EditContext,
    ENiagaraScriptUsage Usage,
    TArray< FName >& OutNamespacesForN...
)

Gets the valid namespaces which new parameters for this usage can write to.

Public function

void

 

FNiagaraStackGraphUtilities::GetNewParameterAvailableTypes

(
    TArray< FNiagaraTypeDefinition >& ...,
    FName Namespace
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::GetNextModuleNode

(
    UNiagaraNodeFunctionCall& CurrentN...
)

Public function

UEdGraphPin ...

 

FNiagaraStackGraphUtilities::GetOrCreateStackFunctionInputOverridePin

(
    UNiagaraNodeFunctionCall& StackFun...,
    FNiagaraParameterHandle AliasedInpu...,
    FNiagaraTypeDefinition InputType,
    const FGuid& PreferredOverrideNode...
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::GetOrCreateStackFunctionOverrideNode

(
    UNiagaraNodeFunctionCall& Function...,
    const FGuid& PreferredOverrideNode...
)

Public function

void

 

FNiagaraStackGraphUtilities::GetOrderedModuleNodes

(
    UNiagaraNodeOutput& OutputNode,
    TArray< UNiagaraNodeFunctionCall&#...
)

Public function

UEdGraphPin ...

 

FNiagaraStackGraphUtilities::GetParameterMapInputPin

(
    UNiagaraNode& Node
)

Public function

UEdGraphPin ...

 

FNiagaraStackGraphUtilities::GetParameterMapOutputPin

(
    UNiagaraNode& Node
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::GetPreviousModuleNode

(
    UNiagaraNodeFunctionCall& CurrentN...
)

Public function

ENiagaraPara...

 

FNiagaraStackGraphUtilities::GetScopeForScriptUsage

(
    ENiagaraScriptUsage ScriptUsage
)

Public function

void

 

FNiagaraStackGraphUtilities::GetScriptAssetsByDependencyProvided

(
    ENiagaraScriptUsage AssetUsage,
    FName DependencyName,
    TArray< FAssetData >& OutAssets
)

Public function

void

 

FNiagaraStackGraphUtilities::GetStackFunctionInputAndOutputVariables

(
    UNiagaraNodeFunctionCall& Function...,
    FCompileConstantResolver ConstantRe...,
    TArray< FNiagaraVariable >& OutVar...,
    TArray< FNiagaraVariable >& OutVar...
)

Public function

UEdGraphPin ...

 

FNiagaraStackGraphUtilities::GetStackFunctionInputOverridePin

(
    UNiagaraNodeFunctionCall& StackFun...,
    FNiagaraParameterHandle AliasedInpu...
)

Public function

void

 

FNiagaraStackGraphUtilities::GetStackFunctionInputPins

(
    UNiagaraNodeFunctionCall& Function...,
    TArray< const UEdGraphPin* >&...,
    TSet< const UEdGraphPin* >& O...,
    FCompileConstantResolver ConstantRe...,
    ENiagaraGetStackFunctionInputPinsOp...,
    bool bIgnoreDisabled
)

Public function

void

 

FNiagaraStackGraphUtilities::GetStackFunctionInputPins

(
    UNiagaraNodeFunctionCall& Function...,
    TArray< const UEdGraphPin* >&...,
    ENiagaraGetStackFunctionInputPinsOp...,
    bool bIgnoreDisabled
)

Public function

void

 

FNiagaraStackGraphUtilities::GetStackFunctionOutputVariables

(
    UNiagaraNodeFunctionCall& Function...,
    FCompileConstantResolver ConstantRe...,
    TArray< FNiagaraVariable >& OutOut...,
    TArray< FNiagaraVariable >& OutOut...
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::GetStackFunctionOverrideNode

(
    UNiagaraNodeFunctionCall& Function...
)

Public function

void

 

FNiagaraStackGraphUtilities::GetStackFunctionStaticSwitchPins

(
    UNiagaraNodeFunctionCall& Function...,
    TArray< UEdGraphPin* >& OutIn...,
    TSet< UEdGraphPin* >& OutHidd...
)

Public function

bool

 

FNiagaraStackGraphUtilities::GetStackIssuesRecursively

(
    const UNiagaraStackEntry*const...,
    TArray< UNiagaraStackErrorItem*...
)

Public function

void

 

FNiagaraStackGraphUtilities::GetStackNodeGroups

(
    UNiagaraNode& StackNode,
    TArray< FStackNodeGroup >& OutStac...
)

Public function

TArray< UEdG...

 

FNiagaraStackGraphUtilities::GetUnusedFunctionInputPins

(
    UNiagaraNodeFunctionCall& Function...,
    FCompileConstantResolver ConstantRe...
)

Module script calls do not have direct inputs, but rely on the parameter map being initialized correctly.

Public function

void

 

FNiagaraStackGraphUtilities::GetWrittenVariablesForGraph

(
    UEdGraph& Graph,
    TArray< FNiagaraVariable >& OutWri...
)

Public function

void

 

FNiagaraStackGraphUtilities::InitializeStackFunctionInput

(
    TSharedRef< FNiagaraSystemViewModel...,
    TSharedPtr< FNiagaraEmitterViewMode...,
    UNiagaraStackEditorData& StackEdit...,
    UNiagaraNodeFunctionCall& ModuleNo...,
    UNiagaraNodeFunctionCall& InputFun...,
    FName InputName
)

Public function

void

 

FNiagaraStackGraphUtilities::InitializeStackFunctionInputs

(
    TSharedRef< FNiagaraSystemViewModel...,
    TSharedPtr< FNiagaraEmitterViewMode...,
    UNiagaraStackEditorData& StackEdit...,
    UNiagaraNodeFunctionCall& ModuleNo...,
    UNiagaraNodeFunctionCall& InputFun...
)

Public function

bool

 

FNiagaraStackGraphUtilities::IsRapidIterationType

(
    const FNiagaraTypeDefinition& Inpu...
)

Public function

bool

 

FNiagaraStackGraphUtilities::IsValidDefaultDynamicInput

(
    UNiagaraScript& OwningScript,
    UEdGraphPin& DefaultPin
)

Public function

void

 

FNiagaraStackGraphUtilities::MakeLinkTo

(
    UEdGraphPin* PinA,
    UEdGraphPin* PinB
)

Public function

UNiagaraStac...

 

FNiagaraStackGraphUtilities::MessageManagerMessageToStackIssue

(
    TSharedRef< const INiagaraMessage >...,
    FString InStackEditorDataKey
)

Public function

void

 

FNiagaraStackGraphUtilities::MoveModule

(
    UNiagaraScript& SourceScript,
    UNiagaraNodeFunctionCall& ModuleTo...,
    UNiagaraSystem& TargetSystem,
    FGuid TargetEmitterHandleId,
    ENiagaraScriptUsage TargetUsage,
    FGuid TargetUsageId,
    int32 TargetModuleIndex,
    bool bForceCopy,
    UNiagaraNodeFunctionCall*& Out...
)

Public function

bool

 

FNiagaraStackGraphUtilities::ParameterAllowedInExecutionCategory

(
    const FName InParameterName,
    const FName ExecutionCategory
)

Whether a parameter is allowed to be used in a certain execution category.

Public function

void

 

FNiagaraStackGraphUtilities::RebuildEmitterNodes

(
    UNiagaraSystem& System
)

Public function

void

 

FNiagaraStackGraphUtilities::RelayoutGraph

(
    UEdGraph& Graph
)

Public function

bool

 

FNiagaraStackGraphUtilities::RemoveModuleFromStack

(
    UNiagaraScript& OwningScript,
    UNiagaraNodeFunctionCall& ModuleNo...,
    TArray< TWeakObjectPtr< UNiagaraNod...
)

Public function

bool

 

FNiagaraStackGraphUtilities::RemoveModuleFromStack

(
    UNiagaraScript& OwningScript,
    UNiagaraNodeFunctionCall& ModuleNo...
)

Public function

bool

 

FNiagaraStackGraphUtilities::RemoveModuleFromStack

(
    UNiagaraSystem& OwningSystem,
    FGuid OwningEmitterId,
    UNiagaraNodeFunctionCall& ModuleNo...,
    TArray< TWeakObjectPtr< UNiagaraNod...
)

Public function

bool

 

FNiagaraStackGraphUtilities::RemoveModuleFromStack

(
    UNiagaraSystem& OwningSystem,
    FGuid OwningEmitterId,
    UNiagaraNodeFunctionCall& ModuleNo...
)

Public function

void

 

FNiagaraStackGraphUtilities::RemoveNodesForStackFunctionInputOverridePin

(
    UEdGraphPin& StackFunctionInputOve...
)

Public function

void

 

FNiagaraStackGraphUtilities::RemoveNodesForStackFunctionInputOverridePin

(
    UEdGraphPin& StackFunctinoInputOve...,
    TArray< TWeakObjectPtr< UNiagaraDat...
)

Public function

void

 

FNiagaraStackGraphUtilities::RenameAssignmentTarget

(
    UNiagaraSystem& OwningSystem,
    UNiagaraEmitter* OwningEmitter,
    UNiagaraScript& OwningScript,
    UNiagaraNodeAssignment& OwningAssi...,
    FNiagaraVariable CurrentAssignmentT...,
    FName NewAssignmentTargetName
)

Public function

void

 

FNiagaraStackGraphUtilities::RenameReferencingParameters

(
    UNiagaraSystem& System,
    UNiagaraEmitter* Emitter,
    UNiagaraNodeFunctionCall& Function...,
    const FString& OldName,
    const FString& NewName
)

Public function

UNiagaraNode...

 

FNiagaraStackGraphUtilities::ResetGraphForOutput

(
    UNiagaraGraph& NiagaraGraph,
    ENiagaraScriptUsage ScriptUsage,
    FGuid ScriptUsageId,
    const FGuid& PreferredOutputNodeGu...,
    const FGuid& PreferredInputNodeGui...
)

Public function

void

 

FNiagaraStackGraphUtilities::ResetToDefaultDynamicInput

(
    TSharedRef< FNiagaraSystemViewModel...,
    TSharedPtr< FNiagaraEmitterViewMode...,
    UNiagaraStackEditorData& StackEdit...,
    UNiagaraScript& SourceScript,
    const TArray< TWeakObjectPtr< UNiag...,
    UNiagaraNodeFunctionCall& ModuleNo...,
    UNiagaraNodeFunctionCall& InputFun...,
    FName InputName,
    UEdGraphPin& DefaultPin
)

Public function

void

 

FNiagaraStackGraphUtilities::SetCustomExpressionForFunctionInput

(
    UEdGraphPin& OverridePin,
    const FString& CustomExpression,
    UNiagaraNodeCustomHlsl*& OutDy...,
    const FGuid& NewNodePersistentId
)

Public function

void

 

FNiagaraStackGraphUtilities::SetDataValueObjectForFunctionInput

(
    UEdGraphPin& OverridePin,
    UClass* DataObjectType,
    FString InputNodeInputName,
    UNiagaraDataInterface*& OutDat...,
    const FGuid& NewNodePersistentId
)

Public function

void

 

FNiagaraStackGraphUtilities::SetDynamicInputForFunctionInput

(
    UEdGraphPin& OverridePin,
    UNiagaraScript* DynamicInput,
    UNiagaraNodeFunctionCall*& Out...,
    const FGuid& NewNodePersistentId,
    FString SuggestedName
)

Public function

void

 

FNiagaraStackGraphUtilities::SetLinkedValueHandleForFunctionInput

(
    UEdGraphPin& OverridePin,
    FNiagaraParameterHandle LinkedParam...,
    const FGuid& NewNodePersistentId
)

Public function

void

 

FNiagaraStackGraphUtilities::SetModuleIsEnabled

(
    UNiagaraNodeFunctionCall& Function...,
    bool bIsEnabled
)

Public function

bool

 

FNiagaraStackGraphUtilities::TryRenameAssignmentTarget

(
    UNiagaraNodeAssignment& OwningAssi...,
    FNiagaraVariable CurrentAssignmentT...,
    FName NewAssignmentTargetName
)

Public function

bool

 

FNiagaraStackGraphUtilities::ValidateGraphForOutput

(
    UNiagaraGraph& NiagaraGraph,
    ENiagaraScriptUsage ScriptUsage,
    FGuid ScriptUsageId,
    FText& ErrorMessage
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss