FRigVMFunction_BreakFromLoop

Navigation

API > API/Plugins > API/Plugins/RigVM

DESIGN INTENT

GOAL: Defines FRigVMFunction_BreakFromLoop, a RigVM node that allows early exit from a For Loop or For Each loop body during execution.

APPROACH: The node carries a singleton BlockToRun (FName) pin that the compiler aliases — at compile time — to the enclosing loop's BlockToRun memory slot. At runtime, Execute() writes ControlFlowCompletedName into that shared slot, causing the loop's JumpToBranch to route to the Completed branch on the next iteration check. The current iteration always completes in full. This node has no control flow blocks of its own (it does not branch); it is a pure "write-and-let-the-loop-read" passthrough.

REVIEWER NOTES: The Singleton meta on BlockToRun is critical — it tells the compiler to alias this pin's memory to the enclosing loop's BlockToRun register rather than allocating new memory. Without Singleton, the write would go to an isolated slot the loop never reads, making Break a no-op at runtime. Do NOT add Hidden meta to BlockToRun — Hidden suppresses pin creation entirely, which would prevent the compiler from performing the aliasing.

Breaks out of the enclosing For Loop or For Each loop at the end of the current iteration. When executed, it sets the enclosing loop's BlockToRun to "Completed", causing the loop to skip remaining iterations and proceed to its Completed branch.

Must be placed inside a loop body; the compiler will emit an error if this node is used outside a loop scope.

Syntax

USTRUCT (  
        Meta=(DisplayName="Break From Loop", Category="Execution", NodeColor="0, 0, 0, 1", Keywords="Break,Stop,Exit,Loop", Icon="EditorStyle|GraphEditor.Macro.Loop_16x"))  
struct FRigVMFunction_BreakFromLoop : public FRigVMStruct  
Copy full snippet

USTRUCT (         Meta=(DisplayName="Break From Loop", Category="Execution", NodeColor="0, 0, 0, 1", Keywords="Break,Stop,Exit,Loop", Icon="EditorStyle|GraphEditor.Macro.Loop_16x")) struct FRigVMFunction_BreakFromLoop : public FRigVMStruct

Inheritance Hierarchy

• FRigVMStruct → FRigVMFunction_BreakFromLoop

Constructors

Variables

Public

Functions

Public

Public Virtual

Overridden from FRigVMStruct