unreal.RigUnit_HierarchyGetChainItemArray

class unreal.RigUnit_HierarchyGetChainItemArray(start: RigElementKey = Ellipsis, end: RigElementKey = Ellipsis, include_start: bool = False, include_end: bool = False, reverse: bool = False, chain: None = [])

Bases: RigUnit_HierarchyBase

Returns a chain between two items

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_Hierarchy.h

Editor Properties: (see get_editor_property/set_editor_property)

  • chain (Array[RigElementKey]): [Read-Write] The resulting array of elements on the chain

  • end (RigElementKey): [Read-Write] The last element of the chain

  • include_end (bool): [Read-Write] If True the list of results will include the last element

  • include_start (bool): [Read-Write] If True the list of results will include the first element

  • reverse (bool): [Read-Write] If True the list of results will be reversed

  • start (RigElementKey): [Read-Write] The first element of the chain

property chain: None

[Read-Only] The resulting array of elements on the chain

Type:

(Array[RigElementKey])

property end: RigElementKey

[Read-Write] The last element of the chain

Type:

(RigElementKey)

property include_end: bool

[Read-Write] If True the list of results will include the last element

Type:

(bool)

property include_start: bool

[Read-Write] If True the list of results will include the first element

Type:

(bool)

property reverse: bool

[Read-Write] If True the list of results will be reversed

Type:

(bool)

property start: RigElementKey

[Read-Write] The first element of the chain

Type:

(RigElementKey)