While


Description

The While action is used to perform loops that only terminate when a specific condition returns true. For example, you can use a variable and set it to false then run the While loop and have it checking this variable, then at some time in the loop you set the variable to true and the loop will terminate. Note that no matter where you set the condition within the while loop, all actions within the loop will be run to the end before the rest of the script or event continues, changing the condition does not instantly break out of the loop.

When you add a While action into your code, you need to supply the variable to check, what kind of check to perform (less than, greater than, equals, etc...), and the value to check the variable against (you can also flag not to have the While loop check to see if the condition is not true). You then add the actions to be performed within the While loop, much as you would add an action to an "if", ie: dropping it to the side of the action rather than under it: Drop Actions Into A While Loop

All actions added to the side will be included in the While and will be performed before the event or script continues with the actions added under (as shown in the example below). Note that you can end any loop prematurely if you call the Break action.


Action Syntax:

While Syntax


Arguments:

Argument Description
Variable The variable to use in the check
Is The type of evaluation to perform (less than, greater than, equal to, greater than or equal to and less than or equal to)
Value The value to check the variable against


Example:

While Example
The above action block code creates a temporary local variable and sets it to false. This variable is then checked in the While loop action and while it returns false the loop will run. In the loop we get two temporary local variables for a random x/y position in the room then we check that position for a collision. If no collision is found, the initial variable is set to true, ending the loop. After the loop has ended an new instance is created at the random position that we discovered to have no collisions.