Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units > API/Plugins/ControlRig/Units/Execution
Inheritance Hierarchy
- FRigVMStruct
- FRigUnit
- FRigUnitMutable
- FRigUnit_CollectionBaseMutable
- FRigUnit_CollectionLoop
References
| Module | ControlRig |
| Header | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Execution/RigUnit_Collection.h |
| Include | #include "Units/Execution/RigUnit_Collection.h" |
Syntax
USTRUCT (
Meta=(DisplayName="For Each Item", Keywords="Collection,Loop,Iterate", Icon="EditorStyle|GraphEditor.Macro.ForEach_16x", Deprecated="5.0"))
struct FRigUnit_CollectionLoop : public FRigUnit_CollectionBaseMutable
Remarks
Given a collection of items, execute iteratively across all items in a given collection
Variables
| Type | Name | Description | |
|---|---|---|---|
| FName | BlockToRun | ||
| FRigElementKeyCollection | Collection | ||
| FControlRigExecuteContext | Completed | ||
| int32 | Count | ||
| int32 | Index | ||
| FRigElementKey | Item | ||
| float | Ratio | 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. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Overridden from FRigVMStruct
| Type | Name | Description | |
|---|---|---|---|
| void | Execute () |
Execute logic for this struct | |
| const TArray< FName > & | |||
| int32 | GetNumSlices () |
||
| FRigVMStructUpgradeInfo | |||
| const bool | IsControlFlowBlockSliced
(
const FName& InBlockName |