Difference between revisions of "0001"
Jump to navigation
Jump to search
m |
|||
| Line 2: | Line 2: | ||
<hr /> | <hr /> | ||
'''Description''' | '''Description''' | ||
| − | : Stops the execution of a [[thread]] | + | : Stops the execution of a [[thread|script]] |
'''Syntax''' | '''Syntax''' | ||
: 0001: wait [''int''] ms | : 0001: wait [''int''] ms | ||
| Line 12: | Line 12: | ||
: [[WAIT]] | : [[WAIT]] | ||
| − | This opcode stops an execution of the | + | This opcode stops an execution of the script for specified amount of time in milliseconds. A value of ''0'' means that the script will regain focus as soon as possible, whereas values greater than ''0'' denote the minimum time span that has to go by before the script is revisited. A wait is required for almost all [[Create a thread#Loops|loops]]. It is bad practice to use a very long wait in scripts that loop; for that, it is much better to use game timers like opcode [[01BD]] or local variable timers. |
== Example == | == Example == | ||
| − | The following example, using Sanny Builder, shows a simple loop | + | The following example, using [[Sanny Builder]], shows a simple loop with the required "wait" opcode. |
| − | < | + | <syntaxhighlight lang="scm">while true |
| − | while true | ||
wait 0 ms | wait 0 ms | ||
| − | end | + | end</syntaxhighlight> |
| − | </ | ||
== Keywords == | == Keywords == | ||
| − | wait, thread | + | wait, thread, script |
[[Category:OpCodes]] | [[Category:OpCodes]] | ||
Revision as of 20:41, 23 July 2015
WAIT
Description
- Stops the execution of a script
Syntax
- 0001: wait [int] ms
- wait [int]
Parameter
- [int]
- Time to wait in milliseconds
Native analog
This opcode stops an execution of the script for specified amount of time in milliseconds. A value of 0 means that the script will regain focus as soon as possible, whereas values greater than 0 denote the minimum time span that has to go by before the script is revisited. A wait is required for almost all loops. It is bad practice to use a very long wait in scripts that loop; for that, it is much better to use game timers like opcode 01BD or local variable timers.
Example
The following example, using Sanny Builder, shows a simple loop with the required "wait" opcode.
while true
wait 0 ms
endKeywords
wait, thread, script
