Script Path - Revision history

Spaceeinstein: add related commands

2018-08-05T13:05:48Z

add related commands

@@ Line 26: / Line 26: @@
 == Mission script ==
 The following example explains how <code>spath0.dat</code> 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.
 {{Pre|1=
@@ Line 80: / Line 95: @@
 == See also ==
-* [[Carrec|Carrec.img]]
+* {{Icon|3}} [[Chase Scene]]
 {{fdl}}

Spaceeinstein at 23:05, 16 July 2018

2018-07-16T23:05:38Z

← Older revision		Revision as of 23:05, 16 July 2018
Line 1:		Line 1:
	A '''Script Path''' (also named '''Object Path''') lets the [[main.scm\|script]] in [[Grand Theft Auto: 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 <code>\data\paths\spath0.dat</code>, 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 (<code>spath1.dat</code>, <code>spath2.dat</code>, <code>spath3.dat</code>, 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.dat\|flight]] paths used for airborne NPC vehicles.		A '''Script Path''' (also named '''Object Path''') lets the [[main.scm\|script]] in [[Grand Theft Auto: 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 <code>\data\paths\spath0.dat</code>, which is used by [[Cortez' Yacht\|Cortez's yacht]] in the mission "[[All Hands on Deck!\|All Hands On Deck!]]" The game can read any number of script path files in the same directory (<code>spath1.dat</code>, <code>spath2.dat</code>, <code>spath3.dat</code>, 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.dat\|flight]] paths used for airborne NPC vehicles.

	== Format for spath*.dat ==		== Format for spath*.dat ==
	~~<pre>~~		{{Pre\|
	NumNodes		NumNodes
	X Y Z		X Y Z
	~~</pre>~~		}}

	{\|class="wikitable center-col-1 center-col-2"		{\|class="wikitable center-col-1 center-col-2"
Line 27:		Line 27:
	== Mission script ==		== Mission script ==
	The following example explains how <code>spath0.dat</code> 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.		The following example explains how <code>spath0.dat</code> 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.
	~~<pre>~~		{{Pre\|1=
	049C: $722 = scripted_path_file 0 width 90.0		049C: $722 = scripted_path_file 0 width 90.0
	~~</pre>~~		}}

	Next, objects need to be created using opcode 029B (opcode 0107 can also be used to create them).		Next, objects need to be created using opcode 029B (opcode 0107 can also be used to create them).
	~~<pre>~~		{{Pre\|1=
	029B: $714 = init_object #YT_MAIN_BODY at -375.499 -1322.31 9.81124		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: $715 = init_object #YT_MAIN_BODY2 at -375.499 -1322.31 9.81124
Line 38:		Line 38:
	029B: $718 = init_object #YT_TMP_BOAT 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		029B: $719 = init_object #LODMAIN_BODY at -375.499 -1322.31 9.81124
	~~</pre>~~		}}

	These objects are attached to the path using opcode 049D.		These objects are attached to the path using opcode 049D.
	~~<pre>~~		{{Pre\|
	049D: attach_scripted_file $722 with_object $714		049D: attach_scripted_file $722 with_object $714
	049D: attach_scripted_file $722 with_object $715		049D: attach_scripted_file $722 with_object $715
Line 47:		Line 47:
	049D: attach_scripted_file $722 with_object $718		049D: attach_scripted_file $722 with_object $718
	049D: attach_scripted_file $722 with_object $719		049D: attach_scripted_file $722 with_object $719
	~~</pre>~~		}}

	Lastly, opcode 049E is used to prevent the yacht from moving along the path.		Lastly, opcode 049E is used to prevent the yacht from moving along the path.
	~~<pre>~~		{{Pre\|
	049E: set_scripted_file $722 speed_to 0.0		049E: set_scripted_file $722 speed_to 0.0
	~~</pre>~~		}}

	During the mission, the yacht's speed varies and is warped along the path in two occasions using opcode 049F.		During the mission, the yacht's speed varies and is warped along the path in two occasions using opcode 049F.
	~~<pre>~~		{{Pre\|
	049E: set_scripted_file $722 speed_to 5.0		049E: set_scripted_file $722 speed_to 5.0
	// ...		// ...
	049F: set_scripted_file $722 distance_along_path_to 2700.0		049F: set_scripted_file $722 distance_along_path_to 2700.0
	~~</pre>~~		}}

	When you fail the mission, the yacht is reset back to the beginning.		When you fail the mission, the yacht is reset back to the beginning.
	~~<pre>~~		{{Pre\|
	049F: set_scripted_file $722 distance_along_path_to 0.0		049F: set_scripted_file $722 distance_along_path_to 0.0
	049E: set_scripted_file $722 speed_to 0.0		049E: set_scripted_file $722 speed_to 0.0
	~~</pre>~~		}}

	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.		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.
	~~<pre>~~		{{Pre\|
	0108: destroy_object $714		0108: destroy_object $714
	0108: destroy_object $715		0108: destroy_object $715
Line 75:		Line 75:
	0108: destroy_object $719		0108: destroy_object $719
	04A1: release_scripted_file $722		04A1: release_scripted_file $722
	~~</pre>~~		}}

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

	{{fdl}}		{{fdl}}
			{{VC-navi}}
	[[Category:Map Formats]]		[[Category:Map Formats]]
	[[Category:Mission Script]]		[[Category:Mission Script]]
	~~[[Category:GTA Vice City]]~~

Spaceeinstein at 18:50, 30 June 2018

2018-06-30T18:50:30Z

← Older revision		Revision as of 18:50, 30 June 2018
Line 8:		Line 8:

	{\|class="wikitable center-col-1 center-col-2"		{\|class="wikitable center-col-1 center-col-2"
	!style="width: 3em;" \|{{Icon\|VC}}		!style="width: 3em;" \|{{Icon-square\|VC}}
	!style="width: 12em;" \|Identifier		!style="width: 12em;" \|Identifier
	!style="width: 6em;" \|Type		!style="width: 6em;" \|Type

Spaceeinstein: Spaceeinstein moved page Scripted Path to Script Path

2018-06-24T14:05:05Z

Spaceeinstein moved page Scripted Path to Script Path

← Older revision	Revision as of 14:05, 24 June 2018
(No difference)

Spaceeinstein: contributions from myself and HackMan128

2018-06-24T14:04:17Z

contributions from myself and HackMan128

@@ Line 1: / Line 1: @@
-'''Spath'''.dat files are '''scripted path''' files used only in [[Grand Theft Auto: Vice City]] to script an object onto a path that is too much to just shove into the <code>[[main.scm]]</code>. These files are located in the maps/data folder in the Vice City directory. This file contains coordinates for the <code>main.scm</code> to use. By default, Vice City has only one scripted path file, the <code>spath0.dat</code>, which controls Cortez's yacht in the mission "All Hands On Deck!"
+A '''Script Path''' (also named '''Object Path''') lets the [[main.scm|script]] in [[Grand Theft Auto: 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 <code>\data\paths\spath0.dat</code>, 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 (<code>spath1.dat</code>, <code>spath2.dat</code>, <code>spath3.dat</code>, 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.dat|flight]] paths used for airborne NPC vehicles.
-Scripted paths are replaced by the binary [[Carrec|R3]] file format in [[Grand Theft Auto: San Andreas]] and [[Grand Theft Auto IV|GTA IV]].
+== Format for spath*.dat ==
-== Format ==
+{|class="wikitable center-col-1 center-col-2"
-The file starts with the number of coordinates that will be used in the file. The rest of the file are X, Y, and Z coordinates linked as a path in the game.
+!style="width: 3em;" |{{Icon|VC}}
-== How 2.0 ==
+== Mission script ==
-The scripted path file needs to be defined in the main.scm using opcode [[049C]] in order for it to work. To attach an object onto the path, first define the object. Create the object using the opcode [[029B]]. Attach the object onto the path using the opcode [[049D]]. You can attach as many object as you want onto the same path. Lastly, set the speed of the object on the path using opcode [[049E]]. To remove references to the scripted path file from the <code>main.scm</code>, use the opcode [[04A1]]. The opcode [[049F]] sets the distance you want the object to move on the path. In order to add more scripted path files, create a file named spath#, '#' being an integer in order after the last one.
+The following example explains how <code>spath0.dat</code> 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.
-== Current Usage ==
+Next, objects need to be created using opcode 029B (opcode 0107 can also be used to create them).
-Currently, the Liberty City and [[Myriad Islands]] modifications for Vice City uses this feature. In the Liberty City mod, this is used to move the train around the city. In Myriad Islands, it was briefly used in a user-made mission to move Cortez's yacht.
+<pre>
 == See also ==

A-Dust at 23:35, 20 September 2010

2010-09-20T23:35:22Z

← Older revision		Revision as of 23:35, 20 September 2010
Line 1:		Line 1:
	'''Spath'''.dat files are '''scripted path''' files used only in [[Vice City]] to script an object onto a path that is too much to just shove into the <code>[[main.scm]]</code>. These files are located in the maps/data folder in the Vice City directory. This file contains coordinates for the <code>main.scm</code> to use. By default, Vice City has only one scripted path file, the <code>spath0.dat</code>, which controls Cortez's yacht in the mission "All Hands On Deck!"		'''Spath'''.dat files are '''scripted path''' files used only in [[Grand Theft Auto: Vice City]] to script an object onto a path that is too much to just shove into the <code>[[main.scm]]</code>. These files are located in the maps/data folder in the Vice City directory. This file contains coordinates for the <code>main.scm</code> to use. By default, Vice City has only one scripted path file, the <code>spath0.dat</code>, which controls Cortez's yacht in the mission "All Hands On Deck!"

	Scripted paths are replaced by the binary [[Carrec\|R3]] file format in [[San Andreas]] and [[Grand Theft Auto IV\|GTA IV]].		Scripted paths are replaced by the binary [[Carrec\|R3]] file format in [[Grand Theft Auto: San Andreas]] and [[Grand Theft Auto IV\|GTA IV]].

	== Format ==		== Format ==

Gta-mysteries at 23:32, 20 September 2010

2010-09-20T23:32:05Z

← Older revision		Revision as of 23:32, 20 September 2010
Line 1:		Line 1:
	'''Spath'''.dat files are '''scripted path''' files used only in [[Vice City]] to script an object onto a path that is too much to just shove into the <code>[[main.scm]]</code>. These files are located in the maps/data folder in the Vice City directory. This file contains coordinates for the <code>main.scm</code> to use. By default, Vice City has only one scripted path file, the <code>spath0.dat</code>, which controls Cortez's yacht in the mission "All Hands On Deck!"		'''Spath'''.dat files are '''scripted path''' files used only in [[Vice City]] to script an object onto a path that is too much to just shove into the <code>[[main.scm]]</code>. These files are located in the maps/data folder in the Vice City directory. This file contains coordinates for the <code>main.scm</code> to use. By default, Vice City has only one scripted path file, the <code>spath0.dat</code>, which controls Cortez's yacht in the mission "All Hands On Deck!"

	Scripted paths are replaced by the binary [[Carrec\|R3]] file format in [[San Andreas]] and [[GTA IV]].		Scripted paths are replaced by the binary [[Carrec\|R3]] file format in [[San Andreas]] and [[Grand Theft Auto IV\|GTA IV]].

	== Format ==		== Format ==
Line 15:		Line 15:
	* [[Carrec\|Carrec.img]]		* [[Carrec\|Carrec.img]]

	[[Category:Map Formats]][[Category:Mission Script]][[Category:GTA Vice City]]~~{{fdl}}~~		{{fdl}}
			[[Category:Map Formats]]
			[[Category:Mission Script]]
			[[Category:GTA Vice City]]

Gtabot: /* See Also */clean up,

2010-01-23T20:28:54Z

Gboyers: 1 revision: Imported from gtamodding.com - under GNU FDL

2010-01-11T23:55:41Z

1 revision: Imported from gtamodding.com - under GNU FDL

← Older revision	Revision as of 23:55, 11 January 2010
(No difference)

gtw>Seemann@GTAM at 06:34, 25 February 2009

2009-02-25T06:34:10Z

New page

'''Spath'''.dat files are '''scripted path''' files used only in [[Vice City]] to script an object onto a path that is too much to just shove into the <code>[[main.scm]]</code>. These files are located in the maps/data folder in the Vice City directory. This file contains coordinates for the <code>main.scm</code> to use. By default, Vice City has only one scripted path file, the <code>spath0.dat</code>, which controls Cortez's yacht in the mission "All Hands On Deck!"

Scripted paths are replaced by the binary [[Carrec|R3]] file format in [[San Andreas]] and [[GTA IV]].

== Format ==
The file starts with the number of coordinates that will be used in the file. The rest of the file are X, Y, and Z coordinates linked as a path in the game.

== How 2.0 ==
The scripted path file needs to be defined in the main.scm using opcode [[049C]] in order for it to work. To attach an object onto the path, first define the object. Create the object using the opcode [[029B]]. Attach the object onto the path using the opcode [[049D]]. You can attach as many object as you want onto the same path. Lastly, set the speed of the object on the path using opcode [[049E]]. To remove references to the scripted path file from the <code>main.scm</code>, use the opcode [[04A1]]. The opcode [[049F]] sets the distance you want the object to move on the path. In order to add more scripted path files, create a file named spath#, '#' being an integer in order after the last one.

== Current Usage ==
Currently, the Liberty City and [[Myriad Islands]] modifications for Vice City uses this feature. In the Liberty City mod, this is used to move the train around the city. In Myriad Islands, it was briefly used in a user-made mission to move Cortez's yacht.

== See Also ==
* [[Carrec|Carrec.img]]

[[Category:Map Formats]][[Category:Mission_Script]][[Category:GTA VC]]{{fdl}}

← Older revision		Revision as of 20:28, 23 January 2010
Line 12:		Line 12:
	Currently, the Liberty City and [[Myriad Islands]] modifications for Vice City uses this feature. In the Liberty City mod, this is used to move the train around the city. In Myriad Islands, it was briefly used in a user-made mission to move Cortez's yacht.		Currently, the Liberty City and [[Myriad Islands]] modifications for Vice City uses this feature. In the Liberty City mod, this is used to move the train around the city. In Myriad Islands, it was briefly used in a user-made mission to move Cortez's yacht.

	== See ~~Also~~ ==		== See also ==
	* [[Carrec\|Carrec.img]]		* [[Carrec\|Carrec.img]]

	[[Category:Map Formats]][[Category:~~Mission_Script~~]][[Category:GTA VC]]{{fdl}}		[[Category:Map Formats]][[Category:Mission Script]][[Category:GTA Vice City]]{{fdl}}