unreal.RigVMFunction_BreakFromLoop

class unreal.RigVMFunction_BreakFromLoop(execute_context: RigVMExecuteContext = [])

Bases: RigVMStruct

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.

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMFunction_BreakLoop.h

Editor Properties: (see get_editor_property/set_editor_property)

  • execute_context (RigVMExecuteContext): [Read-Write] Input-only execution pin — no output execution since the compiler emits a JumpForward after this node, making any downstream nodes dead code.

property execute_context: RigVMExecuteContext

[Read-Write] Input-only execution pin — no output execution since the compiler emits a JumpForward after this node, making any downstream nodes dead code.

Type:

(RigVMExecuteContext)