1. Epic GamesDeveloper
  3. Stack

Stack

API > API/Plugins > API/Plugins/NiagaraEditor > API/Plugins/NiagaraEditor/ViewModels

Classes

  Type Name Description
Public struct FAddScriptModuleToStackArgs    
Public struct FInputDataCacheKey    
Public struct FInputDataCollection    
Public struct FMatchingFunctionInputData    
Public struct FNiagaraFunctionInputInstanceData    
Public class FNiagaraParameterHandle    
Public class FNiagaraPlatformSetIssueGenerator    
Public struct FNiagaraScriptInstanceData    
Public class FNiagaraStackEmitterStageAddUtilities    
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 INiagaraStackItemHeaderValueHandler    
Public class INiagaraStackObjectIssueGenerator    
Public class TNiagaraStackItemGroupAddUtilities    
Public class UClass MinimalAPI UNiagaraStackCategory    
Public class UClass MinimalAPI UNiagaraStackCommentCollection    
Public class UClass MinimalAPI UNiagaraStackEmitterPropertiesGroup    
Public class UClass MinimalAPI UNiagaraStackEmitterPropertiesItem    
Public class UClass MinimalAPI UNiagaraStackEmitterSummaryGroup    
Public class UClass MinimalAPI UNiagaraStackEmitterSummaryItem    
Public class UClass MinimalAPI UNiagaraStackEntry    
Public class UClass MinimalAPI UNiagaraStackErrorItem    
Public class UClass MinimalAPI UNiagaraStackErrorItemDismiss    
Public class UClass MinimalAPI UNiagaraStackErrorItemFix    
Public class UClass MinimalAPI UNiagaraStackErrorItemLongDescription    
Public class UClass MinimalAPI UNiagaraStackEventHandlerPropertiesItem    
Public class UClass MinimalAPI UNiagaraStackEventScriptItemGroup Meant to contain a single binding of a Emitter::EventScriptProperties to the stack.  
Public class UClass MinimalAPI UNiagaraStackEventWrapper This is a wrapper class used for the details customization in the stack, since the event script properties were moved from the emitter object into the version data struct.  
Public class UClass MinimalAPI UNiagaraStackFunctionInput Represents a single module input in the module stack view model.  
Public class UClass MinimalAPI UNiagaraStackItem    
Public class UClass MinimalAPI UNiagaraStackItemContent    
Public class UClass MinimalAPI UNiagaraStackItemFooter    
Public class UClass MinimalAPI UNiagaraStackItemGroup    
Public class UClass MinimalAPI UNiagaraStackItemGroupFooter    
Public class UClass MinimalAPI UNiagaraStackItemTextContent    
Public class UClass MinimalAPI UNiagaraStackModuleItem    
Public class UClass MinimalAPI UNiagaraStackModuleItemLinkedInputCollection    
Public class UClass MinimalAPI UNiagaraStackModuleItemOutput Represents a single module Output in the module stack view model.  
Public class UClass MinimalAPI UNiagaraStackModuleItemOutputCollection    
Public class UClass MinimalAPI UNiagaraStackNote    
Public class UClass MinimalAPI UNiagaraStackObject    
Public class UClass MinimalAPI UNiagaraStackPropertyRow    
Public class UClass MinimalAPI UNiagaraStackRendererItem    
Public class UClass MinimalAPI UNiagaraStackRenderItemGroup    
Public class UClass MinimalAPI UNiagaraStackRoot    
Public class UClass MinimalAPI UNiagaraStackScriptHierarchyCategory    
Public class UClass MinimalAPI UNiagaraStackScriptHierarchyRoot A script's stack hierarchy root, representing a UNiagaraHierarchyRoot object in the stack.  
Public class UClass MinimalAPI UNiagaraStackScriptItemGroup    
Public class UClass MinimalAPI UNiagaraStackSelection    
Public class UClass MinimalAPI UNiagaraStackSimulationStageGroup Meant to contain a single binding of a Emitter::EventScriptProperties to the stack.  
Public class UClass MinimalAPI UNiagaraStackSimulationStagePropertiesItem    
Public class UClass MinimalAPI UNiagaraStackSpacer    
Public class UClass MinimalAPI UNiagaraStackStatelessEmitterGroup    
Public class UClass MinimalAPI UNiagaraStackStatelessEmitterObjectItem    
Public class UClass MinimalAPI UNiagaraStackStatelessEmitterSimulateGroup    
Public class UClass MinimalAPI UNiagaraStackStatelessEmitterSpawnGroup    
Public class UClass MinimalAPI UNiagaraStackStatelessEmitterSpawnItem    
Public class UClass MinimalAPI UNiagaraStackStatelessModuleItem    
Public class UClass MinimalAPI UNiagaraStackSummaryCategory    
Public class UClass MinimalAPI UNiagaraStackSummaryViewCollection    
Public class UClass MinimalAPI UNiagaraStackSystemPropertiesGroup    
Public class UClass MinimalAPI UNiagaraStackSystemPropertiesItem    
Public class UClass MinimalAPI UNiagaraStackSystemUserParametersGroup    
Public class UClass MinimalAPI UNiagaraStackValueCollection A base class for value collections.  
Public class UClass MinimalAPI UNiagaraStackViewModel    

Typedefs

Name Description
FNiagaraFunctionInputMap  
FOnFilterDetailNodes  
FOnGetFunctionCallNode  
FOnGetPerInputInstanceData  
FOnGetScriptInstanceData  

Enums

  Type Name Description
Public enum UEnum EStackIssueSeverity    
Public enum UEnum EStackParameterBehavior    
Public enum FNiagaraStackGraphUtilities::ENiagaraGetStackFunctionInputPinsOptions    
Public enum FNiagaraStackGraphUtilities::EStackEditContext    

Functions

  Type Name Description
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

FNiagaraStackClipboardUtilities::PasteSelection ( const TArray< UNiagaraStackEntry* >& SelectedEntries,
FText& OutPasteWarning
)

  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function void

FNiagaraStackGraphUtilities::AddNewVariableToParameterMapNode ( UNiagaraNodeParameterMapBase* MapBaseNode,
bool bCreateInputPin,
const UNiagaraScriptVariable* NewScriptVar
)

  
Public function void

FNiagaraStackGraphUtilities::AddNewVariableToParameterMapNode ( UNiagaraNodeParameterMapBase* MapBaseNode,
bool bCreateInputPin,
const FNiagaraVariable& NewVariable
)

 Helper to add a new pin to a ParameterMapBaseNode, and conditionally add a new parameter to the underlying UNiagaraGraph if it does not yet exist.
Public function UNiagaraNodeAssignment *

FNiagaraStackGraphUtilities::AddParameterModuleToStack ( const TArray< FNiagaraVariable >& ParameterVariables,
UNiagaraNodeOutput& TargetOutputNode,
int32 TargetIndex,
const TArray< FString >& InDefaultValues
)

  
Public function UNiagaraNodeFunctionCall *

FNiagaraStackGraphUtilities::AddScriptModuleToStack ( UNiagaraScript* ModuleScript,
UNiagaraNodeOutput& TargetOutputNode,
int32 TargetIndex,
FString SuggestedName,
const FGuid& VersionGuid
)

  
Public function UNiagaraNodeFunctionCall *

FNiagaraStackGraphUtilities::AddScriptModuleToStack ( FAssetData ModuleScriptAsset,
UNiagaraNodeOutput& TargetOutputNode,
int32 TargetIndex,
FString SuggestedName
)

  
Public function UNiagaraNodeFunctionCall *  
Public function void  
Public function void

FNiagaraStackGraphUtilities::BuildParameterMapHistoryWithStackContextResolution ( FVersionedNiagaraEmitter OwningEmitter,
UNiagaraNodeOutput* OutputNodeInChain,
UNiagaraNode* NodeToVisit,
TArray< FNiagaraParameterMapHistory >& OutHistories,
bool bRecursive,
bool bFilterForCompilation
)

  
Public function bool

FNiagaraStackGraphUtilities::CanWriteParameterFromUsage ( FNiagaraVariable Parameter,
ENiagaraScriptUsage Usage,
const TOptional< FName >& StackContextOverride,
const TArray< FName >& StackContextAllOverrides
)

  
Public function bool  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

FNiagaraStackGraphUtilities::ConnectStackNodeGroup ( const FStackNodeGroup& ConnectGroup,
const FStackNodeGroup& NewPreviousGroup,
const FStackNodeGroup& NewNextGroup
)

  
Public function FNiagaraVariable

FNiagaraStackGraphUtilities::CreateRapidIterationParameter ( const FString& UniqueEmitterName,
ENiagaraScriptUsage ScriptUsage,
const FName& AliasedInputName,
const FNiagaraTypeDefinition& InputType
)

  
Public function bool  
Public function int32  
Public function void  
Public function void

FNiagaraStackGraphUtilities::DisconnectStackNodeGroup ( const FStackNodeGroup& DisconnectGroup,
const FStackNodeGroup& PreviousGroup,
const FStackNodeGroup& NextGroup
)

  
Public function void  
Public function TOptional< FMatchingFunctionInputData >  
Public function UNiagaraNodeAssignment *  
Public function UNiagaraNodeFunctionCall *  
Public function UNiagaraNodeFunctionCall * When you have the guid of the node available, we don't need to traverse pins and can just look up the correct node directly.
Public function UNiagaraNodeFunctionCall *  
Public function TArray< UNiagaraNodeFunctionCall * >  
Public function TArray< UNiagaraNodeFunctionCall * >  
Public function bool  
Public function void Fixes orphaned and disconnected output pins on dynamic input nodes resulting from the underlying script changing and the pins being reallocated.
Public function void  
Public function void

FNiagaraStackGraphUtilities::GatherRenamedStackFunctionInputAndOutputVariableNames ( FVersionedNiagaraEmitter Emitter,
UNiagaraNodeFunctionCall& FunctionCallNode,
const FString& OldFunctionName,
const FString& NewFunctionName,
TMap< FName, FName >& OutOldToNewNameMap
)

  
Public function void

FNiagaraStackGraphUtilities::GatherRenamedStackFunctionOutputVariableNames ( FVersionedNiagaraEmitter Emitter,
UNiagaraNodeFunctionCall& FunctionCallNode,
const FString& OldFunctionName,
const FString& NewFunctionName,
TMap< FName, FName >& OutOldToNewNameMap
)

  
Public function TArray< UNiagaraNodeFunctionCall * >  
Public function TArray< UNiagaraNodeFunctionCall * >  
Public function TArray< UNiagaraNodeFunctionCall * >  
Public function TArray< UNiagaraNodeOutput * >  
Public function TArray< UNiagaraNodeFunctionCall * >  
Public function void

FNiagaraStackGraphUtilities::GetEmitterHandleAndCompiledScriptsForStackNode ( const UNiagaraSystem& OwningSystem,
UNiagaraNode& StackNode,
const FNiagaraEmitterHandle*& OutEmitterHandle,
TArray< const UNiagaraScript* >& OutCompiledScripts
)

  
Public function UNiagaraNodeInput *  
Public function UNiagaraNodeOutput *  
Public function const UNiagaraNodeOutput *  
Public function UEdGraphPin *  
Public function TOptional< bool >  
Public function TOptional< FName >  
Public function TOptional< FName >  
Public function void Gets the valid namespaces which new parameters for this usage can be read from.
Public function void

FNiagaraStackGraphUtilities::GetNamespacesForNewWriteParameters ( EStackEditContext EditContext,
ENiagaraScriptUsage Usage,
const TOptional< FName >& StackContextAlias,
TArray< FName >& OutNamespacesForNewParameters
)

 Gets the valid namespaces which new parameters for this usage can write to.
Public function void  
Public function UNiagaraNodeFunctionCall *  
Public function UEdGraphPin &

FNiagaraStackGraphUtilities::GetOrCreateStackFunctionInputOverridePin ( UNiagaraNodeFunctionCall& StackFunctionCall,
FNiagaraParameterHandle AliasedInputParameterHandle,
FNiagaraTypeDefinition InputType,
const FGuid& InputScriptVariableId,
const FGuid& PreferredOverrideNodeGuid
)

  
Public function UNiagaraNodeParameterMapSet &  
Public function void  
Public function ENiagaraScriptUsage  
Public function TArray< UEdGraphPin * >

FNiagaraStackGraphUtilities::GetOverridePinsForFunction ( UNiagaraNodeParameterMapSet& OverrideNode,
UNiagaraNodeFunctionCall& FunctionCallNode
)

  
Public function UEdGraphPin *  
Public function UEdGraphPin *  
Public function TSet< FNiagaraVariable >  
Public function UNiagaraNodeFunctionCall *  
Public function FGuid  
Public function bool

FNiagaraStackGraphUtilities::GetStackFunctionInputAndOutputVariables ( UNiagaraNodeFunctionCall& FunctionCallNode,
FCompileConstantResolver ConstantResolver,
TArray< FNiagaraVariable >& OutVariables,
TArray< FNiagaraVariable >& OutVariablesWithOriginalAliasesIntact
)

 Gather a stack function's input and output variables.
Public function UEdGraphPin *  
Public function void

FNiagaraStackGraphUtilities::GetStackFunctionInputPinsWithoutCache ( const UNiagaraNodeFunctionCall& FunctionCallNode,
TConstArrayView< FNiagaraVariable > StaticVars,
TArray< const UEdGraphPin* >& OutInputPins,
const FCompileConstantResolver& ConstantResolver,
ENiagaraGetStackFunctionInputPinsOptions Options,
bool bIgnoreDisabled,
bool bFilterForCompilation
)

 Returns the input pins for the given function call node.
Public function void

FNiagaraStackGraphUtilities::GetStackFunctionInputs ( const UNiagaraNodeFunctionCall& FunctionCallNode,
TArray< FNiagaraVariable >& OutInputVariables,
TSet< FNiagaraVariable >& OutHiddenVariables,
FCompileConstantResolver ConstantResolver,
ENiagaraGetStackFunctionInputPinsOptions Options,
bool bIgnoreDisabled
)

 Returns the input pins for the given function call node.
Public function void Returns the input pins for the given function call node.
Public function void  
Public function void

FNiagaraStackGraphUtilities::GetStackFunctionOutputVariables ( UNiagaraNodeFunctionCall& FunctionCallNode,
FCompileConstantResolver ConstantResolver,
TArray< FNiagaraVariable >& OutOutputVariables,
TArray< FNiagaraVariable >& OutOutputVariablesWithOriginalAliasesIntact
)

  
Public function UNiagaraNodeParameterMapSet *  
Public function void

FNiagaraStackGraphUtilities::GetStackFunctionStaticSwitchPins ( const UNiagaraNodeFunctionCall& FunctionCallNode,
TArray< UEdGraphPin* >& OutInputPins,
TSet< UEdGraphPin* >& OutHiddenPins,
FCompileConstantResolver& ConstantResolver
)

  
Public function bool  
Public function void  
Public function uint32  
Public function TArray< UEdGraphPin * > Module script calls do not have direct inputs, but rely on the parameter map being initialized correctly.
Public function void  
Public function void  
Public function bool  
Public function bool  
Public function bool

FNiagaraStackGraphUtilities::IsValidDefaultDynamicInput ( UNiagaraScript& OwningScript,
UEdGraphPin& DefaultPin
)

  
Public function void

FNiagaraStackGraphUtilities::MakeLinkTo ( UEdGraphPin* PinA,
UEdGraphPin* PinB
)

  
Public function void

FNiagaraStackGraphUtilities::MoveModule ( UNiagaraScript& SourceScript,
UNiagaraNodeFunctionCall& ModuleToMove,
UNiagaraSystem& TargetSystem,
FGuid TargetEmitterHandleId,
ENiagaraScriptUsage TargetUsage,
FGuid TargetUsageId,
int32 TargetModuleIndex,
bool bForceCopy,
UNiagaraNodeFunctionCall*& OutMovedModue
)

  
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  
Public function void  
Public function void  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function void

FNiagaraStackGraphUtilities::RemoveNodesForStackFunctionInputOverridePin ( UEdGraphPin& StackFunctionInputOverridePin
)

  
Public function void

FNiagaraStackGraphUtilities::RemoveNodesForStackFunctionInputOverridePin ( UEdGraphPin& StackFunctinoInputOverridePin,
TArray< TWeakObjectPtr< UNiagaraDataInterface > >& OutRemovedDataObjects
)

  
Public function void

FNiagaraStackGraphUtilities::RenameAssignmentTarget ( UNiagaraSystem& OwningSystem,
FVersionedNiagaraEmitter OwningEmitter,
UNiagaraScript& OwningScript,
UNiagaraNodeAssignment& OwningAssignmentNode,
FNiagaraVariable CurrentAssignmentTarget,
FName NewAssignmentTargetName
)

  
Public function void  
Public function UNiagaraNodeOutput *

FNiagaraStackGraphUtilities::ResetGraphForOutput ( UNiagaraGraph& NiagaraGraph,
ENiagaraScriptUsage ScriptUsage,
FGuid ScriptUsageId,
const FGuid& PreferredOutputNodeGuid,
const FGuid& PreferredInputNodeGuid
)

  
Public function void

FNiagaraStackGraphUtilities::SetCustomExpressionForFunctionInput ( UEdGraphPin& OverridePin,
const FString& CustomExpression,
UNiagaraNodeCustomHlsl*& OutDynamicInputFunctionCall,
const FGuid& NewNodePersistentId
)

  
Public function void

FNiagaraStackGraphUtilities::SetDataInterfaceValueForFunctionInput ( UEdGraphPin& OverridePin,
UClass* DataObjectType,
FString InputNodeInputName,
UNiagaraDataInterface*& OutDataObject,
const FGuid& NewNodePersistentId
)

  
Public function void

FNiagaraStackGraphUtilities::SetDynamicInputForFunctionInput ( UEdGraphPin& OverridePin,
UNiagaraScript* DynamicInput,
UNiagaraNodeFunctionCall*& OutDynamicInputFunctionCall,
const FGuid& NewNodePersistentId,
FString SuggestedName,
const FGuid& InScriptVersion
)

  
Public function void

FNiagaraStackGraphUtilities::SetLinkedValueHandleForFunctionInput ( UEdGraphPin& OverridePin,
FNiagaraParameterHandle LinkedParameterHandle,
const TSet< FNiagaraVariable >& KnownParameters,
ENiagaraDefaultMode DesiredDefaultMode,
const FGuid& NewNodePersistentId
)

  
Public function void  
Public function void

FNiagaraStackGraphUtilities::SetObjectAssetValueForFunctionInput ( UEdGraphPin& OverridePin,
UClass* DataObjectType,
FString InputNodeInputName,
UObject* ObjectAsset,
const FGuid& NewNodePersistentId
)

  
Public function TArray< FName >  
Public function FString  
Public function FString  
Public function FString  
Public function void  
Public function void  
Public function bool

FNiagaraStackGraphUtilities::TryRenameAssignmentTarget ( UNiagaraNodeAssignment& OwningAssignmentNode,
FNiagaraVariable CurrentAssignmentTarget,
FName NewAssignmentTargetName
)

  
Public function bool

FNiagaraStackGraphUtilities::ValidateGraphForOutput ( UNiagaraGraph& NiagaraGraph,
ENiagaraScriptUsage ScriptUsage,
FGuid ScriptUsageId,
FText& ErrorMessage
)

  
Public function uint32  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page