FNiagaraParameterStore

Base storage class for Niagara parameter values.

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

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.

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 Const

void

 

CheckForNaNs()

Public function Const

void

 

CopyParameterData

(
    FNiagaraParameterStore & DestStore,
    const FNiagaraVariable & Parameter
)

Copies the passed parameter from this parameter store into another.

Public function

void

 

CopyParametersTo

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

Copies all parameters from this parameter store into another.

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 FNiagaraVariable & Parameter
)

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

int32

 

GetNumParameters()

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 Const

const uint8 ...

 

GetParameterData_Internal

(
    int32 Offset
)

Returns the parameter data at the passed offset.

Protected function

uint8 *

 

GetParameterData_Internal

(
    int32 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

const TArray ...

 

GetSortedParameterOffsets()

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

void

 

MarkInterfacesDirty()

Public function

void

 

MarkParametersDirty()

Public function

void

 

MarkUObjectsDirty()

Public function

void

 

OnInterfaceChange()

Protected function

void

 

OnLayoutChange()

Public function

void

 

OnParameterChange()

Public function

void

 

OnUObjectChange()

Public function

void

 

PostLoad()

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 FNiagaraVariable & 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

void

 

RenameParameter

(
    const FNiagaraVariable & Param,
    FName NewName
)

Renames the passed parameter.

Public function Virtual

void

 

Reset

(
    bool bClearBindings
)

Removes all parameters from this store but does't change memory allocations.

Public function

void

 

SanityCheckData

(
    bool bInitInterfaces
)

Public function

void

 

SetDataInterface

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

Public function

void

 

SetDataInterface

(
    UNiagaraDataInterface * InInter...,
    int32 Offset
)

Public function

void

 

SetOwner

(
    UObject * InOwner
)

Public function

void

 

SetParameter

(
    const FNiagaraVariable & Param
)

Sets the parameter using the internally stored data in the passed FNiagaraVariable .

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
)

Public function

void

 

SetParameterDataArray

(
    const TArray < uint8 >& InParameter...
)

Public function

void

 

SetParameterDataTyped

(
    const uint8 * Data,
    int32 Offset
)

Public function

bool

 

SetParameterValue

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

Public function

void

 

SetUObject

(
    UObject * InObject,
    int32 Offset
)

Public function

void

 

SetUObject

(
    UObject * InObject,
    const FNiagaraVariable & Parameter
)

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

 

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

FOnChanged

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback