FNiagaraUserRedirectionParameterStore | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/Niagara

Extension of the base parameter store to allow the user in the editor to use variable names without the "User." namespace prefix. The names without the prefix just redirect to the original variables, it is just done for better usability.


Name	FNiagaraUserRedirectionParameterStore
Type	struct
Header File	/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraUserRedirectionParameterStore.h
Include Path	#include "NiagaraUserRedirectionParameterStore.h"

Syntax

USTRUCT ()  
struct FNiagaraUserRedirectionParameterStore : public FNiagaraParameterStore

Inheritance Hierarchy

FNiagaraParameterStore → FNiagaraUserRedirectionParameterStore

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FNiagaraUserRedirectionParameterStore ()		NiagaraUserRedirectionParameterStore.h
FNiagaraUserRedirectionParameterStore ( const FNiagaraParameterStore& Other )		NiagaraUserRedirectionParameterStore.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FNiagaraUserRedirectionParameterStore()		NiagaraUserRedirectionParameterStore.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
UserParameterRedirects	TMap< FNiagaraVariable, FNiagaraVariable >	Map from the variables with shortened display names to the original variables with the full namespace	NiagaraUserRedirectionParameterStore.h

Functions

Public

Name	Remarks	Include Path
void GetUserParameters ( TArray< FNiagaraVariable >& OutParameters ) const	Get the list of FNiagaraVariables that are exposed to the user.	NiagaraUserRedirectionParameterStore.h
void RecreateRedirections()		NiagaraUserRedirectionParameterStore.h
bool RedirectUserVariable ( FNiagaraVariableBase& UserVar ) const	If necessary it will replace the supplied variable with the fully qualified namespace (User.) appropriate for a user variable.	NiagaraUserRedirectionParameterStore.h
bool SerializeFromMismatchedTag ( const FPropertyTag& Tag, FStructuredArchive::FSlot Slot )	Used to upgrade a serialized FNiagaraParameterStore property to our own struct	NiagaraUserRedirectionParameterStore.h

Overridden from FNiagaraParameterStore

Name	Remarks	Include Path
virtual bool AddParameter ( const FNiagaraVariable& Param, bool bInitialize, bool bTriggerRebind, int32* OutOffset )	Adds the passed parameter to this store.	NiagaraUserRedirectionParameterStore.h
virtual void ConvertParameterType ( const FNiagaraVariable& ExistingParam, const FNiagaraTypeDefinition& NewType )		NiagaraUserRedirectionParameterStore.h
virtual void Empty ( bool bClearBindings )	Removes all parameters from this store and releases any data.	NiagaraUserRedirectionParameterStore.h
virtual const int32 * FindParameterOffset ( const FNiagaraVariableBase& Parameter, bool IgnoreType ) const		NiagaraUserRedirectionParameterStore.h
virtual const FNiagaraVariableWithOffset * FindParameterVariable ( const FNiagaraVariable& Parameter, bool IgnoreType ) const		NiagaraUserRedirectionParameterStore.h
virtual const FVector * GetPositionParameterValue ( const FName& ParamName ) const		NiagaraUserRedirectionParameterStore.h
virtual void InitFromSource ( const FNiagaraParameterStore* SrcStore, bool bNotifyAsDirty )	Called to initially set up the parameter store to exactly match the input store (other than any bindings and the internal name of it).	NiagaraUserRedirectionParameterStore.h
virtual bool RemoveParameter ( const FNiagaraVariableBase& Param )	Removes the passed parameter if it exists in the store.	NiagaraUserRedirectionParameterStore.h
virtual void Reset ( bool bClearBindings )	Removes all parameters from this store but doesn't change memory allocations.	NiagaraUserRedirectionParameterStore.h
virtual void SanityCheckData ( bool bInitInterfaces )		NiagaraUserRedirectionParameterStore.h
virtual bool SetPositionParameterValue ( const FVector& InValue, const FName& ParamName, bool bAdd )		NiagaraUserRedirectionParameterStore.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static bool IsUserParameter ( const FNiagaraVariableBase& InVar )		NiagaraUserRedirectionParameterStore.h
static void MakeUserVariable ( FNiagaraVariableBase& InVar )	Turn the input NiagaraVariable into the User namespaced version if needed, independent of whether or not it is in a redirection table.	NiagaraUserRedirectionParameterStore.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FNiagaraUserRedirectionParameterStore & operator= ( const FNiagaraParameterStore& Other )		NiagaraUserRedirectionParameterStore.h

Navigation