unreal.RigUnit_CollectionChildrenArray

class unreal.RigUnit_CollectionChildrenArray(parent: RigElementKey = Ellipsis, include_parent: bool = False, recursive: bool = False, default_children: bool = False, type_to_search: RigElementType = Ellipsis, items: None = [])

Bases: RigUnit_CollectionBase

Creates an item array based on the direct or recursive children of a provided parent item. Returns an empty array for an invalid parent item.

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_Collection.h

Editor Properties: (see get_editor_property/set_editor_property)

  • default_children (bool): [Read-Write] When true, it will return all children, regardless of whether the parent is active or not. When false, will return only the children which are influenced by this parent

  • include_parent (bool): [Read-Write]

  • items (Array[RigElementKey]): [Read-Write]

  • parent (RigElementKey): [Read-Write]

  • recursive (bool): [Read-Write]

  • type_to_search (RigElementType): [Read-Write]

property default_children: bool

[Read-Write] When true, it will return all children, regardless of whether the parent is active or not. When false, will return only the children which are influenced by this parent

Type:

(bool)

property include_parent: bool

[Read-Write]

Type:

(bool)

property items: None

[Read-Only]

Type:

(Array[RigElementKey])

property parent: RigElementKey

[Read-Write]

Type:

(RigElementKey)

property recursive: bool

[Read-Write]

Type:

(bool)

[Read-Write]

Type:

(RigElementType)