Difference between revisions of "0001"

From GTAMods Wiki
Jump to navigation Jump to search
(testing new template)
(highlight)
Line 14: Line 14:
 
== Example ==
 
== Example ==
 
The following example, using [[Sanny Builder]], shows a simple loop with the required "wait" opcode.
 
The following example, using [[Sanny Builder]], shows a simple loop with the required "wait" opcode.
<syntaxhighlight lang="scm">
+
{{Pre|class=sb-code|1=
while true
+
<span class="k">while</span> <span class="k">true</span>
     wait 0 ms
+
     <span class="k">wait</span> <span class="m">0</span> ms
end
+
<span class="k">end</span>
</syntaxhighlight>
+
}}
  
 
== Keywords ==
 
== Keywords ==
 
wait, thread, script
 
wait, thread, script

Revision as of 03:58, 30 November 2016

GTA III Vice City San Andreas WAIT


Description
Stops the execution of a script
Syntax
0001: wait [int] ms
wait [int]
Parameter
[int]
Time to wait in milliseconds
Native analog
WAIT

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
end

Keywords

wait, thread, script