1. Epic GamesDeveloper
  3. FNiagaraParameterStore

FNiagaraParameterStore

Base storage class for Niagara parameter values.

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

USTRUCT ()  
struct FNiagaraParameterStore

Remarks

Base storage class for Niagara parameter values.

Variables

  Type Name Description
Public variable UProperty Transient FString DebugName  
Public variable UProperty TMap< FNiagaraVariable, FGuid > ParameterGuidMapping Guid data to remap rapid iteration parameters after a function input was renamed.

Constructors

  Type Name Description
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void  
Public function FDelegateHandle

AddOnChangedHandler ( FOnChanged::FDelegate InOnChanged
)

  
Public function Virtual bool

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

 Adds the passed parameter to this store.
Protected function void

AssignParameterData ( TConstArrayView< uint8 > SourceParameterData
)

  
Public function 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.
Public function Virtual void Changes the type of the passed parameter.
Public function Const void  
Public function Virtual void

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

  
Public function Const void

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

  
Public function Const void

CopyParameterData ( FNiagaraParameterStore& DestStore,
const FNiagaraVariable& Parameter
)

 Copies the passed parameter from this parameter store into another.
Public function Const bool

CopyParameterData ( const FNiagaraVariable& Parameter,
uint8* DestinationData
)

 Copies the data stored for the given variable to the target pointer.
Public function Const void

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

 Copies all parameters from this parameter store into another.
Protected function void  
Public function Const void

Dump ()

  
Public function Const void

DumpParameters ( bool bDumpBindings
)

  
Public function Virtual void

Empty ( bool bClearBindings
)

 Removes all parameters from this store and releases any data.
Public function Virtual Const const int32 *

FindParameterOffset ( const FNiagaraVariableBase& Parameter,
bool IgnoreType
)

  
Public function Virtual Const const FNiagaraVariableWithOffset *

FindParameterVariable ( const FNiagaraVariable& Parameter,
bool IgnoreType
)

  
Public function Const const FNiagaraVariableBase *

FindVariable ( const UNiagaraDataInterface* Interface
)

  
Public function Const const FNiagaraVariableBase * Returns the associated FNiagaraVariable for the passed data interface if it exists in the store.
Public function Const const FNiagaraVariableBase *

FindVariableFromDataInterfaceIndex ( int32 DataInterfaceIndex
)

 Returns the associated FNiagaraVariable for the passed data interface index if it exists in the store.
Public function Const UNiagaraDataInterface *

GetDataInterface ( const FNiagaraVariable& Parameter
)

 Returns the data interface for the passed parameter if it exists in this store.
Public function Const UNiagaraDataInterface *

GetDataInterface ( int32 Offset
)

 Returns the data interface at the passed offset.
Public function Const const TArray< UNiagaraDataInterface * > &  
Public function Const bool  
Public function Const uint32  
Public function Const UObject *  
Public function Const FORCEINLINE_DEBUGGABLE const uint8 *

GetParameterData ( const FNiagaraVariableBase& Parameter
)

 Returns the parameter data for the passed parameter if it exists in this store. Null if not.
Public function Const const uint8 *

GetParameterData ( int32 Offset
)

  
Protected function uint8 * Returns the parameter data at the passed offset.
Public function Const const TArray< uint8 > &  
Public function Const FORCEINLINE_DEBUGGABLETOptional< T >  
Public function Const void

GetParameters ( TArray< FNiagaraVariable >& OutParameters
)

  
Public function Const bool  
Public function Const FORCEINLINE_DEBUGGABLE T  
Public function Const FORCEINLINE_DEBUGGABLE void

GetParameterValue ( T& OutValue,
const FNiagaraVariableBase& Parameter
)

 Gets the typed parameter data.
Public function Const FORCEINLINE_DEBUGGABLE T

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

  
Public function Const bool  
Public function Virtual Const const FVector *

GetPositionParameterValue ( const FName& ParamName
)

  
Public function Const SIZE_T  
Public function TArray< FNiagaraParameterStore * > &  
Public function Const FNiagaraLwcStructConverter

GetStructConverter ( const FNiagaraVariable& Parameter
)

 Returns a struct converter for the given variable, if the store contains the variable and it's a LWC type.
Public function Const UObject *

GetUObject ( const FNiagaraVariable& Parameter
)

  
Public function Const UObject *

GetUObject ( int32 Offset
)

 Returns the UObject at the passed offset.
Public function Const const TArray< UObject * > &  
Public function Const bool  
Public function Const FORCEINLINE_DEBUGGABLEint32

IndexOf ( const FNiagaraVariableBase& Parameter
)

 Gets the index of the passed parameter.
Public function 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).
Public function Const bool

IsEmpty ()

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function Const int32

Num ()

  
Public function void  
Protected function void  
Public function void  
Public function FOnParameterRenamed &  
Public function FOnStructureChanged &  
Public function void  
Protected function Static int32

PaddedParameterSize ( int32 ParameterSize
)

  
Public function void  
Public function void

PostLoad ( UObject* InOwner
)

  
Public function Virtual Const TArrayView< const FNiagaraVariableWithOffset > The View of the set of variables represented by this ParameterStore.
Public function void

Rebind ()

 Recreates any bindings to reflect a layout change etc.
Public function void

RemoveAllOnChangedHandlers ( const void* InUserObject
)

  
Public function void  
Public function Virtual bool Removes the passed parameter if it exists in the store.
Public function void Remove all parameters from this parameter store from another.
Public function Virtual void

RenameParameter ( const FNiagaraVariableBase& Param,
FName NewName
)

 Renames the passed parameter.
Public function Virtual void

Reset ( bool bClearBindings
)

 Removes all parameters from this store but doesn't change memory allocations.
Public function void  
Public function Virtual void

SanityCheckData ( bool bInitInterfaces
)

  
Public function FORCEINLINE_DEBUGGABLE void

SetDataInterface ( UNiagaraDataInterface* InInterface,
const FNiagaraVariable& Parameter
)

  
Public function FORCEINLINE_DEBUGGABLE void

SetDataInterface ( UNiagaraDataInterface* InInterface,
int32 Offset
)

  
Protected function void

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

  
Protected function void

SetOriginalPositionData ( const TArray< FNiagaraPositionSource >& InOriginalPositionData
)

  
Public function void

SetOwner ( UObject* InOwner
)

  
Protected function void

SetParameterByOffset ( uint32 ParamOffset,
const ParamType& Param
)

  
Public function bool

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

  
Public function FORCEINLINE_DEBUGGABLE void

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

  
Protected function void

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

  
Public function bool

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

  
Public function bool

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

  
Public function bool

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

  
Public function FORCEINLINE_DEBUGGABLE bool

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

  
Public function Virtual bool

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

  
Public function FORCEINLINE_DEBUGGABLE void

SetUObject ( UObject* InObject,
int32 Offset
)

  
Public function FORCEINLINE_DEBUGGABLE void

SetUObject ( UObject* InObject,
const FNiagaraVariable& Parameter
)

  
Protected function void

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

  
Public function void  
Public function void

Tick ()

 Handles any update such as pushing parameters to bound stores etc.
Protected function Const void  
Public function Const FString  
Public function void Recreates any bindings to reflect a layout change etc.
Public function void  
Public function void Unbinds this store form one it's bound to.
Public function void Unbinds this store from all source and destination stores.
Public function void Unbinds this store from all stores it's being driven by.
Public function Const bool

VerifyBinding ( const FNiagaraParameterStore* InDestStore
)

  

Operators

  Type Name Description
Public function FNiagaraParameterStore &  

Classes

  Type Name Description
Public struct FScopedSuppressOnChanged    

Enums

  Type Name Description
Public enum EDataInterfaceCopyMethod    

Typedefs

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page