Difference between revisions of "049C"

From GTAMods Wiki
Jump to navigation Jump to search
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Icon|VC}}
+
{{OpCode
<hr />
+
| games      = {{Icon|VC}}
'''Description'''
+
| command    = INITIALISE_OBJECT_PATH
: Defines a [[Script Path|script path file]]
+
| description = Initialises a [[Script Path|script path]]
'''Syntax'''
+
| syntax1    = 049C: [''var''] = scripted_path_file [''int''] width [''flt'']
: 049C: [''var''] = scripted_path_file [''int''] width [''flt'']
+
| p1t        = [''int'']
'''Parameter'''
+
| p1d        = Script path index
: [''var'']
+
| p2t        = [''flt'']
:: Variable to store the handle of the script path
+
| p2d        = Width of the path in units
: [''int'']
+
| p3t        = [''var'']
:: Script path file ID
+
| p3d        = Variable to store the handle of the script path
: [''flt'']
+
}}
:: Width of the path in units
 
  
This opcode defines a script path file to be used by other [[Scripted Path#Scripting|related opcodes]]. The first parameter comes from the path file's number at the end of the file name, i.e. <code>spath0.dat</code> would use a value of 0, <code>spath1.dat</code> would use a value of 1, etc. The second parameter denotes how far from the path can the object be when traveling along the path. The larger the value, the more smooth the path can be, while the smaller the value, the more rigid the path can be. More than one handle can be defined for a scripted path file. Only one script path file was used by default but additional script paths can be created and used.
+
This opcode initialises a script path to be used by [[Script Path#Mission script|script]]. It can be cleared using opcode [[04A1]]. The script path index comes from the path file's number at the end of the file name, i.e. <code>spath0.dat</code> would use a value of ''0'', <code>spath1.dat</code> would use a value of ''1'', etc. The width of the path denotes how far from the path can the object be when traveling along the path. The larger the value, the more smooth the path can be, while the smaller the value, the more rigid the path can be. One script path file was used in the [[Main.scm|original script]] for Cortez's yacht. A script path file can be initialised more than once. Only three script paths can be loaded at a time; you must clear one before you can initialise another one.
  
[[Category:OpCodes]]
+
== Keywords ==
 +
initialize, object, script, scripted, path, file

Latest revision as of 22:02, 4 September 2017

Vice City INITIALISE_OBJECT_PATH


Description
Initialises a script path
Syntax
049C: [var] = scripted_path_file [int] width [flt]
Parameter
[int]
Script path index
[flt]
Width of the path in units
[var]
Variable to store the handle of the script path

This opcode initialises a script path to be used by script. It can be cleared using opcode 04A1. The script path index comes from the path file's number at the end of the file name, i.e. spath0.dat would use a value of 0, spath1.dat would use a value of 1, etc. The width of the path denotes how far from the path can the object be when traveling along the path. The larger the value, the more smooth the path can be, while the smaller the value, the more rigid the path can be. One script path file was used in the original script for Cortez's yacht. A script path file can be initialised more than once. Only three script paths can be loaded at a time; you must clear one before you can initialise another one.

Keywords

initialize, object, script, scripted, path, file