UNiagaraScriptVariable

Used to store variable data and metadata per graph.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraScriptVariable

References

Module

NiagaraEditor

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraScriptVariable.h

Include

#include "NiagaraScriptVariable.h"

Syntax

UCLASS()
class UNiagaraScriptVariable : public UObject

Remarks

Used to store variable data and metadata per graph.

Variables

Name Description

Public variable UProperty Category, EditAnywhere

FNiagaraScriptV...

 

DefaultBinding

The default binding.

Public variable UProperty Category, EditAnywhere

ENiagaraDefault...

 

DefaultMode

The default mode. Can be Value, Binding or Custom.

Public variable UProperty Category, EditAnywhere, Meta

FNiagaraVariabl...

 

Metadata

The metadata associated with this script variable.

Public variable UProperty

FNiagaraVariabl...

 

Variable

Variable type, name and data.

Constructors

Name Description

Public function

UNiagaraScriptVariable

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

AppendCompileHash

(
    FNiagaraCompileHashVisitor* In...
)

Entry point for generating the compile hash.

Public function Const

void

 

CopyDefaultValueDataTo

(
    uint8* Dest
)

Public function Static

bool

 

DefaultsAreEquivalent

(
    const UNiagaraScriptVariable* ...,
    const UNiagaraScriptVariable* ...
)

Public function Const

const FGuid ...

 

GetChangeId()

Public function Const

const uint8 ...

 

GetDefaultValueData()

Public function Const

const FNiaga...

 

GetDefaultValueVariant()

Public function Const

bool

 

GetIsOverridingParameterDefinitionsDefaultValue()

Public function Const

bool

 

GetIsStaticSwitch()

Public function Const

bool

 

GetIsSubscribedToParameterDefinitions()

Public function Const

int32

 

GetStaticSwitchDefaultValue()

Public function

void

 

Init

(
    const FNiagaraVariable& InVar,
    const FNiagaraVariableMetaData& In...
)

Public function

void

 

InitFrom

(
    const UNiagaraScriptVariable* ...,
    bool bCreateNewGuid
)

Public function

void

 

SetChangeId

(
    const FGuid& NewId
)

Public function

void

 

SetDefaultValueData

(
    const uint8* Data
)

Public function

void

 

SetIsOverridingParameterDefinitionsDefaultValue

(
    bool bInOverridingParameterDefiniti...
)

Public function

void

 

SetIsStaticSwitch

(
    bool bInIsStaticSwitch
)

Public function

void

 

SetIsSubscribedToParameterDefinitions

(
    bool bInSubscribedToParameterDefini...
)

Public function

void

 

SetStaticSwitchDefaultValue

(
    const int32 Value
)

Public function

void

 

UpdateChangeId()

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name

Description

FOnChanged