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

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.

   
Name TNiagaraParameterMapHistory
Type struct
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraParameterMapHistory.h
Include Path #include "NiagaraParameterMapHistory.h"

Syntax

template<typename GraphBridge>  
struct TNiagaraParameterMapHistory

Constructors

Name Remarks Include Path Unreal Specifiers

TNiagaraParameterMapHistory()

   NiagaraParameterMapHistory.h  

Structs

Name Remarks
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 Type Remarks Include Path
FInputPin typename GraphBridge::FInputPin   NiagaraParameterMapHistory.h
FModuleScopedPin TModuleScopedPin< FPin >   NiagaraParameterMapHistory.h
FNode typename GraphBridge::FNode   NiagaraParameterMapHistory.h
FOutputNode typename GraphBridge::FOutputNode   NiagaraParameterMapHistory.h
FParameterCollection typename GraphBridge::FParameterCollection   NiagaraParameterMapHistory.h
FParameterCollectionStore typename GraphBridge::FParameterCollectionStore   NiagaraParameterMapHistory.h
FPin typename GraphBridge::FPin   NiagaraParameterMapHistory.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdditionalDataSetWrites TArray< FNiagaraDataSetID > List of additional DataSets to be written that were encountered during traversal. NiagaraParameterMapHistory.h  
bParameterCollectionsSkipped bool   NiagaraParameterMapHistory.h  
EmitterNamespacesEncountered TArray< FString > List of emitter namespaces encountered as this parameter map was built. NiagaraParameterMapHistory.h  
EncounteredParameterCollections FParameterCollectionStore Used parameter collections identified during the traversal. NiagaraParameterMapHistory.h  
IterationNamespaceOverridesEncountered TArray< FName > List of all the custom iteration source override namespaces encountered NiagaraParameterMapHistory.h  
MapNodeVariableMetaData TArray< TTuple< uint32, uint32 > > 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. NiagaraParameterMapHistory.h  
MapNodeVisitations TArray< const FNode * > List of nodes that manipulated the parameter map from input to output. NiagaraParameterMapHistory.h  
MapPinHistory TArray< const FPin * > List of pins that manipulated the parameter map from input to output. NiagaraParameterMapHistory.h  
OriginatingScriptUsage ENiagaraScriptUsage   NiagaraParameterMapHistory.h  
PerVariableConstantDefaultValue TArray< TArray< FString > >   NiagaraParameterMapHistory.h  
PerVariableConstantValue TArray< TArray< FString > >   NiagaraParameterMapHistory.h  
PerVariableReadHistory TArray< TArray< FReadHistory > >   NiagaraParameterMapHistory.h  
PerVariableWarnings TArray< FString > Are there any warnings that were encountered during the traversal of the graph for a given variable? NiagaraParameterMapHistory.h  
PerVariableWriteHistory TArray< TArray< TModuleScopedPin< FPin > > > For each variable that was found, identify the pins that wrote to them in order from first to last write. NiagaraParameterMapHistory.h  
PinToConstantValues TMap< FGraphTraversalHandle, FString >   NiagaraParameterMapHistory.h  
UsageGuid FGuid   NiagaraParameterMapHistory.h  
UsageName FName   NiagaraParameterMapHistory.h  
VariableMetaData TArray< FNiagaraVariableMetaData > The metadata associated with each variable identified during the traversal. NiagaraParameterMapHistory.h  
Variables TArray< FNiagaraVariable > The variables that have been identified during the traversal. NiagaraParameterMapHistory.h  
VariablesWithOriginalAliasesIntact TArray< FNiagaraVariable >   NiagaraParameterMapHistory.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddExternalVariable ( const FNiagaraVariable& InVar
)

 Add a variable outside the normal get/set node paradigm. NiagaraParameterMapHistory.h  

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. NiagaraParameterMapHistory.h  

uint32 BeginNodeVisitation ( const FNode* Node
)

   NiagaraParameterMapHistory.h  

void ConditionalUpdateAliasedVariable ( int32 VariableIndex,
const FNiagaraVariableBase& InAliasedVar
)

   NiagaraParameterMapHistory.h  

void EndNodeVisitation ( uint32 IndexFromBeginNode
)

   NiagaraParameterMapHistory.h  

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

 Find a variable by both name and type. NiagaraParameterMapHistory.h  

int32 FindVariableByName ( const FName& VariableName,
bool bAllowPartialMatch
) const

 Find a variable by name with no concern for type. NiagaraParameterMapHistory.h  

const FInputPin * GetDefaultValuePin ( int32 VarIdx
) const

 Get the default value for this variable. NiagaraParameterMapHistory.h  

const FOutputNode * GetFinalOutputNode()

 Get the output node associated with this graph. NiagaraParameterMapHistory.h  

const FPin * GetFinalPin()

 Get the output pin that we traced to build this history object. NiagaraParameterMapHistory.h  

const FPin * GetOriginalPin()

 Get the pin that added the parameter map to the graph. NiagaraParameterMapHistory.h  

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

 Called to determine if a given variable should be output from a script. NiagaraParameterMapHistory.h  

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

   NiagaraParameterMapHistory.h  

bool IsVariableFromCustomIterationNamespaceOverride ( const FNiagaraVariable& InVar
) const

   NiagaraParameterMapHistory.h  

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

   NiagaraParameterMapHistory.h  

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

   NiagaraParameterMapHistory.h  

int32 RegisterParameterMapPin ( const FPin* Pin
)

 Called in a depth-first traversal to identify a given Niagara Parameter Map pin that was touched during traversal. NiagaraParameterMapHistory.h  

bool ShouldIgnoreVariableDefault ( const FNiagaraVariable& Var
) const

   NiagaraParameterMapHistory.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page