1. Epic GamesDeveloper
  3. TNiagaraParameterMapHistory

TNiagaraParameterMapHistory

Traverses a Niagara node graph to identify the variables that have been written and read from a parameter map.

API > API/Plugins > API/Plugins/NiagaraEditor

References

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

Syntax

template<typename GraphBridge>  
struct TNiagaraParameterMapHistory

Remarks

Traverses a Niagara node graph to identify the variables that have been written and read from a parameter map. This class is meant to aid in UI and compilation of the graph. There are several main script types and each one interacts slightly differently with the history depending on context.

Variables

  Type Name Description
Public variable TArray< FNiagaraDataSetID > AdditionalDataSetWrites List of additional DataSets to be written that were encountered during traversal.
Public variable bool bParameterCollectionsSkipped  
Public variable TArray< FString > EmitterNamespacesEncountered List of emitter namespaces encountered as this parameter map was built.
Public variable FParameterCollectionStore EncounteredParameterCollections Used parameter collections identified during the traversal.
Public variable TArray< FName > IterationNamespaceOverridesEncountered List of all the custom iteration source override namespaces encountered
Public variable TArray< TTuple< uint32, uint32 > > MapNodeVariableMetaData For each node in MapNodeVisitations, record the start index and end index of variables added within the body of the node, i.e. a Get node will record just the values it pulls out directly.
Public variable TArray< const FNode * > MapNodeVisitations List of nodes that manipulated the parameter map from input to output.
Public variable TArray< const FPin * > MapPinHistory List of pins that manipulated the parameter map from input to output.
Public variable ENiagaraScriptUsage OriginatingScriptUsage  
Public variable TArray< TArray< FString > > PerVariableConstantDefaultValue  
Public variable TArray< TArray< FString > > PerVariableConstantValue  
Public variable TArray< TArray< FReadHistory > > PerVariableReadHistory  
Public variable TArray< FString > PerVariableWarnings Are there any warnings that were encountered during the traversal of the graph for a given variable?
Public variable TArray< TArray< TModuleScopedPin< FPin > > > PerVariableWriteHistory For each variable that was found, identify the pins that wrote to them in order from first to last write.
Public variable TMap< FGraphTraversalHandle, FString > PinToConstantValues  
Public variable FGuid UsageGuid  
Public variable FName UsageName  
Public variable TArray< FNiagaraVariableMetaData > VariableMetaData The metadata associated with each variable identified during the traversal.
Public variable TArray< FNiagaraVariable > Variables The variables that have been identified during the traversal.
Public variable TArray< FNiagaraVariable > VariablesWithOriginalAliasesIntact  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function int32 Add a variable outside the normal get/set node paradigm.
Public function int32

AddVariable ( const FNiagaraVariable& InVar,
const FNiagaraVariable& InAliasedVar,
FName ModuleName,
const FPin* InPin,
TOptional< FNiagaraVariableMetaData > InMetaData
)

 Helper to add a variable to the known list for a parameter map.
Public function uint32

BeginNodeVisitation ( const FNode* Node
)

  
Public function void

ConditionalUpdateAliasedVariable ( int32 VariableIndex,
const FNiagaraVariableBase& InAliasedVar
)

  
Public function void

EndNodeVisitation ( uint32 IndexFromBeginNode
)

  
Public function Const int32

FindVariable ( const FName& VariableName,
const FNiagaraTypeDefinition& Type
)

 Find a variable by both name and type.
Public function Const int32

FindVariableByName ( const FName& VariableName,
bool bAllowPartialMatch
)

 Find a variable by name with no concern for type.
Public function Const const FInputPin * Get the default value for this variable.
Public function Const const FOutputNode * Get the output node associated with this graph.
Public function Const const FPin * Get the output pin that we traced to build this history object.
Public function Const const FPin * Get the pin that added the parameter map to the graph.
Public function FParameterCollection

IsParameterCollectionParameter ( FNiagaraVariable& InVar,
bool& bMissingParameter
)

 If this is variable is a parameter in one of our tracked collections, return it.
Public function FNiagaraCompilationGraphBridge::FParameterCollection

IsParameterCollectionParameter ( FNiagaraVariable& InVar,
bool& bMissingParameter
)

  
Public function FNiagaraCompilationDigestBridge::FParameterCollection

IsParameterCollectionParameter ( FNiagaraVariable& InVar,
bool& bMissingParameter
)

  
Public function Const bool

IsPrimaryDataSetOutput ( const FNiagaraVariable& InVar,
const UNiagaraScript* InScript,
bool bAllowDataInterfaces,
bool bAllowStatics
)

 Called to determine if a given variable should be output from a script.
Public function Const bool

IsPrimaryDataSetOutput ( const FNiagaraVariable& InVar,
ENiagaraScriptUsage InUsage,
bool bAllowDataInterfaces,
bool bAllowStatics
)

  
Public function Const bool  
Public function void

RegisterConstantPin ( const FGraphTraversalHandle& InTraversalPath,
const FPin* InPin,
const FString& InValue
)

  
Public function void

RegisterConstantVariableWrite ( const FString& InValue,
int32 InVarIdx,
bool bIsSettingDefault,
bool bIsLinkNotValue
)

  
Public function int32

RegisterParameterMapPin ( const FPin* Pin
)

 Called in a depth-first traversal to identify a given Niagara Parameter Map pin that was touched during traversal.
Public function Const bool  

Classes

  Type Name Description
Public struct FReadHistory For each variable that was found, identify the pins that read them from the map in order from first to last read.  

Typedefs

Name Description
FInputPin  
FModuleScopedPin  
FNode  
FOutputNode  
FParameterCollection  
FParameterCollectionStore  
FPin  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page