Navigation
API > API/Plugins > API/Plugins/ControlRig
Given a collection of items, execute iteratively across all items in a given collection
| Name | FRigUnit_CollectionLoop |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Execution/RigUnit_Collection.h |
| Include Path | #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
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_CollectionBaseMutable → FRigUnit_CollectionLoop
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_CollectionLoop() |
Units/Execution/RigUnit_Collection.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BlockToRun | FName | Units/Execution/RigUnit_Collection.h |
|
|
| Collection | FRigElementKeyCollection | Units/Execution/RigUnit_Collection.h |
|
|
| Completed | FControlRigExecuteContext | Units/Execution/RigUnit_Collection.h |
|
|
| Count | int32 | Units/Execution/RigUnit_Collection.h |
|
|
| Index | int32 | Units/Execution/RigUnit_Collection.h |
|
|
| Item | FRigElementKey | Units/Execution/RigUnit_Collection.h |
|
|
| Ratio | float | 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. | Units/Execution/RigUnit_Collection.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Execution/RigUnit_Collection.h | ||
| Units/Execution/RigUnit_Collection.h | |||
virtual int32 GetNumSlices() |
Units/Execution/RigUnit_Collection.h | ||
virtual FRigVMStructUpgradeInfo GetUpgradeInfo() |
Units/Execution/RigUnit_Collection.h | ||
virtual const bool IsControlFlowBlockSliced
(
const FName& InBlockName |
Units/Execution/RigUnit_Collection.h |