Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > FNiagaraScriptExecutionParameterStore

Light Theme

Dark Theme

FNiagaraScriptExecutionParameterStore

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

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](Programming/UnrealArchitecture/Reference/Structs)()
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.

Constructors

	Name	Description
	FNiagaraScriptExecutionParameterStore()
	FNiagaraScriptExecutionParameterStore ( const FNiagaraParameterStore& Othe... )

Destructors

	Name	Description
	~FNiagaraScriptExecutionParameterStore()

Functions

	Name	Description
void	AddAlignmentPadding()
void	AddPaddedParamSize ( const FNiagaraTypeDefinition& InPa..., uint32 InOffset )
void	AddScriptParams ( UNiagaraScript* Script, ENiagaraSimTarget SimTarget, bool bTriggerRebind )
void	CopyCurrToPrev()
void	CopyParameterDataToPaddedBuffer ( uint8* InTargetBuffer, uint32 InTargetBufferSizeInBytes )	Helper that converts the data from the base type array internally into the padded out renderer-ready format.
uint32	GetExternalParameterSize()	Just the external parameters, not previous or internal...
uint32	GetPaddedParameterSizeInBytes()	The entire buffer padded out by the required alignment of the types..
void	InitFromOwningContext ( UNiagaraScript* Script, ENiagaraSimTarget SimTarget, bool bNotifyAsDirty )	Call this init function if you are using a Niagara parameter store within an FNiagaraScriptExecutionContext.
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.
bool	IsInitialized()
void	RenameParameter ( FNiagaraVariable& Param, FName NewName )
void	SetAsInitialized()

Overridden from FNiagaraParameterStore

	Name	Description
bool	AddParameter ( const FNiagaraVariable& Param, bool bInitialize, bool bTriggerRebind, int32* OutOffset )	Adds the passed parameter to this store.
void	Empty ( bool bClearBindings )	Removes all parameters from this store and releases any data.
bool	RemoveParameter ( const FNiagaraVariable& Param )	Removes the passed parameter if it exists in the store.

Operators

		Name	Description
	FNiagaraScri...	operator= ( const FNiagaraParameterStore& Othe... )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss