Script Path

From GTAModding
Jump to: navigation, search
Vice City's spath0.dat map

A Script Path (also named Object Path) lets the script in Vice City attach objects to a path and control their movement along it. The coordinates for the path are stored in a plain text file located in .\data\paths\spath0.dat, which is used by Cortez's yacht in the mission "All Hands On Deck!" The game can read any number of script path files in the same directory (spath1.dat, spath2.dat, spath3.dat, etc.) but it can only have up to three script paths loaded at a time. Up to six objects can be attached to a script path at a time. Data on the state and properties of a loaded script path are saved in block 17 of the save file. The concept for script paths closely resembles flight paths used for airborne NPC vehicles.

Format for spath*.dat

NumNodes
X Y Z
Vice City Identifier Type Description
Section 1: Number of path nodes
A NumNodes integer The number of lines that are to be read from the file.
Section 2: Path nodes
A,B,C X, Y, Z float[3] X, Y, Z coordinates, each line linked to create a path
Repeat up to the number of path nodes

Undefined lines of coordinates will use the center of the world (0, 0, 0) as the point for the path.

Mission script

The following example explains how spath0.dat is used in the original script in Sanny Builder's format to move Cortez's yacht. First, the script path is initialized using opcode 049C.

049C: $722 = scripted_path_file 0 width 90.0

Next, objects need to be created using opcode 029B (opcode 0107 can also be used to create them).

029B: $714 = init_object #YT_MAIN_BODY at -375.499 -1322.31 9.81124
029B: $715 = init_object #YT_MAIN_BODY2 at -375.499 -1322.31 9.81124
029B: $717 = init_object #YT_DOORS14 at -375.499 -1322.31 9.81124
029B: $718 = init_object #YT_TMP_BOAT at -375.499 -1322.31 9.81124
029B: $719 = init_object #LODMAIN_BODY at -375.499 -1322.31 9.81124

These objects are attached to the path using opcode 049D.

049D: attach_scripted_file $722 with_object $714
049D: attach_scripted_file $722 with_object $715
049D: attach_scripted_file $722 with_object $717
049D: attach_scripted_file $722 with_object $718
049D: attach_scripted_file $722 with_object $719

Lastly, opcode 049E is used to prevent the yacht from moving along the path.

049E: set_scripted_file $722 speed_to 0.0

During the mission, the yacht's speed varies and is warped along the path in two occasions using opcode 049F.

049E: set_scripted_file $722 speed_to 5.0
// ...
049F: set_scripted_file $722 distance_along_path_to 2700.0

When you fail the mission, the yacht is reset back to the beginning.

049F: set_scripted_file $722 distance_along_path_to 0.0 
049E: set_scripted_file $722 speed_to 0.0

When you pass the mission, the objects and path are no longer needed so they are removed from the game using opcodes 0108 and 04A1 respectively.

0108: destroy_object $714
0108: destroy_object $715
0108: destroy_object $717
0108: destroy_object $718
0108: destroy_object $719
04A1: release_scripted_file $722

Note that if a script path is actively moving objects, replays will be disabled.

See also