Navigation
API > API/Plugins > API/Plugins/RigVM
Given a count, execute iteratively until the count is up
| Name | FRigVMFunction_ForLoopCount |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMFunctions/Execution/RigVMFunction_ForLoop.h |
| Include Path | #include "RigVMFunctions/Execution/RigVMFunction_ForLoop.h" |
Syntax
USTRUCT (
Meta=(DisplayName="For Loop", Category="Execution", TitleColor="1 0 0", NodeColor="1 1 1", Keywords="Iterate", Icon="EditorStyle|GraphEditor.Macro.Loop_16x", DocumentationPolicy="Strict", Pure))
struct FRigVMFunction_ForLoopCount : public FRigVMStructMutable
Inheritance Hierarchy
- FRigVMStruct → FRigVMStructMutable → FRigVMFunction_ForLoopCount
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMFunction_ForLoopCount() |
RigVMFunctions/Execution/RigVMFunction_ForLoop.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BlockToRun | FName | The internal block to run as this node progressed. | RigVMFunctions/Execution/RigVMFunction_ForLoop.h |
|
| Completed | FRigVMExecuteContext | The completed branch to run once the loop has finished all iterations. | RigVMFunctions/Execution/RigVMFunction_ForLoop.h |
|
| Count | int32 | The number of iterations for this loop. | RigVMFunctions/Execution/RigVMFunction_ForLoop.h |
|
| Index | int32 | The index of the current iteration. | RigVMFunctions/Execution/RigVMFunction_ForLoop.h |
|
| Ratio | float | The ratio of the current iteration (from 0.0 for the first to 1.0 for the last) | RigVMFunctions/Execution/RigVMFunction_ForLoop.h |
|
Functions
Public
Public Virtual
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Execute logic for this struct | RigVMFunctions/Execution/RigVMFunction_ForLoop.h | |
| RigVMFunctions/Execution/RigVMFunction_ForLoop.h | |||
virtual int32 GetNumSlices() |
Control flow related | RigVMFunctions/Execution/RigVMFunction_ForLoop.h | |
virtual const bool IsControlFlowBlockSliced
(
const FName& InBlockName |
RigVMFunctions/Execution/RigVMFunction_ForLoop.h |