FNiagaraParameterStore

Base storage class for Niagara parameter values.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public variable UProperty

FString

 

DebugName

Public variable UProperty

TMap< FNiagaraV...

 

ParameterGuidMapping

Guid data to remap rapid iteration parameters after a function input was renamed.

Constructors

Name Description

Public function

FNiagaraParameterStore()

Public function

FNiagaraParameterStore

(
    const FNiagaraParameterStore& Othe...
)

Destructors

Name Description

Public function Virtual

~FNiagaraParameterStore()

Functions

Name Description

Public function

void

 

AddConstantBuffer()

Public function

FDelegateHan...

 

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 > SourcePara...
)

Public function

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.

Public function Virtual

void

 

ChangeParameterType

(
    const FNiagaraVariableBase& Param,
    const FNiagaraTypeDefinition& NewT...
)

Changes the type of the passed parameter.

Public function Const

void

 

CheckForNaNs()

Public function Virtual

void

 

ConvertParameterType

(
    const FNiagaraVariable& ExistingPa...,
    const FNiagaraTypeDefinition& NewT...
)

Public function Const

void

 

CopyParameterData

(
    FNiagaraParameterStore& DestStore,
    const FNiagaraVariable& Parameter
)

Copies the passed parameter from this parameter store into another.

Public function Const

void

 

CopyParametersTo

(
    FNiagaraParameterStore& DestStore,
    bool bOnlyAdd,
    EDataInterfaceCopyMethod DataInterf...
)

Copies all parameters from this parameter store into another.

Protected function

void

 

CopySortedParameterOffsets

(
    TArrayView< const FNiagaraVariableW...
)

Public function

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& Parame...,
    bool IgnoreType
)

Public function Const

const FNiaga...

 

FindVariable

(
    const UNiagaraDataInterface* I...
)

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

Public function Const

UNiagaraData...

 

GetDataInterface

(
    int32 Offset
)

Returns the data interface at the passed offset.

Public function Const

UNiagaraData...

 

GetDataInterface

(
    const FNiagaraVariable& Parameter
)

Returns the data interface for the passed parameter if it exists in this store.

Public function Const

const TArray...

 

GetDataInterfaces()

Public function Const

uint32

 

GetInterfacesDirty()

Public function Const

uint32

 

GetLayoutVersion()

Public function Const

UObject *...

 

GetOwner()

Public function Const

const uint8 ...

 

GetParameterData

(
    int32 Offset
)

Public function Const

const uint8 ...

 

GetParameterData

(
    const FNiagaraVariable& Parameter
)

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

Protected function

uint8 *

 

GetParameterData_Internal

(
    int32 Offset
)

Returns the parameter data at the passed offset.

Public function Const

const TArray...

 

GetParameterDataArray()

Public function Const

void

 

GetParameters

(
    TArray< FNiagaraVariable >& OutPar...
)

Public function Const

uint32

 

GetParametersDirty()

Public function Const

T

 

GetParameterValue

(
    const FNiagaraVariable& Parameter
)

Public function Const

void

 

GetParameterValue

(
    T& OutValue,
    const FNiagaraVariable& Parameter
)

Gets the typed parameter data.

Public function Const

uint32

 

GetPositionDataDirty()

Public function Virtual Const

const FVecto...

 

GetPositionParameterValue

(
    const FName& ParamName
)

Public function

TArray< FNia...

 

GetSourceParameterStores()

Public function Const

UObject *...

 

GetUObject

(
    int32 Offset
)

Returns the UObject at the passed offset.

Public function Const

UObject *...

 

GetUObject

(
    const FNiagaraVariable& Parameter
)

Public function Const

const TArray...

 

GetUObjects()

Public function Const

uint32

 

GetUObjectsDirty()

Public function Const

int32

 

IndexOf

(
    const FNiagaraVariable& Parameter
)

Gets the index of the passed parameter.

Public function Virtual

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).

Public function Const

bool

 

IsEmpty()

Public function

void

 

MarkInterfacesDirty()

Public function

void

 

MarkParametersDirty()

Public function

void

 

MarkPositionDataDirty()

Public function

void

 

MarkUObjectsDirty()

Public function Const

int32

 

Num()

Public function

void

 

OnInterfaceChange()

Protected function

void

 

OnLayoutChange()

Public function

void

 

OnParameterChange()

Public function

void

 

OnUObjectChange()

Protected function Static

int32

 

PaddedParameterSize

(
    int32 ParameterSize
)

Public function

void

 

PostGenericEditChange()

Public function

void

 

PostLoad()

Public function Virtual Const

TArrayView< ...

 

ReadParameterVariables()

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

 

RemoveOnChangedHandler

(
    FDelegateHandle DelegateHandle
)

Public function Virtual

bool

 

RemoveParameter

(
    const FNiagaraVariableBase& Param
)

Removes the passed parameter if it exists in the store.

Public function

void

 

RemoveParameters

(
    FNiagaraParameterStore& DestStore
)

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

 

ResolvePositions

(
    FNiagaraLWCConverter LwcConverter
)

Public function Virtual

void

 

SanityCheckData

(
    bool bInitInterfaces
)

Public function

void

 

SetDataInterface

(
    UNiagaraDataInterface* InInter...,
    const FNiagaraVariable& Parameter
)

Public function

void

 

SetDataInterface

(
    UNiagaraDataInterface* InInter...,
    int32 Offset
)

Protected function

void

 

SetDataInterfaces

(
    const TArray< UNiagaraDataInterface...,
    bool bNotifyAsDirty
)

Protected function

void

 

SetOriginalPositionData

(
    const TArray< FNiagaraPositionSourc...
)

Public function

void

 

SetOwner

(
    UObject* InOwner
)

Protected function

void

 

SetParameterByOffset

(
    uint32 ParamOffset,
    const ParamType& Param
)

Public function

bool

 

SetParameterData

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

Public function

void

 

SetParameterData

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

Protected function

void

 

SetParameterDataArray

(
    const TArray< uint8 >& InParameter...,
    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

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

void

 

SetUObject

(
    UObject* InObject,
    int32 Offset
)

Public function

void

 

SetUObject

(
    UObject* InObject,
    const FNiagaraVariable& Parameter
)

Protected function

void

 

SetUObjects

(
    const TArray< UObject* >& InU...,
    bool bNotifyAsDirty
)

Public function

void

 

SortParameters()

Public function

void

 

Tick()

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

Protected function

void

 

TickBindings()

Public function Const

FString

 

ToString()

Public function

void

 

TransferBindings

(
    FNiagaraParameterStore& OtherStore
)

Recreates any bindings to reflect a layout change etc.

Public function

void

 

TriggerOnLayoutChanged()

Public function

void

 

Unbind

(
    FNiagaraParameterStore* DestSt...
)

Unbinds this store form one it's bound to.

Public function

void

 

UnbindAll()

Unbinds this store from all source and destination stores.

Public function

void

 

UnbindFromSourceStores()

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

Public function Const

bool

 

VerifyBinding

(
    const FNiagaraParameterStore* ...
)

Operators

Name Description

Public function

FNiagaraPara...

 

operator=

(
    const FNiagaraParameterStore& Othe...
)

Enums

Name

Description

Public enum

EDataInterfaceCopyMethod

Typedefs

Name

Description

BindingPair

Bindings between this parameter store and others we push data into when we tick.

FOnChanged