Navigation
Unreal Engine C++ API Reference > Plugins > Niagara
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&40;&41;
struct FNiagaraParameterStore
Remarks
Base storage class for Niagara parameter values.
Variables
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
FString | DebugName | |
![]() ![]() |
TMap< FNiagaraVariable, FGuid > | ParameterGuidMapping | Guid data to remap rapid iteration parameters after a function input was renamed. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
|||
![]() |
FNiagaraParameterStore
(
const FNiagaraParameterStore& Other |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | ||
![]() |
FDelegateHandle | AddOnChangedHandler
(
FOnChanged::FDelegate InOnChanged |
|
![]() ![]() |
bool | AddParameter
(
const FNiagaraVariable& Param, |
Adds the passed parameter to this store. |
![]() |
void | AssignParameterData
(
TConstArrayView< uint8 > SourceParameterData |
|
![]() |
void | Bind
(
FNiagaraParameterStore* DestStore, |
Binds this parameter store to another, by default if we find no matching parameters we will not maintain a pointer to the store. |
![]() ![]() |
void | ChangeParameterType
(
const FNiagaraVariableBase& Param, |
Changes the type of the passed parameter. |
![]() ![]() |
void | CheckForNaNs () |
|
![]() ![]() |
void | ConvertParameterType
(
const FNiagaraVariable& ExistingParam, |
|
![]() ![]() |
void | CopyParameterData
(
FNiagaraParameterStore& DestStore, |
Copies the data stored for the given variable to the target pointer. |
![]() ![]() |
void | CopyParameterData
(
FNiagaraParameterStore& DestStore, |
Copies the passed parameter from this parameter store into another. |
![]() ![]() |
bool | CopyParameterData
(
const FNiagaraVariable& Parameter, |
Copies the data stored for the given variable to the target pointer. |
![]() ![]() |
void | CopyParametersTo
(
FNiagaraParameterStore& DestStore, |
Copies all parameters from this parameter store into another. |
![]() |
void | CopySortedParameterOffsets
(
TArrayView< const FNiagaraVariableWithOffset > Src |
|
![]() ![]() |
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& Parameter, |
|
![]() ![]() ![]() |
const FNiagaraVariableWithOffset * | FindParameterVariable
(
const FNiagaraVariable& Parameter, |
|
![]() ![]() |
const FNiagaraVariableBase * | FindVariable
(
const UNiagaraDataInterface* Interface |
Returns the associated FNiagaraVariable for the passed data interface if it exists in the store. |
![]() ![]() |
UNiagaraDataInterface * | GetDataInterface
(
const FNiagaraVariable& Parameter |
Returns the data interface for the passed parameter if it exists in this store. |
![]() ![]() |
UNiagaraDataInterface * | GetDataInterface
(
int32 Offset |
Returns the data interface at the passed offset. |
![]() ![]() |
const TArray< UNiagaraDataInterface * > & | ||
![]() ![]() |
bool | ||
![]() ![]() |
uint32 | ||
![]() ![]() |
UObject * | GetOwner () |
|
![]() ![]() |
const uint8 * | GetParameterData
(
const FNiagaraVariableBase& Parameter |
Returns the parameter data for the passed parameter if it exists in this store. Null if not. |
![]() ![]() |
const uint8 * | GetParameterData
(
int32 Offset |
|
![]() |
uint8 * | GetParameterData_Internal
(
int32 Offset |
Returns the parameter data at the passed offset. |
![]() ![]() |
const TArray< uint8 > & | ||
![]() ![]() |
TOptional< T > | GetParameterOptionalValue
(
const FNiagaraVariableBase& Parameter |
|
![]() ![]() |
void | GetParameters
(
TArray< FNiagaraVariable >& OutParameters |
|
![]() ![]() |
bool | ||
![]() ![]() |
void | GetParameterValue
(
T& OutValue, |
Gets the typed parameter data. |
![]() ![]() |
T | GetParameterValue
(
const FNiagaraVariableBase& Parameter |
|
![]() ![]() |
T | GetParameterValueOrDefault
(
const FNiagaraVariableBase& Parameter, |
|
![]() ![]() |
bool | ||
![]() ![]() ![]() |
const FVector * | GetPositionParameterValue
(
const FName& ParamName |
|
![]() ![]() |
SIZE_T | ||
![]() |
TArray< FNiagaraParameterStore * > & | ||
![]() ![]() |
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. |
![]() ![]() |
UObject * | GetUObject
(
const FNiagaraVariable& Parameter |
|
![]() ![]() |
UObject * | GetUObject
(
int32 Offset |
Returns the UObject at the passed offset. |
![]() ![]() |
const TArray< UObject * > & | GetUObjects () |
|
![]() ![]() |
bool | ||
![]() ![]() |
int32 | IndexOf
(
const FNiagaraVariableBase& Parameter |
Gets the index of the passed parameter. |
![]() ![]() |
void | InitFromSource
(
const FNiagaraParameterStore* SrcStore, |
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 | ||
![]() |
void | ||
![]() |
void | ||
![]() |
void | ||
![]() ![]() |
int32 | Num () |
|
![]() |
void | ||
![]() |
void | ||
![]() |
void | ||
![]() |
FOnParameterRenamed & | ||
![]() |
FOnStructureChanged & | ||
![]() |
void | ||
![]() ![]() |
int32 | PaddedParameterSize
(
int32 ParameterSize |
|
![]() |
void | ||
![]() |
void | PostLoad () |
|
![]() ![]() ![]() |
TArrayView< const FNiagaraVariableWithOffset > | 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, |
Renames the passed parameter. |
![]() ![]() |
void | Reset
(
bool bClearBindings |
Removes all parameters from this store but doesn't change memory allocations. |
![]() |
void | ResolvePositions
(
FNiagaraLWCConverter LwcConverter |
|
![]() ![]() |
void | SanityCheckData
(
bool bInitInterfaces |
|
![]() |
void | SetDataInterface
(
UNiagaraDataInterface* InInterface, |
|
![]() |
void | SetDataInterface
(
UNiagaraDataInterface* InInterface, |
|
![]() |
void | SetDataInterfaces
(
const TArray< UNiagaraDataInterface* >& InDataInterfaces, |
|
![]() |
void | SetOriginalPositionData
(
const TArray< FNiagaraPositionSource >& InOriginalPositionData |
|
![]() |
void | ||
![]() |
void | SetParameterByOffset
(
uint32 ParamOffset, |
|
![]() |
bool | SetParameterData
(
const uint8* Data, |
|
![]() |
void | SetParameterData
(
const uint8* Data, |
|
![]() |
void | SetParameterDataArray
(
const TArray< uint8 >& InParameterDataArray, |
|
![]() |
bool | SetParameterValue
(
const FQuat4d& InValue, |
|
![]() |
bool | SetParameterValue
(
const FVector4d& InValue, |
|
![]() |
bool | SetParameterValue
(
const FVector3d& InValue, |
|
![]() |
bool | SetParameterValue
(
const T& InValue, |
|
![]() ![]() |
bool | SetPositionParameterValue
(
const FVector& InValue, |
|
![]() |
void | SetUObject
(
UObject* InObject, |
|
![]() |
void | SetUObject
(
UObject* InObject, |
|
![]() |
void | SetUObjects
(
const TArray< UObject* >& InUObjects, |
|
![]() |
void | ||
![]() |
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 | ||
![]() |
void | Unbind
(
FNiagaraParameterStore* DestStore |
Unbinds this store form one it's bound to. |
![]() |
void | UnbindAll () |
Unbinds this store from all source and destination stores. |
![]() |
void | Unbinds this store from all stores it's being driven by. | |
![]() ![]() |
bool | VerifyBinding
(
const FNiagaraParameterStore* InDestStore |
Operators
Type | Name | Description | |
---|---|---|---|
![]() |
FNiagaraParameterStore & | operator=
(
const FNiagaraParameterStore& Other |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
FScopedSuppressOnChanged |
Enums
Type | Name | Description | |
---|---|---|---|
![]() |
EDataInterfaceCopyMethod |
Typedefs
Name | Description |
---|---|
BindingPair | Bindings between this parameter store and others we push data into when we tick. |
FOnChanged | |
FOnParameterRenamed | |
FOnStructureChanged |