unreal.RigVMGraphVariableDescription

class unreal.RigVMGraphVariableDescription(guid: Guid = [], name: Name = 'None', cpp_type: str = '', cpp_type_object: Object = Ellipsis, default_value: str = '', category: Text = '', tooltip: Text = '', exposed_on_spawn: bool = False, expose_to_cinematics: bool = False, public: bool = False, private: bool = False)

Bases: StructBase

The variable description is used to convey information about unique variables within a Graph. Multiple Variable Nodes can share the same variable description.

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMVariableDescription.h

Editor Properties: (see get_editor_property/set_editor_property)

  • category (Text): [Read-Write] The category of the variable

  • cpp_type (str): [Read-Write] The C++ data type of the variable

  • cpp_type_object (Object): [Read-Write] The Struct of the C++ data type of the variable (or nullptr)

  • default_value (str): [Read-Write] The default value of the variable

  • expose_to_cinematics (bool): [Read-Write] Should this variable be exposed on spawn

  • exposed_on_spawn (bool): [Read-Write] Should this variable be exposed on spawn

  • guid (Guid): [Read-Write] The guid of the variable

  • name (Name): [Read-Write] The name of the variable

  • private (bool): [Read-Write] This property should soon become deprecated, since it does not make sense for blueprint independent assets Is this variable private

  • public (bool): [Read-Write] Is this variable public

  • tooltip (Text): [Read-Write] The tooltip of the variable

property category: Text

[Read-Only] The category of the variable

Type:

(Text)

property cpp_type: str

[Read-Only] The C++ data type of the variable

Type:

(str)

property cpp_type_object: Object

[Read-Only] The Struct of the C++ data type of the variable (or nullptr)

Type:

(Object)

property default_value: str

[Read-Only] The default value of the variable

Type:

(str)

property expose_to_cinematics: bool

[Read-Only] Should this variable be exposed on spawn

Type:

(bool)

property exposed_on_spawn: bool

[Read-Only] Should this variable be exposed on spawn

Type:

(bool)

property guid: Guid

[Read-Only] The guid of the variable

Type:

(Guid)

property name: Name

[Read-Only] The name of the variable

Type:

(Name)

property private: bool

[Read-Only] This property should soon become deprecated, since it does not make sense for blueprint independent assets Is this variable private

Type:

(bool)

property public: bool

[Read-Only] Is this variable public

Type:

(bool)

property tooltip: Text

[Read-Only] The tooltip of the variable

Type:

(Text)