1. Epic GamesDeveloper
  3. FNiagaraParameterStore

FNiagaraParameterStore

Base storage class for Niagara parameter values.

API > API/Plugins > API/Plugins/Niagara

Base storage class for Niagara parameter values.

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

Syntax

USTRUCT ()  
struct FNiagaraParameterStore

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  NiagaraParameterStore.h  
  NiagaraParameterStore.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FNiagaraParameterStore()

   NiagaraParameterStore.h  

Structs

Name Remarks
FScopedSuppressOnChanged  

Enums

Public

Name Remarks
EDataInterfaceCopyMethod  

Typedefs

Name Type Remarks Include Path
BindingPair TPair< FNiagaraParameterStore *, FNiagaraParameterStoreBinding > Bindings between this parameter store and others we push data into when we tick. NiagaraParameterStore.h
FOnChanged TMulticastDelegate_NoParams< void >   NiagaraParameterStore.h
FOnParameterRenamed TMulticastDelegate_TwoParams< void, FNiagaraVariable OldVariable, FName NewName >   NiagaraParameterStore.h
FOnStructureChanged TMulticastDelegate_NoParams< void >   NiagaraParameterStore.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DebugName FString   NiagaraParameterStore.h
  • Transient
ParameterGuidMapping TMap< FNiagaraVariable, FGuid > Guid data to remap rapid iteration parameters after a function input was renamed. NiagaraParameterStore.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Bindings TArray< BindingPair >   NiagaraParameterStore.h  
bInterfacesDirty uint32 Marks our interfaces as dirty. They will be pushed to any bound stores on tick if true. NiagaraParameterStore.h  
bParametersDirty uint32 Marks our parameters as dirty. They will be pushed to any bound stores on tick if true. NiagaraParameterStore.h  
bPositionDataDirty uint32   NiagaraParameterStore.h  
bSuppressOnChanged bool   NiagaraParameterStore.h  
bUObjectsDirty uint32 Marks our UObjects as dirty. They will be pushed to any bound stores on tick if true. NiagaraParameterStore.h  
DataInterfaces TArray< TObjectPtr< UNiagaraDataInterface > > Data interfaces for this script. NiagaraParameterStore.h  
LayoutVersion uint32 Uniquely identifies the current layout of this parameter store for detecting layout changes. NiagaraParameterStore.h  
OnChangedDelegate FOnChanged   NiagaraParameterStore.h  
OnParameterRenamedDelegate FOnParameterRenamed   NiagaraParameterStore.h  
OnStructureChangedDelegate FOnStructureChanged   NiagaraParameterStore.h  
OriginalPositionData TArray< FNiagaraPositionSource > Holds position type source data to be later converted to LWC format. NiagaraParameterStore.h  
Owner TWeakObjectPtr< UObject > Owner of this store. Used to provide an outer to data interfaces in this store. NiagaraParameterStore.h
  • Transient
ParameterData TArray< uint8 > Buffer containing parameter data. Indexed using offsets in ParameterOffsets NiagaraParameterStore.h  
ParameterOffsets TMap< FNiagaraVariable, int32 > Map from parameter defs to their offset in the data table or the data interface. NiagaraParameterStore.h
  • Meta=(DeprecatedProperty)
SortedParameterOffsets TArray< FNiagaraVariableWithOffset > Storage for the set of variables that are represented by this ParameterStore. NiagaraParameterStore.h  
SourceStores TArray< FNiagaraParameterStore * > Parameter stores we've been bound to and are feeding data into us. NiagaraParameterStore.h  
UObjects TArray< TObjectPtr< UObject > > UObjects referenced by this store. Also indexed by ParameterOffsets. NiagaraParameterStore.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddConstantBuffer()

   NiagaraParameterStore.h  

FDelegateHandle AddOnChangedHandler ( FOnChanged::FDelegate InOnChanged
)

   NiagaraParameterStore.h  

virtual bool AddParameter ( const FNiagaraVariable& Param,
bool bInitialize,
bool bTriggerRebind,
int32* OutOffset
)

 Adds the passed parameter to this store. NiagaraParameterStore.h  

void Bind ( FNiagaraParameterStore* DestStore,
const FNiagaraBoundParameterArray* BoundParameters
)

 Binds this parameter store to another, by default if we find no matching parameters we will not maintain a pointer to the store. NiagaraParameterStore.h  

virtual void ChangeParameterType ( const FNiagaraVariableBase& Param,
const FNiagaraTypeDefinition& NewType
)

 Changes the type of the passed parameter. NiagaraParameterStore.h  

void CheckForNaNs()

   NiagaraParameterStore.h  

virtual void ConvertParameterType ( const FNiagaraVariable& ExistingParam,
const FNiagaraTypeDefinition& NewType
)

   NiagaraParameterStore.h  

void CopyParameterData ( FNiagaraParameterStore& DestStore,
const FNiagaraVariable& SourceParameter,
const FNiagaraVariable& TargetParameter
) const

   NiagaraParameterStore.h  

void CopyParameterData ( FNiagaraParameterStore& DestStore,
const FNiagaraVariable& Parameter
) const

 Copies the passed parameter from this parameter store into another. NiagaraParameterStore.h  

bool CopyParameterData ( const FNiagaraVariable& Parameter,
uint8* DestinationData
) const

 Copies the data stored for the given variable to the target pointer. NiagaraParameterStore.h  

void CopyParametersTo ( FNiagaraParameterStore& DestStore,
bool bOnlyAdd,
EDataInterfaceCopyMethod DataInterfaceCopyMethod
) const

 Copies all parameters from this parameter store into another. NiagaraParameterStore.h  

void Dump()

   NiagaraParameterStore.h  

void DumpParameters ( bool bDumpBindings
) const

   NiagaraParameterStore.h  

virtual void Empty ( bool bClearBindings
)

 Removes all parameters from this store and releases any data. NiagaraParameterStore.h  

virtual const int32 * FindParameterOffset ( const FNiagaraVariableBase& Parameter,
bool IgnoreType
) const

   NiagaraParameterStore.h  

virtual const FNiagaraVariableWithOffset * FindParameterVariable ( const FNiagaraVariable& Parameter,
bool IgnoreType
) const

   NiagaraParameterStore.h  

const FNiagaraVariableBase * FindVariable ( const UNiagaraDataInterface* Interface
) const

   NiagaraParameterStore.h  
Returns the associated FNiagaraVariable for the passed data interface if it exists in the store. NiagaraParameterStore.h  

const FNiagaraVariableBase * FindVariableFromDataInterfaceIndex ( int32 DataInterfaceIndex
) const

 Returns the associated FNiagaraVariable for the passed data interface index if it exists in the store. NiagaraParameterStore.h  

UNiagaraDataInterface * GetDataInterface ( int32 Offset
) const

 Returns the data interface at the passed offset. NiagaraParameterStore.h  
Returns the data interface for the passed parameter if it exists in this store. NiagaraParameterStore.h  

const TArray< UNiagaraDataInterface * > & GetDataInterfaces()

   NiagaraParameterStore.h  

bool GetInterfacesDirty()

   NiagaraParameterStore.h  

uint32 GetLayoutVersion()

   NiagaraParameterStore.h  

uint8 * GetMutableParameterData ( int32 Offset,
const FNiagaraTypeDefinition& TypeDef
)

 Returns a none const pointer to the parameter data, any modifications to the data will not be recorded and automatically pushed to other parameter stores, use with caution. NiagaraParameterStore.h  

UObject * GetOwner()

   NiagaraParameterStore.h  

const uint8 * GetParameterData ( int32 Offset,
const FNiagaraTypeDefinition& TypeDef
) const

   NiagaraParameterStore.h  

const uint8 * GetParameterData ( int32 Offset,
int32 SizeInBytes
) const

   NiagaraParameterStore.h  

const uint8 * GetParameterData ( const FNiagaraVariableWithOffset& Parameter
) const

   NiagaraParameterStore.h  

const uint8 * GetParameterData ( const FNiagaraVariableBase& Parameter
) const

 Returns the parameter data for the passed parameter if it exists in this store. Null if not. NiagaraParameterStore.h  

const uint8 * GetParameterData ( int32 Offset
) const

   NiagaraParameterStore.h  

const TArray< uint8 > & GetParameterDataArray()

   NiagaraParameterStore.h  

TOptional< T > GetParameterOptionalValue ( const FNiagaraVariableBase& Parameter
) const

   NiagaraParameterStore.h  

void GetParameters ( TArray< FNiagaraVariable >& OutParameters
) const

   NiagaraParameterStore.h  

bool GetParametersDirty()

   NiagaraParameterStore.h  

void GetParameterValue ( T& OutValue,
const FNiagaraVariableBase& Parameter
) const

 Gets the typed parameter data. NiagaraParameterStore.h  

T GetParameterValue ( const FNiagaraVariableBase& Parameter
) const

   NiagaraParameterStore.h  

T GetParameterValueFromOffset ( int32 Offset
) const

   NiagaraParameterStore.h  

T GetParameterValueOrDefault ( const FNiagaraVariableBase& Parameter,
const T& DefaultValue
) const

   NiagaraParameterStore.h  

bool GetPositionDataDirty()

   NiagaraParameterStore.h  

virtual const FVector * GetPositionParameterValue ( const FName& ParamName
) const

   NiagaraParameterStore.h  

SIZE_T GetResourceSize()

   NiagaraParameterStore.h  

TArray< FNiagaraParameterStore * > & GetSourceParameterStores()

   NiagaraParameterStore.h  

FNiagaraLwcStructConverter GetStructConverter ( const FNiagaraVariable& Parameter
) const

 Returns a struct converter for the given variable, if the store contains the variable and it's a LWC type. NiagaraParameterStore.h  

TObjectPtr< UObject > GetUObject ( const FNiagaraVariable& Parameter
) const

   NiagaraParameterStore.h  

TObjectPtr< UObject > GetUObject ( int32 Offset
) const

 Returns the UObject at the passed offset. NiagaraParameterStore.h  

const TArray< TObjectPtr< UObject > > & GetUObjects()

   NiagaraParameterStore.h  

bool GetUObjectsDirty()

   NiagaraParameterStore.h  

int32 IndexOf ( const FNiagaraVariableBase& Parameter
) const

 Gets the index of the passed parameter. NiagaraParameterStore.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). NiagaraParameterStore.h  

bool IsEmpty()

   NiagaraParameterStore.h  

void MarkInterfacesDirty()

   NiagaraParameterStore.h  

void MarkParametersDirty()

   NiagaraParameterStore.h  

void MarkPositionDataDirty()

   NiagaraParameterStore.h  

void MarkUObjectsDirty()

   NiagaraParameterStore.h  

int32 Num()

   NiagaraParameterStore.h  

void OnInterfaceChange()

   NiagaraParameterStore.h  

void OnParameterChange()

   NiagaraParameterStore.h  

FOnParameterRenamed & OnParameterRenamed()

   NiagaraParameterStore.h  

FOnStructureChanged & OnStructureChanged()

   NiagaraParameterStore.h  

void OnUObjectChange()

   NiagaraParameterStore.h  

void PostGenericEditChange()

   NiagaraParameterStore.h  

void PostLoad ( UObject* InOwner
)

   NiagaraParameterStore.h  
The View of the set of variables represented by this ParameterStore. NiagaraParameterStore.h  

void Rebind()

 Recreates any bindings to reflect a layout change etc. NiagaraParameterStore.h  

void RemoveAllOnChangedHandlers ( FDelegateUserObjectConst InUserObject
)

   NiagaraParameterStore.h  

void RemoveOnChangedHandler ( FDelegateHandle DelegateHandle
)

   NiagaraParameterStore.h  

virtual bool RemoveParameter ( const FNiagaraVariableBase& Param
)

 Removes the passed parameter if it exists in the store. NiagaraParameterStore.h  

void RemoveParameters ( FNiagaraParameterStore& DestStore
)

 Remove all parameters from this parameter store from another. NiagaraParameterStore.h  

virtual void RenameParameter ( const FNiagaraVariableBase& Param,
FName NewName
)

 Renames the passed parameter. NiagaraParameterStore.h  

virtual void Reset ( bool bClearBindings
)

 Removes all parameters from this store but doesn't change memory allocations. NiagaraParameterStore.h  

void ResolvePositions ( FNiagaraLWCConverter LwcConverter
)

   NiagaraParameterStore.h  

virtual void SanityCheckData ( bool bInitInterfaces
)

   NiagaraParameterStore.h  

void SetDataInterface ( UNiagaraDataInterface* InInterface,
int32 Offset
)

   NiagaraParameterStore.h  

void SetDataInterface ( UNiagaraDataInterface* InInterface,
const FNiagaraVariable& Parameter
)

   NiagaraParameterStore.h  

void SetOwner ( UObject* InOwner
)

   NiagaraParameterStore.h  

bool SetParameterData ( const uint8* Data,
FNiagaraVariable Param,
bool bAdd
)

   NiagaraParameterStore.h  

void SetParameterData ( const uint8* Data,
int32 Offset,
int32 Size
)

   NiagaraParameterStore.h  

bool SetParameterValue ( const FQuat4d& InValue,
const FNiagaraVariable& Param,
bool bAdd
)

   NiagaraParameterStore.h  

bool SetParameterValue ( const FVector4d& InValue,
const FNiagaraVariable& Param,
bool bAdd
)

   NiagaraParameterStore.h  

bool SetParameterValue ( const FVector3d& InValue,
const FNiagaraVariable& Param,
bool bAdd
)

   NiagaraParameterStore.h  

bool SetParameterValue ( const T& InValue,
const FNiagaraVariable& Param,
bool bAdd
)

   NiagaraParameterStore.h  

virtual bool SetPositionParameterValue ( const FVector& InValue,
const FName& ParamName,
bool bAdd
)

   NiagaraParameterStore.h  

void SetUObject ( TObjectPtr< UObject > InObject,
int32 Offset
)

   NiagaraParameterStore.h  

void SetUObject ( TObjectPtr< UObject > InObject,
const FNiagaraVariable& Parameter
)

   NiagaraParameterStore.h  

void SortParameters()

   NiagaraParameterStore.h  

void Tick()

 Handles any update such as pushing parameters to bound stores etc. NiagaraParameterStore.h  

FString ToString()

   NiagaraParameterStore.h  

void TransferBindings ( FNiagaraParameterStore& OtherStore
)

 Recreates any bindings to reflect a layout change etc. NiagaraParameterStore.h  

void TriggerOnLayoutChanged()

   NiagaraParameterStore.h  

void Unbind ( FNiagaraParameterStore* DestStore
)

 Unbinds this store form one it's bound to. NiagaraParameterStore.h  

void UnbindAll()

 Unbinds this store from all source and destination stores. NiagaraParameterStore.h  

void UnbindFromSourceStores()

 Unbinds this store from all stores it's being driven by. NiagaraParameterStore.h  

bool VerifyBinding ( const FNiagaraParameterStore* InDestStore
) const

   NiagaraParameterStore.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AssignParameterData ( TConstArrayView< uint8 > SourceParameterData
)

   NiagaraParameterStore.h  

void CopySortedParameterOffsets ( TArrayView< const FNiagaraVariableWithOffset > Src
)

   NiagaraParameterStore.h  

uint8 * GetMutableParameterData_Internal ( int32 Offset
)

   NiagaraParameterStore.h  

const uint8 * GetParameterData_Internal ( int32 Offset
) const

   NiagaraParameterStore.h  

void OnLayoutChange()

   NiagaraParameterStore.h  

void SetDataInterfaces ( const TArray< UNiagaraDataInterface* >& InDataInterfaces,
bool bNotifyAsDirty
)

   NiagaraParameterStore.h  

void SetOriginalPositionData ( const TArray< FNiagaraPositionSource >& InOriginalPositionData
)

   NiagaraParameterStore.h  

void SetParameterByOffset ( uint32 ParamOffset,
const ParamType& Param
)

   NiagaraParameterStore.h  

void SetParameterDataArray ( const TArray< uint8 >& InParameterDataArray,
bool bNotifyAsDirty
)

   NiagaraParameterStore.h  

void SetUObjects ( const TArray< UObject* >& InUObjects,
bool bNotifyAsDirty
)

   NiagaraParameterStore.h  

void TickBindings()

   NiagaraParameterStore.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 PaddedParameterSize ( int32 ParameterSize
)

   NiagaraParameterStore.h  

Operators

Name Remarks Include Path Unreal Specifiers

FNiagaraParameterStore & operator= ( const FNiagaraParameterStore& Other
)

   NiagaraParameterStore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page