unreal.RigBaseElement

class unreal.RigBaseElement(key: RigElementKey = Ellipsis, created_at_instruction_index: int = 0, spawn_index: int = 0)

Bases: StructBase

Rig Base Element

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigHierarchyElements.h

Editor Properties: (see get_editor_property/set_editor_property)

  • created_at_instruction_index (int32): [Read-Write]

  • index (int32): [Read-Only] deprecated: Index cannot be used directly. Storage indices are invalidated on hierarchy reconstruction. Use the Get Index node (URigHierarchy::GetIndex) with the element’s Key instead.

  • key (RigElementKey): [Read-Only]

  • selected (bool): [Read-Write] deprecated: bSelected cannot be accessed directly. Use URigHierarchy::IsSelected instead.

  • spawn_index (int32): [Read-Write]

  • sub_index (int32): [Read-Only] deprecated: SubIndex cannot be used directly. Storage indices are invalidated on hierarchy reconstruction. Use the Get Local Index node (URigHierarchy::GetLocalIndex) with the element’s Key instead.

property created_at_instruction_index: int

[Read-Only]

Type:

(int32)

property index: int

[Read-Only] deprecated: Index cannot be used directly. Storage indices are invalidated on hierarchy reconstruction. Use the Get Index node (URigHierarchy::GetIndex) with the element’s Key instead.

Type:

(int32)

property key: RigElementKey

[Read-Only]

Type:

(RigElementKey)

property selected: bool

[Read-Only] deprecated: bSelected cannot be accessed directly. Use URigHierarchy::IsSelected instead.

Type:

(bool)

property spawn_index: int

[Read-Only]

Type:

(int32)

property sub_index: int

[Read-Only] deprecated: SubIndex cannot be used directly. Storage indices are invalidated on hierarchy reconstruction. Use the Get Local Index node (URigHierarchy::GetLocalIndex) with the element’s Key instead.

Type:

(int32)