Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
Used to store variable data and metadata per graph.
| Name | UNiagaraScriptVariable |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraScriptVariable.h |
| Include Path | #include "NiagaraScriptVariable.h" |
Syntax
UCLASS (MinimalAPI)
class UNiagaraScriptVariable : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraScriptVariable
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraScriptVariable
(
const FObjectInitializer& ObjectInitializer |
NiagaraScriptVariable.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnChanged | TBaseDelegate_OneParam< void, const UNiagaraScriptVariable * > | NiagaraScriptVariable.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DefaultBinding | FNiagaraScriptVariableBinding | The default binding. | NiagaraScriptVariable.h |
|
| DefaultMode | ENiagaraDefaultMode | The default mode. Can be Value, Binding or Custom. | NiagaraScriptVariable.h |
|
| Metadata | FNiagaraVariableMetaData | The metadata associated with this script variable. | NiagaraScriptVariable.h |
|
| Variable | FNiagaraVariable | Variable type, name and data. | NiagaraScriptVariable.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsStaticSwitch | bool | NiagaraScriptVariable.h | ||
| bOverrideParameterDefinitionsDefaultValue | bool | NiagaraScriptVariable.h |
|
|
| bSubscribedToParameterDefinitions | bool | NiagaraScriptVariable.h |
|
|
| ChangeId | FGuid | NiagaraScriptVariable.h |
|
|
| DefaultValueVariant | FNiagaraVariant | NiagaraScriptVariable.h |
|
|
| StaticSwitchDefaultValue | int32 | NiagaraScriptVariable.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
Entry point for generating the compile hash. | NiagaraScriptVariable.h | |
void CopyDefaultValueDataTo
(
uint8* Dest |
NiagaraScriptVariable.h | ||
const FGuid & GetChangeId() |
NiagaraScriptVariable.h | ||
const uint8 * GetDefaultValueData() |
NiagaraScriptVariable.h | ||
const FNiagaraVariant & GetDefaultValueVariant() |
NiagaraScriptVariable.h | ||
bool GetIsOverridingParameterDefinitionsDefaultValue() |
NiagaraScriptVariable.h | ||
bool GetIsStaticSwitch() |
NiagaraScriptVariable.h | ||
bool GetIsSubscribedToParameterDefinitions() |
NiagaraScriptVariable.h | ||
int32 GetStaticSwitchDefaultValue() |
NiagaraScriptVariable.h | ||
void Init
(
const FNiagaraVariable& InVar, |
NiagaraScriptVariable.h | ||
void InitFrom
(
const UNiagaraScriptVariable* Value, |
NiagaraScriptVariable.h | ||
void SetChangeId
(
const FGuid& NewId |
NiagaraScriptVariable.h | ||
void SetDefaultValueData
(
const uint8* Data |
NiagaraScriptVariable.h | ||
void SetIsOverridingParameterDefinitionsDefaultValue
(
bool bInOverridingParameterDefinitionsDefaultValue |
NiagaraScriptVariable.h | ||
void SetIsStaticSwitch
(
bool bInIsStaticSwitch |
NiagaraScriptVariable.h | ||
void SetIsSubscribedToParameterDefinitions
(
bool bInSubscribedToParameterDefinitions |
NiagaraScriptVariable.h | ||
void SetStaticSwitchDefaultValue
(
const int32 Value |
NiagaraScriptVariable.h | ||
void UpdateChangeId() |
NiagaraScriptVariable.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
NiagaraScriptVariable.h | ||
virtual void PostLoad() |
NiagaraScriptVariable.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool DefaultsAreEquivalent
(
const UNiagaraScriptVariable* ScriptVarA, |
NiagaraScriptVariable.h | ||
static FGuid GenerateStableGuid
(
const UNiagaraScriptVariable* ScriptVariable |
NiagaraScriptVariable.h |