FNiagaraVMExecutableData

Struct containing all of the data needed to run a Niagara VM executable script.

Windows
MacOS
Linux

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraScript.h

Include

#include "NiagaraScript.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNiagaraVMExecutableData

Remarks

Struct containing all of the data needed to run a Niagara VM executable script.

Variables

Name Description

Public variable UProperty

TArray< FNiagar...

 

AdditionalExternalFunctions

Public variable UProperty

TArray< FNiagar...

 

Attributes

Attributes used by this script.

Public variable UProperty

TArray< FNiagar...

 

AttributesWritten

List of all attributes explicitly written by this VM script graph.

Public variable UProperty

uint32: 1

 

bNeedsGPUContextInit

Public variable UProperty

bool

 

bReadsAttributeData

Public variable UProperty

uint32: 1

 

bReadsSignificanceIndex

Public variable UProperty

TArray< uint8 >

 

ByteCode

Byte code to execute for this system

Public variable

TArray< FVMExte...

 

CalledVMExternalFunctionBindings

Public variable UProperty

TArray< FVMExte...

 

CalledVMExternalFunctions

Array of ordered vm external functions to place in the function table.

Public variable UProperty

TArray< FNiagar...

 

CompileTags

Public variable UProperty

float

 

CompileTime

Public variable UProperty

TArray< FNiagar...

 

DataInterfaceInfo

Information about all data interfaces used by this script.

Public variable UProperty

TMap< FName, FN...

 

DataSetToParameters

Public variable UProperty

FNiagaraScriptD...

 

DataUsage

Contains various usage information for this script.

Public variable UProperty

TArray< FNiagar...

 

DIParamInfo

Public variable UProperty

FString

 

ErrorMsg

Public variable UProperty

TArray< FNiagar...

 

ExternalDependencies

List of all external dependencies of this script. If not met, linking should result in an error.

Public variable UProperty

FNiagaraParamet...

 

InternalParameters

All the data for using external constants in the script, laid out in the order they are expected in the uniform table.

Public variable UProperty

FString

 

LastAssemblyTranslation

Public variable UProperty

TArray< FNiagar...

 

LastCompileEvents

Array of all compile events generated last time the script was compiled.

Public variable UProperty

ENiagaraScriptC...

 

LastCompileStatus

Last known compile status. Lets us determine the latest state of the script byte buffer.

Public variable UProperty

FString

 

LastHlslTranslation

Public variable UProperty

FString

 

LastHlslTranslationGPU

Public variable UProperty

uint32

 

LastOpCount

Public variable UProperty

int32

 

NumTempRegisters

Number of temp registers used by this script.

Public variable UProperty

int32

 

NumUserPtrs

Number of user pointers we must pass to the VM.

Public variable UProperty Transient

TArray< uint8 >

 

OptimizedByteCode

Runtime optimized byte code, specific to the system we are running on, currently can not be serialized

Public variable UProperty

TArray< FString...

 

ParameterCollectionPaths

The parameter collections used by this script.

Public variable UProperty

FNiagaraParamet...

 

Parameters

All the data for using external constants in the script, laid out in the order they are expected in the uniform table.

Public variable UProperty

TArray< FNiagar...

 

ReadDataSets

Public variable UProperty

TArray< uint8 >

 

ScriptLiterals

Public variable UProperty

TArray< FSimula...

 

SimulationStageMetaData

Public variable UProperty

TArray< FNiagar...

 

StatScopes

Scopes we'll track with stats.

Public variable UProperty

TArray< FNiagar...

 

WriteDataSets

Constructors

Name Description

Public function

FNiagaraVMExecutableData()

Functions

Name Description

Public function Const

void

 

BakeScriptLiterals

(
    TArray< uint8 >& OutLiterals
)

Public function Const

bool

 

IsValid()

Public function

void

 

Reset()

Public function

void

 

SerializeData

(
    FArchive& Ar,
    bool bDDCData
)

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