unreal.RigUnit_CollectionLoop
¶
- class unreal.RigUnit_CollectionLoop(execute_context: ControlRigExecuteContext = [], collection: RigElementKeyCollection = Ellipsis, item: RigElementKey = Ellipsis, index: int = 0, count: int = 0, ratio: float = 0.0, completed: ControlRigExecuteContext = [])¶
Bases:
RigUnit_CollectionBaseMutable
Given a collection of items, execute iteratively across all items in a given collection
C++ Source:
Plugin: ControlRig
Module: ControlRig
File: RigUnit_Collection.h
Editor Properties: (see get_editor_property/set_editor_property)
collection
(RigElementKeyCollection): [Read-Write]completed
(ControlRigExecuteContext): [Read-Write]count
(int32): [Read-Write]execute_context
(ControlRigExecuteContext): [Read-Write] * This property is used to chain multiple mutable units togetherindex
(int32): [Read-Write]item
(RigElementKey): [Read-Write]ratio
(float): [Read-Write] Ranging from 0.0 (first item) and 1.0 (last item) This is useful to drive a consecutive node with a curve or an ease to distribute a value.
- property collection: RigElementKeyCollection¶
[Read-Write]
- Type:
- property completed: ControlRigExecuteContext¶
[Read-Only]
- Type:
- property item: RigElementKey¶
[Read-Only]
- Type: