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 > Niagara > FNiagaraParameterStore

Light Theme

Dark Theme

FNiagaraParameterStore

Base storage class for Niagara parameter values.

Windows

MacOS

Linux

Inheritance Hierarchy

FNiagaraParameterStore

	FNiagaraScriptExecutionParameterStore
	FNiagaraScriptInstanceParameterStore
	FNiagaraUserRedirectionParameterStore

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNiagaraParameterStore

Remarks

Base storage class for Niagara parameter values.

Variables

		Name	Description
	FString	DebugName
	TMap< FNiagaraV...	ParameterGuidMapping	Guid data to remap rapid iteration parameters after a function input was renamed.

Constructors

	Name	Description
	FNiagaraParameterStore()
	FNiagaraParameterStore ( const FNiagaraParameterStore& Othe... )

Destructors

	Name	Description
	~FNiagaraParameterStore()

Functions

	Name	Description
void	AddConstantBuffer()
FDelegateHan...	AddOnChangedHandler ( FOnChanged::FDelegate InOnChanged )
bool	AddParameter ( const FNiagaraVariable& Param, bool bInitialize, bool bTriggerRebind, int32* OutOffset )	Adds the passed parameter to this store.
void	AssignParameterData ( TConstArrayView< uint8 > SourcePara... )
void	Bind ( FNiagaraParameterStore* DestSt..., const FNiagaraBoundParameterArray&... )	Binds this parameter store to another, by default if we find no matching parameters we will not maintain a pointer to the store.
void	CheckForNaNs()
void	CopyParameterData ( FNiagaraParameterStore& DestStore, const FNiagaraVariable& Parameter )	Copies the passed parameter from this parameter store into another.
void	CopyParametersTo ( FNiagaraParameterStore& DestStore, bool bOnlyAdd, EDataInterfaceCopyMethod DataInterf... )	Copies all parameters from this parameter store into another.
void	CopySortedParameterOffsets ( TArrayView< const FNiagaraVariableW... )
void	Dump()
void	DumpParameters ( bool bDumpBindings )
void	Empty ( bool bClearBindings )	Removes all parameters from this store and releases any data.
const int32 ...	FindParameterOffset ( const FNiagaraVariableBase& Parame..., bool IgnoreType )
const FNiaga...	FindVariable ( const UNiagaraDataInterface* I... )	Returns the associated FNiagaraVariable for the passed data interface if it exists in the store.
UNiagaraData...	GetDataInterface ( const FNiagaraVariable& Parameter )	Returns the data interface for the passed parameter if it exists in this store.
UNiagaraData...	GetDataInterface ( int32 Offset )	Returns the data interface at the passed offset.
const TArray...	GetDataInterfaces()
uint32	GetInterfacesDirty()
uint32	GetLayoutVersion()
UObject *...	GetOwner()
const uint8 ...	GetParameterData ( int32 Offset )
const uint8 ...	GetParameterData ( const FNiagaraVariable& Parameter )	Returns the parameter data for the passed parameter if it exists in this store. Null if not.
uint8 *	GetParameterData_Internal ( int32 Offset )	Returns the parameter data at the passed offset.
const TArray...	GetParameterDataArray()
void	GetParameters ( TArray< FNiagaraVariable >& OutPar... )
uint32	GetParametersDirty()
T	GetParameterValue ( const FNiagaraVariable& Parameter )
void	GetParameterValue ( T& OutValue, const FNiagaraVariable& Parameter )	Gets the typed parameter data.
TArray< FNia...	GetSourceParameterStores()
UObject *...	GetUObject ( int32 Offset )	Returns the UObject at the passed offset.
UObject *...	GetUObject ( const FNiagaraVariable& Parameter )
const TArray...	GetUObjects()
uint32	GetUObjectsDirty()
int32	IndexOf ( const FNiagaraVariable& Parameter )	Gets the index of the passed parameter.
void	InitFromSource ( const FNiagaraParameterStore* ..., 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).
bool	IsEmpty()
void	MarkInterfacesDirty()
void	MarkParametersDirty()
void	MarkUObjectsDirty()
int32	Num()
void	OnInterfaceChange()
void	OnLayoutChange()
void	OnParameterChange()
void	OnUObjectChange()
int32	PaddedParameterSize ( int32 ParameterSize )
void	PostGenericEditChange()
void	PostLoad()
TArrayView< ...	ReadParameterVariables()	The View of the set of variables represented by this ParameterStore.
void	Rebind()	Recreates any bindings to reflect a layout change etc.
void	RemoveAllOnChangedHandlers ( const void* InUserObject )
void	RemoveOnChangedHandler ( FDelegateHandle DelegateHandle )
bool	RemoveParameter ( const FNiagaraVariableBase& Param )	Removes the passed parameter if it exists in the store.
void	RemoveParameters ( FNiagaraParameterStore& DestStore )	Remove all parameters from this parameter store from another.
void	RenameParameter ( const FNiagaraVariableBase& Param, FName NewName )	Renames the passed parameter.
void	Reset ( bool bClearBindings )	Removes all parameters from this store but doesn't change memory allocations.
void	SanityCheckData ( bool bInitInterfaces )
void	SetDataInterface ( UNiagaraDataInterface* InInter..., const FNiagaraVariable& Parameter )
void	SetDataInterface ( UNiagaraDataInterface* InInter..., int32 Offset )
void	SetDataInterfaces ( const TArray< UNiagaraDataInterface..., bool bNotifyAsDirty )
void	SetOwner ( UObject* InOwner )
void	SetParameterByOffset ( uint32 ParamOffset, const ParamType& Param )
bool	SetParameterData ( const uint8* Data, const FNiagaraVariable& Param, bool bAdd )
void	SetParameterData ( const uint8* Data, int32 Offset, int32 Size )
void	SetParameterDataArray ( const TArray< uint8 >& InParameter..., bool bNotifyAsDirty )
void	SetParameterDataTyped ( const uint8* Data, int32 Offset )
bool	SetParameterValue ( const T& InValue, const FNiagaraVariable& Param, bool bAdd )
void	SetUObject ( UObject* InObject, const FNiagaraVariable& Parameter )
void	SetUObject ( UObject* InObject, int32 Offset )
void	SetUObjects ( const TArray< UObject* >& InU..., bool bNotifyAsDirty )
void	SortParameters()
void	Tick()	Handles any update such as pushing parameters to bound stores etc.
void	TickBindings()
FString	ToString()
void	TransferBindings ( FNiagaraParameterStore& OtherStore )	Recreates any bindings to reflect a layout change etc.
void	TriggerOnLayoutChanged()
void	Unbind ( FNiagaraParameterStore* DestSt... )	Unbinds this store form one it's bound to.
void	UnbindAll()	Unbinds this store from all source and destination stores.
void	UnbindFromSourceStores()	Unbinds this store from all stores it's being driven by.
bool	VerifyBinding ( const FNiagaraParameterStore* ... )

Operators

		Name	Description
	FNiagaraPara...	operator= ( const FNiagaraParameterStore& Othe... )

Enums

	Name	Description
	EDataInterfaceCopyMethod

Typedefs

Name	Description
BindingPair	Bindings between this parameter store and others we push data into when we tick.
FOnChanged

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

Take our survey

Dismiss