unreal.RigVMTag

class unreal.RigVMTag(name: Name = 'None', label: str = '', tool_tip: Text = '', color: LinearColor = Ellipsis, show_in_user_interface: bool = False, marks_subject_as_invalid: bool = False)

Bases: StructBase

User applied tag

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMVariant.h

Editor Properties: (see get_editor_property/set_editor_property)

  • color (LinearColor): [Read-Write]

  • label (str): [Read-Write]

  • marks_subject_as_invalid (bool): [Read-Write] Enabling this will mark the subject (asset, function etc) as (soft) deprecated. The content referring to variants with this tag will continue to work, but the user interface will suggest the user to upgrade to a later variant.

  • name (Name): [Read-Write]

  • show_in_user_interface (bool): [Read-Write] Enabling this will show tags in the user interface within the variant widgets and other places. Disabling this will interpret this tag as automation / scripting only.

  • tool_tip (Text): [Read-Write]

property color: LinearColor

[Read-Write]

Type:

(LinearColor)

property label: str

[Read-Write]

Type:

(str)

property marks_subject_as_invalid: bool

[Read-Write] Enabling this will mark the subject (asset, function etc) as (soft) deprecated. The content referring to variants with this tag will continue to work, but the user interface will suggest the user to upgrade to a later variant.

Type:

(bool)

property name: Name

[Read-Write]

Type:

(Name)

property show_in_user_interface: bool

[Read-Write] Enabling this will show tags in the user interface within the variant widgets and other places. Disabling this will interpret this tag as automation / scripting only.

Type:

(bool)

property tool_tip: Text

[Read-Write]

Type:

(Text)