FNiagaraScriptInstanceParameterStore

[FNiagaraScriptInstanceParameterStore](API\Plugins\Niagara\FNiagaraScriptInstanceParameterS-).

Windows
MacOS
Linux

Inheritance Hierarchy

FNiagaraParameterStore

FNiagaraScriptInstanceParameterStore

References

Module

Niagara

Header

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

Include

#include "NiagaraScriptExecutionParameterStore.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNiagaraScriptInstanceParameterStore : public FNiagaraParameterStore

Remarks

Constructors

Destructors

Functions

Name Description

Public function

void

 

CopyCurrToPrev()

Public function Const

void

 

CopyParameterDataToPaddedBuffer

(
    uint8* InTargetBuffer,
    uint32 InTargetBufferSizeInBytes
)

Helper that converts the data from the base type array internally into the padded out renderer-ready format.

Public function Const

uint32

 

GetExternalParameterSize()

Just the external parameters, not previous or internal...

Public function Const

uint32

 

GetPaddedParameterSizeInBytes()

Public function Const

TArrayView< ...

 

GetScriptLiterals()

Public function

void

 

InitFromOwningContext

(
    UNiagaraScript* Script,
    ENiagaraSimTarget SimTarget,
    bool bNotifyAsDirty
)

Call this init function if you are using a Niagara parameter store within an FNiagaraScriptExecutionContext.

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 Const

TArrayView< ...

 

ReadParameterVariables()

The View of the set of variables represented by this ParameterStore.

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.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss