Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > FNiagaraParameterMapHistoryBuilder

Light Theme

Dark Theme

FNiagaraParameterMapHistoryBuilder

Windows

MacOS

Linux

Inheritance Hierarchy

FNiagaraParameterMapHistoryWithMetaDataBuilder

References

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

Syntax

class FNiagaraParameterMapHistoryBuilder

Variables

	Name	Description
TMap< FString, ...	AliasMap	Resolved alias map for the current context level. Rebuilt by BuildCurrentAliases.
bool	bFilterByScriptWhitelist	Whether or not the script whitelist is active.
bool	bIgnoreDisabled	Whether or not to ignore disabled nodes.
bool	bShouldBuildSubHistories
TArray< const U...	CallingContext	Contains the hierarchy of nodes leading to the current graph being processed.
TArray< const U...	CallingGraphContext	Contains the hierarchy of graphs leading to and including the current graph being processed.
FCompileConstan...	ConstantResolver
TArray< TArray<...	ContextuallyVisitedNodes	List of previously visited nodes per context.
TArray< FName >	EmitterNameContextStack	Contains the hierarchy of emitter node names leading to the current graph being processed.
TArray< FNiagar...	EncounterableExternalVariables
TArray< FString...	EncounteredEmitterNames
TArray< TArray<...	EncounteredFunctionNames
ENiagaraScriptU...	FilterScriptType	What the script type is that we should be filtering to if the whitelist is enabled.
TArray< FName >	FunctionNameContextStack	Contains the hierarchy of function call node names leading to the current graph being processed.
TArray< FNiagar...	Histories	Collection of the build histories from the graph traversal.
TArray< TMap< c...	PinToParameterMapIndices	Tracker for each context level of the parameter map index associated with a given pin.
TArray< ENiagar...	RelevantScriptUsageContext	Keeps track of the script usage at the current context level.
TArray< FName >	ScriptUsageContextNameStack
TMap< FString, ...	StartOnlyAliasMap

Constructors

	Name	Description
	FNiagaraParameterMapHistoryBuilder()	Constructor

Destructors

	Name	Description
	~FNiagaraParameterMapHistoryBuilder()

Functions

	Name	Description
int32	AddVariableToHistory ( FNiagaraParameterMapHistory& Histo..., const FNiagaraVariable& InVar, const FNiagaraVariable& InAliasedV..., const UEdGraphPin* InPin )	Virtual wrapper to call correct AddVariable method on the target ParameterMapHistory.
uint32	BeginNodeVisitation ( int32 WhichParameterMap, const UNiagaraNode* Node )
void	BeginTranslation ( const UNiagaraEmitter* Emitter )
void	BeginTranslation ( const FString& EmitterUniqueName )
void	BeginTranslation ( const UNiagaraScript* Script )
void	BeginUsage ( ENiagaraScriptUsage InUsage, FName InStageName )
void	BuildCurrentAliases()	Generate the internal alias map from the current traversal state.
void	BuildParameterMaps ( const UNiagaraNodeOutput* Outp..., bool bRecursive )	Called in order to set up the correct initial context for an Output node and invokes the UNiagaraNodeOutput's BuildParameterMapHistory method.
bool	ContextContains ( ENiagaraScriptUsage InUsage )
int32	CreateParameterMap()	Add a new parameter map to the array.
void	EnableScriptWhitelist ( bool bInEnable, ENiagaraScriptUsage InScriptType )	In some cases, we don't want all the variables encountered in a traversal.
void	EndNodeVisitation ( int32 WhichParameterMap, uint32 IndexFromBeginNode )
void	EndTranslation ( const UNiagaraScript* Script )
void	EndTranslation ( const FString& EmitterUniqueName )
void	EndTranslation ( const UNiagaraEmitter* Emitter )
void	EndUsage()
void	EnterEmitter ( const FString& InEmitterName, const UNiagaraGraph* InGraph, const UNiagaraNode* Node )	Record that we have entered an emitter scope.
void	EnterFunction ( const FString& InNodeName, const UNiagaraScript* InScript, const UNiagaraGraph* InGraph, const UNiagaraNode* Node )	Record that we have entered a new function scope.
void	ExitEmitter ( const FString& InEmitterName, const UNiagaraNode* Node )	Record that we have exited an emitter scope.
void	ExitFunction ( const FString& InNodeName, const UNiagaraScript* InScript, const UNiagaraNode* Node )	Record that we have exited a function scope.
int32	FindMatchingParameterMapFromContextInputs ( const FNiagaraVariable& InVar )	Helper method to identify any matching input nodes from the calling context node to the input variable.
ENiagaraScri...	GetBaseUsageContext()
const UNiaga...	GetCallingContext()	Get the node calling this sub-graph.
ENiagaraScri...	GetCurrentUsageContext()
const FStrin...	GetEmitterAlias()	Get the string that the "Emitter" namespace maps to currently (if it exists)
const TArray...	GetEncounterableVariables()
bool	GetIgnoreDisabled()
const FStrin...	GetModuleAlias()	Get the string that the "Module" namespace maps to currently (if it exists)
bool	GetNodePreviouslyVisited ( const UNiagaraNode* Node )	Has RegisterNodeVisitation been called on the input node yet?
bool	GetPinPreviouslyVisited ( const UEdGraphPin* InPin )	Has RegisterNodeVisitation been called yet on the owning node of this pin?
int32	HandleExternalVariableRead ( int32 ParamMapIdx, const FName& InVarName )
int32	HandleVariableRead ( int32 ParameterMapIndex, const UEdGraphPin* InPin, bool RegisterReadsAsVariables, const UEdGraphPin* InDefaultPi..., bool bFilterForCompilation, bool& OutUsedDefault )	Record that a pin reads from the parameter map.
int32	HandleVariableWrite ( int32 ParameterMapIndex, const FNiagaraVariable& Var )	Record that a variable write to the parameter map.
int32	HandleVariableWrite ( int32 ParameterMapIndex, const UEdGraphPin* InPin )	Record that a pin writes to the parameter map.
bool	HasCurrentUsageContext()
bool	InTopLevelFunctionCall ( ENiagaraScriptUsage InFilterScriptT... )	Are we currently in a top-level function call context (ie a node in the main graph or an argument into a function for the main graph.)
bool	IsInEncounteredEmitterNamespace ( FNiagaraVariable& InVar )
bool	IsInEncounteredFunctionNamespace ( FNiagaraVariable& InVar )
bool	IsNamespacedVariableRelevantToScriptType ( const FNiagaraVariable& InVar, ENiagaraScriptUsage ScriptType )	Helper method used to take in input script type and determine if the passed in namespaced variable is worth tracking.
void	RegisterEncounterableVariables ( const TArray< FNiagaraVariable >& ... )	Register any user or other external variables that could possibly be encountered but may not be declared explicitly.
void	RegisterNodeVisitation ( const UEdGraphNode* Node )	Called first during a node's visitation during traversal to identify that a node has been visited.
int32	RegisterParameterMapPin ( int32 WhichParameterMap, const UEdGraphPin* Pin )	Important.
FNiagaraVari...	ResolveAliases ( const FNiagaraVariable& InVar )	Use the current alias map to resolve any aliases in this input variable name.
void	SetIgnoreDisabled ( bool bInIgnore )
bool	ShouldTrackVariable ( const FNiagaraVariable& InVar )	Helper function called when variables are added to enable the filtering specified in EnableScriptWhitelist.
int32	TraceParameterMapOutputPin ( const UEdGraphPin* OutputPin )	Trace back a pin to whom it was connected to to find the current parameter map to use.
void	VisitInputPin ( const UEdGraphPin* Pin, const UNiagaraNode*, bool bFilterForCompilation )	If we haven't already visited the owning node, do so.
void	VisitInputPins ( const UNiagaraNode*, bool bFilterForCompilation )	If we haven't already visited the owning nodes, do so.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss