Difference between revisions of "Script Path"
(rewriting) |
|||
| Line 1: | Line 1: | ||
| − | '''Spath'''.dat files are '''scripted path''' files used only in [[Vice City]] to | + | '''Spath'''*.dat files are '''scripted path''' files used only in [[Vice City]] to attach and move objects along a path. These files are located in the maps/data folder in the Vice City directory. These files, which mainly contain coordinates, can be controlled by the <code>[[main.scm]]</code> script file. By default, Vice City has only one scripted path file, <code>spath0.dat</code>, which controls Cortez's yacht in the mission "All Hands On Deck!" Additional scripted path files can be created by incrementing the number at the end of the file name by one, i.e. <code>spath1.dat</code>, <code>spath2.dat</code>, etc. |
| − | Scripted paths are replaced by the binary [[Carrec|R3]] file format in [[San Andreas]] and [[GTA IV]]. | + | Scripted paths was preceded by binary <code>[[chase.dat|chase*.dat]]</code> files from [[GTA 3]] and are replaced by the binary [[Carrec|R3]] file format in [[San Andreas]] and [[GTA IV]]. |
== Format == | == Format == | ||
| − | The file starts with the number of coordinates that | + | The file starts with the number of lines coordinates that are to be read in the file. The rest of the file contains X, Y, and Z coordinates linked as a path in the game. Undefined lines of coordinates will use the center of the game (0, 0, 0) for the path. |
| − | == | + | == Scripting == |
| − | The scripted path | + | The following information uses [[Sanny Builder]] to explain how to use these files through the <code>main.scm</code> file. First, the scripted path files needs to be defined in the script file using opcode [[049C]]. |
| + | 049C: <span style="color:blue">0@</span> = scripted_path_file 0 width 5.0 | ||
| + | Next, objects need to be created either by opcode [[0107]] or [[029B]]. These objects need to be attached to the path using opcode [[049D]]. | ||
| + | 049D: attach_scripted_file <span style="color:blue">0@</span> with_object <span style="color:blue">1@</span> | ||
| + | Lastly, the attached objects can start moving along the path using opcode [[049E]]. | ||
| + | 049E: set_scripted_file <span style="color:blue">0@</span> speed_to 5.0 | ||
| + | Additional opcodes related to scripted paths include [[049F]], which warps the objects along the path instead of moving it, and opcode [[04A1]], which removes all references of the specified scripted path from the game. | ||
| − | + | == See also == | |
| − | |||
| − | |||
| − | == See | ||
* [[Carrec|Carrec.img]] | * [[Carrec|Carrec.img]] | ||
[[Category:Map Formats]][[Category:Mission_Script]][[Category:GTA VC]] | [[Category:Map Formats]][[Category:Mission_Script]][[Category:GTA VC]] | ||
Revision as of 10:34, 25 April 2010
Spath*.dat files are scripted path files used only in Vice City to attach and move objects along a path. These files are located in the maps/data folder in the Vice City directory. These files, which mainly contain coordinates, can be controlled by the main.scm script file. By default, Vice City has only one scripted path file, spath0.dat, which controls Cortez's yacht in the mission "All Hands On Deck!" Additional scripted path files can be created by incrementing the number at the end of the file name by one, i.e. spath1.dat, spath2.dat, etc.
Scripted paths was preceded by binary chase*.dat files from GTA 3 and are replaced by the binary R3 file format in San Andreas and GTA IV.
Format
The file starts with the number of lines coordinates that are to be read in the file. The rest of the file contains X, Y, and Z coordinates linked as a path in the game. Undefined lines of coordinates will use the center of the game (0, 0, 0) for the path.
Scripting
The following information uses Sanny Builder to explain how to use these files through the main.scm file. First, the scripted path files needs to be defined in the script file using opcode 049C.
049C: 0@ = scripted_path_file 0 width 5.0
Next, objects need to be created either by opcode 0107 or 029B. These objects need to be attached to the path using opcode 049D.
049D: attach_scripted_file 0@ with_object 1@
Lastly, the attached objects can start moving along the path using opcode 049E.
049E: set_scripted_file 0@ speed_to 5.0
Additional opcodes related to scripted paths include 049F, which warps the objects along the path instead of moving it, and opcode 04A1, which removes all references of the specified scripted path from the game.
