Navigation
API > API/Plugins > API/Plugins/Niagara
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraScript.h |
| Include | #include "NiagaraScript.h" |
Syntax
USTRUCT ()
struct FNiagaraVMExecutableDataId
Remarks
Struct containing all of the data necessary to look up a NiagaraScript's VM executable results from the Derived Data Cache.
Variables
| Type | Name | Description | |
|---|---|---|---|
  |
TArray< FString > | AdditionalDefines | Configuration options |
  |
TArray< FNiagaraVariableBase > | AdditionalVariables | |
  |
FNiagaraCompileHash | BaseScriptCompileHash | The hash of the subgraph this shader primarily represents. |
  |
uint32: 1 | bDisableDebugSwitches | Whether or not we allow debug switches to be used. |
  |
uint32: 1 | bInterpolatedSpawn | Do we require interpolated spawning |
  |
uint32: 1 | bRequiresPersistentIDs | Do we require persistent IDs |
  |
uint32: 1 | bUsesRapidIterationParams | Whether or not we need to bake Rapid Iteration params. True to keep params, false to bake. |
  |
FGuid | CompilerVersionID | The version of the compiler that this needs to be built against. |
  |
TArray< FNiagaraCompileHash > | ReferencedCompileHashes | Compile hashes of any top level scripts the script was dependent on that might trigger a recompile if they change. |
  |
ENiagaraScriptUsage | ScriptUsageType | The type of script this was used for. |
  |
FGuid | ScriptUsageTypeID | The instance id of this script usage type. |
  |
FGuid | ScriptVersionID | The version of the script that was compiled. If empty then just the latest version. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | AppendKeyString
(
FString& KeyString, |
Appends string representations of this Id to a key string. |
  |
TArray< FString > | ||
  |
SIZE_T | GetSizeBytes () |
|
  |
bool | ||
 |
void | Invalidate () |
|
  |
bool | IsValid () |
|
  |
bool |
Operators
| Type | Name | Description | |
|---|---|---|---|
  |
bool | operator!=
(
const FNiagaraVMExecutableDataId& ReferenceSet |
|
  |
bool | operator==
(
const FNiagaraVMExecutableDataId& ReferenceSet |
Tests this set against another for equality, disregarding override settings. |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
  |
FGuid | BaseScriptID_DEPRECATED | The GUID of the subgraph this shader primarily represents. |