Navigation
API > API/Plugins > API/Plugins/Niagara
Struct containing all of the data needed to run a Niagara VM executable script.
| Name | FNiagaraVMExecutableData |
| Type | struct |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraScript.h |
| Include Path | #include "NiagaraScript.h" |
Syntax
USTRUCT ()
struct FNiagaraVMExecutableData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraVMExecutableData() |
NiagaraScript.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AdditionalExternalFunctions | TArray< FNiagaraFunctionSignature > | NiagaraScript.h | ||
| Attributes | TArray< FNiagaraVariableBase > | Attributes used by this script. | NiagaraScript.h | |
| AttributesWritten | TArray< FNiagaraVariableBase > | List of all attributes explicitly written by this VM script graph. | NiagaraScript.h | |
| BakedRapidIterationParameters | TArray< FNiagaraVariable > | The default set of rapid iteration parameters defined by the script that this data represents. | NiagaraScript.h | |
| bNeedsGPUContextInit | uint32 | NiagaraScript.h | ||
| bReadsAttributeData | bool | NiagaraScript.h | ||
| bReadsSignificanceIndex | uint32 | NiagaraScript.h | ||
| ByteCode | FNiagaraVMExecutableByteCode | Byte code to execute for this system. | NiagaraScript.h | |
| CalledVMExternalFunctionBindings | TArray< FVMExternalFunction > | NiagaraScript.h | ||
| CalledVMExternalFunctions | TArray< FVMExternalFunctionBindingInfo > | Array of ordered vm external functions to place in the function table. | NiagaraScript.h | |
| CompileTags | TArray< FNiagaraCompilerTag > | NiagaraScript.h | ||
| CompileTagsEditorOnly | TArray< FNiagaraCompilerTag > | NiagaraScript.h | ||
| DataInterfaceInfo | TArray< FNiagaraScriptDataInterfaceCompileInfo > | Information about all data interfaces used by this script. | NiagaraScript.h | |
| DataSetToParameters | TMap< FName, FNiagaraParameters > | NiagaraScript.h | ||
| DataUsage | FNiagaraScriptDataUsageInfo | Contains various usage information for this script. | NiagaraScript.h | |
| ErrorMsg | FString | NiagaraScript.h | ||
| ExperimentalContextData | TArray< uint8 > | NiagaraScript.h | ||
| ExternalDependencies | TArray< FNiagaraCompileDependency > | List of all external dependencies of this script. If not met, linking should result in an error. | NiagaraScript.h | |
| InternalParameters | FNiagaraParameters | All the data for using external constants in the script, laid out in the order they are expected in the uniform table. | NiagaraScript.h | |
| LastAssemblyTranslation | FString | NiagaraScript.h |
|
|
| LastCompileEvents | TArray< FNiagaraCompileEvent > | Array of all compile events generated last time the script was compiled. | NiagaraScript.h | |
| LastCompileStatus | ENiagaraScriptCompileStatus | Last known compile status. Lets us determine the latest state of the script byte buffer. | NiagaraScript.h | |
| LastExperimentalAssemblyScript | FString | NiagaraScript.h | ||
| LastHlslTranslation | FString | NiagaraScript.h |
|
|
| LastHlslTranslationGPU | FString | Note that this is currently needed to be non-transient because of how we kick off compilation of GPUComputeScripts. | NiagaraScript.h | |
| LastOpCount | uint32 | NiagaraScript.h |
|
|
| NumTempRegisters | int32 | Number of temp registers used by this script. | NiagaraScript.h | |
| NumUserPtrs | int32 | Number of user pointers we must pass to the VM. | NiagaraScript.h | |
| ParameterCollectionPaths | TArray< FString > | The parameter collections used by this script. | NiagaraScript.h | |
| Parameters | FNiagaraParameters | All the data for using external constants in the script, laid out in the order they are expected in the uniform table. | NiagaraScript.h | |
| ReadDataSets | TArray< FNiagaraDataSetID > | NiagaraScript.h | ||
| ScriptLiterals | TArray< uint8 > | NiagaraScript.h | ||
| ShaderScriptParametersMetadata | FNiagaraShaderScriptParametersMetadata | NiagaraScript.h | ||
| SimulationStageMetaData | TArray< FSimulationStageMetaData > | NiagaraScript.h | ||
| StaticVariablesWritten | TArray< FNiagaraVariable > | List of all attributes explicitly written by this VM script graph. | NiagaraScript.h | |
| StatScopes | TArray< FNiagaraStatScope > | Scopes we'll track with stats. | NiagaraScript.h | |
| UObjectInfos | TArray< FNiagaraScriptUObjectCompileInfo > | Information about all the UObjects used by this script. | NiagaraScript.h | |
| WriteDataSets | TArray< FNiagaraDataSetProperties > | NiagaraScript.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BakeScriptLiterals
(
TArray< uint8 >& OutLiterals |
NiagaraScript.h | ||
bool HasByteCode() |
NiagaraScript.h | ||
bool IsValid() |
NiagaraScript.h | ||
void Reset() |
NiagaraScript.h | ||
void SerializeData
(
FArchive& Ar, |
NiagaraScript.h |