While

From EventScripts Community Encyclopedia

while is the correct title for this article. The title you see above is incorrect due to technical limitations.

Overview

Syntax: while "<condition>" "<command>"

Note: Command parameters are described inside the < and > characters. Optional parameters are contained within [ and ] characters.

Variation of this command that doesn't expand variables: while

Will execute command until the condition is not true.

condition - Condition to check each time. Can compare values using:
- equalto (==/=)
- notequalto (!=)
- greaterthan (>)
- lessthan (<)
- greaterthanorequalto (>=)
- lessthanorequalto (<=)
command - Command to execute. Can be a single command or use es_doblock to do several commands.

If you had this code in a block somewhere:

es_xsetinfo max 3
es_xsetinfo i 0
while "server_var(i) < server_var(max)" "es_xdoblock script/while_loop"

Along with this code:

block while_loop
{
  es_msg i = server_var(i)
  es_xmath i + 1
}

It will display:

i = 0
i = 1
i = 2

This command exists in EventScripts v1.1 or higher.
Must call es_load corelib before using this command.
Does not support do or parens () around a condition, as in es_xif (condition) do {command}