Difference between revisions of "0001"

From GTAMods Wiki
Jump to navigation Jump to search
(updating page)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Icon|trilogy}}
+
{{OpCode
<hr />
+
| games      = {{Icon|t}}
'''Description'''
+
| command    = WAIT
: Stops the execution of a [[thread]]
+
| description = Stops the execution of a [[script]]
'''Syntax'''
+
| syntax1    = 0001: wait [''int''] ms
: 0001: wait [''int''] ms
+
| syntax2    = wait [''int'']
: wait [''int'']
+
| p1t        = [''int'']
'''Parameter'''
+
| p1d        = Time to wait in milliseconds
: [''int'']
+
| native      = [[WAIT]]
:: Time to wait in milliseconds
+
}}
'''Native analog'''
 
: [[WAIT]]
 
  
This opcode stops an execution of the thread for specified amount of time in ms. A parameter value of 0 (wait 0 ms) means that the thread will regain focus as soon as possible, whereas values greater than 0 denote the minimum time span that has to go by before the thread is revisited. A wait is required for almost all [[Create a thread#Loops|loops]].
+
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 any [[Create a script#Loops|loops]] that do not terminate as soon as reasonably possible. Without a wait, the game locks itself into processing the script and cannot process the rest of the game. 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, with the required "wait" opcode.
+
The following example using [[Sanny Builder]] shows a simple loop with the required "wait" opcode.
<source 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>
</source>
+
}}
  
 
== Keywords ==
 
== Keywords ==
wait, thread
+
wait, thread, script
 
 
[[Category:OpCodes]]
 

Latest revision as of 13:01, 21 December 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 any loops that do not terminate as soon as reasonably possible. Without a wait, the game locks itself into processing the script and cannot process the rest of the game. 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