while
The following is a list of properties for the function while:
| Property | Value |
|---|---|
brief | Evaluate a list of values (statements) while a condition is true |
category | script |
description | This creates a new structured block with a new nested variable scope. This function will evaluate a list of values (statements) while a condition is true. The condition is tested at the beginning of the loop. If the condition is false for the first iteration, the loop returns a null value. See the related functions "break", "continue", "return" and "throw". |
functionId | while |
functionLabel | while |
pure | true |
parameters | [ { "dataType": "boolean", "description": "While this condition is true, the loop will continue. This is evaluated in the loop's scope.", "name": "condition" }, { "dataType": "list", "description": "This is a list of values (statements) that are evaluated for each iteration of the loop. Each value in body is evaluated in order until the end of the list or until a \"break\", \"continue\", \"return\" or \"throw\" function is encountered.", "name": "body" } ] |
returns | { "description": "The last value evaluated in body or null if condition evaluates to false the first time." } |
scriptSupport | true |