ProtoFlux:While

While

*

LoopStart

Condition

LoopIteration

LoopEnd

Flow

The While node will start running when this gets impulsed. The code will continue running and hold a context until the provided Condition is false or the max execution iterations is hit.

If this node just has an Input with the bool type set to true, the code will not be able to stop and will error the entire Flux, and in many cases the entire world or client will freeze (Issues #774 & #1677). Caution should be exercised when using this node.

If it is easy to determine how often the loop is going to execute, a For Loop should be preferred to avoid accidentally creating infinite loops.

Inputs

* (Call)

Impulse to start the loop

Condition (Boolean)

The value that the loop will check for if it should continue running or not.

Outputs

LoopStart (Impulse)

Fires once at the beginning of the loop, regardless of if Condition (Boolean) is true or not.

LoopIteration (Impulse)

Fires infinitely all in one game tick until the game crashes, or Condition (Boolean) is false. Will only fire if Condition (Boolean) is true.

LoopEnd (Impulse)

Fires once the triggered loop has ended and the node has not hit a critical error.

Examples

Example of how to use a while loop.

Example of how to use a while loop.
Example of how to not use a while loop, which will crash the game if fired.

Example of how to not use a while loop, which will crash the game if fired.

Related Issues

As the time of writing, there is a known issue that can occur when the very last node in the LoopIteration chain is a Write node. If the Write affects the value of a variable which is itself used as part of the evaluation of the Condition, the evaluation will use the value that the variable held before the Write operation is completed.
- Because this only occurs if the Write node is the very last one in the chain, a simple workaround is to connect any node to the OnWritten output of the Write node – such as a Pulse Display.