unreal.RigUnit_FilterItemsByMetadataTags

class unreal.RigUnit_FilterItemsByMetadataTags(items: None = [], tags: None = [], name_space: RigMetaDataNameSpace = Ellipsis, inclusive: bool = False, result: None = [])

Bases: RigUnit

Filters an item array by a list of tags

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_Metadata.h

Editor Properties: (see get_editor_property/set_editor_property)

  • inclusive (bool): [Read-Write] If set to true only items with ALL of tags will be returned, if set to false items with ANY of the tags will be removed

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

  • name_space (RigMetaDataNameSpace): [Read-Write] Defines in which namespace the metadata will be looked up

  • result (Array[RigElementKey]): [Read-Write] The results of the filter

  • tags (Array[Name]): [Read-Write] The tags to find

property inclusive: bool

[Read-Write] If set to true only items with ALL of tags will be returned, if set to false items with ANY of the tags will be removed

Type:

(bool)

property items: None

[Read-Write] The items to filter

Type:

(Array[RigElementKey])

property name_space: RigMetaDataNameSpace

[Read-Write] Defines in which namespace the metadata will be looked up

Type:

(RigMetaDataNameSpace)

property result: None

[Read-Only] The results of the filter

Type:

(Array[RigElementKey])

property tags: None

[Read-Write] The tags to find

Type:

(Array[Name])