FNiagaraScriptExecutionParameterStore

Storage class containing actual runtime buffers to be used by the VM and the GPU.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FNiagaraParameterStore

FNiagaraScriptExecutionParameterStore

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraScriptExecutionParameterStore.h

Include

#include "NiagaraScriptExecutionParameterStore.h"

Syntax

USTRUCT()
struct FNiagaraScriptExecutionParameterStore : public FNiagaraParameterStore

Remarks

Storage class containing actual runtime buffers to be used by the VM and the GPU. Is not the actual source for any parameter data, rather just the final place it's gathered from various other places ready for execution.

Variables

Name Description

Public variable UProperty

uint8: 1

 

bInitialized

Public variable

TArray< uint8 >

 

CachedScriptLiterals

Public variable UProperty

uint32

 

PaddedParameterSize

Public variable UProperty

TArray< FNiagar...

 

PaddingInfo

Public variable UProperty

int32

 

ParameterSize

Size of the parameter data not including prev frame values or internal constants.

Constructors

Destructors

Functions

Name Description

Protected function

void

 

AddAlignmentPadding()

Protected function

void

 

AddPaddedParamSize

(
    const FNiagaraTypeDefinition& InPa...,
    uint32 InOffset
)

Public function

void

 

AddScriptParams

(
    UNiagaraScript* Script,
    ENiagaraSimTarget SimTarget,
    bool bTriggerRebind
)

Public function

void

 

CoalescePaddingInfo()

Public function

void

 

InitFromOwningScript

(
    UNiagaraScript* Script,
    ENiagaraSimTarget SimTarget,
    bool bNotifyAsDirty
)

TODO: These function can probably go away entirely when we replace the FNiagaraParameters and DataInterface info in the script with an FNiagaraParameterStore.

Overridden from FNiagaraParameterStore

Name Description

Public function Virtual

bool

 

AddParameter

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

Adds the passed parameter to this store.

Public function Virtual

void

 

Empty

(
    bool bClearBindings
)

Removes all parameters from this store and releases any data.

Public function Virtual

bool

 

RemoveParameter

(
    const FNiagaraVariableBase& Param
)

Removes the passed parameter if it exists in the store.

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.

Operators

Name Description

Public function

FNiagaraScri...

 

operator=

(
    const FNiagaraParameterStore& Othe...
)