Difference between revisions of "Streamed Script"

From GTAMods Wiki
Jump to navigation Jump to search
m (Seemann moved page Streamed Scripts to Streamed Script: singular form preferred)
(wrong IV category removed)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
An '''external script''' is a script file used only in San Andreas that is outside the main script file, the <code>[[main.scm]]</code>. An external script is a compiled binary file having an extension <code>.scm</code>. It contains the opcodes which are parsed by the game in the same way as the ones located at the <code>main.scm</code>. The difference from an ordinary SCM file is that an external script has no header. All the info about it is compiled at the <code>main.scm</code> header.<br>
+
A '''streamed script''' is a script file that is streamed on demand, only when the script needs to be executed. They are stored in the [[script.img]] file. It contains the opcodes which are parsed by the game in the same way as the ones located in usual scripts, except that it has no header.
−
External scripts are located in the <code>[[script.img]]</code> file in the <code>data/script</code> folder. The file is usually decompiled along with the <code>main.scm</code>. The maximum number of external scripts that can be defined is 82. The maximum number of external scripts that can be used simultaneously is 70. The game currently has 78 defined external scripts.
 
  
−
==Tutorial==
+
== GTA San Andreas ==
 +
The file is located in the <code>data/script/</code> directory and is loaded by [[gta.dat]].
 +
 
 +
The maximum number of streamed scripts that can be defined is 82. The maximum number of streamed scripts that can be used simultaneously is 70. The game currently has 78 defined streamed scripts.
 +
 
 +
===Tutorial===
 
In order to add more external script files, you have to define the number of files you are going to use:<br>
 
In order to add more external script files, you have to define the number of files you are going to use:<br>
 
<code>DEFINE EXTERNAL_SCRIPTS 78</code><br>
 
<code>DEFINE EXTERNAL_SCRIPTS 78</code><br>
Line 11: Line 15:
 
{{incomplete}}
 
{{incomplete}}
  
−
==Opcodes==
+
===Opcodes===
−
You can use the following opcodes to do stuff to your script file.<br>
+
* [[07D3]] - Adds a script brain for peds.
−
[[07D3]] - I don't know how this work<br>
+
* [[0884]] - Adds a script brain for peds triggered by attractors.
−
[[0884]] - Or this<br>
+
* [[08A9]] - Loads a streamed script.
−
[[08A9]] - Loads the external script<br>
+
* [[08AB]] - Checks if the streamed script has been loaded.
−
[[08AB]] - Checks if the external script has been loaded<br>
+
* [[08E8]] - Attaches an animation to a ped model.
−
[[08E8]] - Assigns an external script to a ped's model<br>
+
* [[090F]] - Marks a previously loaded streamed script as no longer needed.
−
[[090F]] - Ends the external script (doesn't seem to work)<br>
+
* [[0910]] - Frees an streamed script from the memory (shouldn't be used).
−
[[0910]] - Releases an external script from the memory (not tested!)<br>
+
* [[0913]] - Runs the streamed script (needs to be loaded first).
−
[[0913]] - Runs the external script after it has been loaded<br>
+
* [[091C]] - Gets an ped using an attractor with the specified model and in the specified area.
−
[[0914]] - No operation in PC and XBox versions<br>
+
* [[0926]] - Gets the number of instances of a script.
−
[[091C]] - Gets an actor within a sphere of the object using an external script<br>
+
* [[0928]] - Tells the engine to start a streamed script when the player is within the range of the specified ped.
−
[[0926]] - Gets the status of the external script, 0 if not loaded<br>
+
* [[0929]] - Tells the engine to start a streamed script when the player is within the range of the specified model.
−
[[0928]] - Activates the external script when near the ped's model<br>
+
 
−
[[0929]] - Activates the external script when near the object's model<br>
+
===Problems===
 +
There is one main problem with streamed scripts: the script doesn't work if you save while the script is running. If you reload the game, the streamed script will be disabled. You have to force the script to end before saving to prevent this from happening.
  
−
==Problems==
+
== GTA IV ==
−
There is one main problem with external scripts: the script doesn't work if you save while the script is running. If you reload the game, the external script will be disabled. You have to force the script to end before saving to prevent this from happening.
+
{{incomplete}}
  
 
==See also==
 
==See also==
−
*[[Script.img#San Andreas|List of external scripts]]
+
* [[Resource Streaming]]
 +
* [[SCM]]
 +
* [[Script.img#San Andreas|List of streamed scripts]]
  
−
[[Category:GTA SA]][[Category:Mission Script]]
+
{{N|SA|IV}}
 +
[[Category:Mission Script]]

Latest revision as of 22:58, 5 February 2015

A streamed script is a script file that is streamed on demand, only when the script needs to be executed. They are stored in the script.img file. It contains the opcodes which are parsed by the game in the same way as the ones located in usual scripts, except that it has no header.

GTA San Andreas

The file is located in the data/script/ directory and is loaded by gta.dat.

The maximum number of streamed scripts that can be defined is 82. The maximum number of streamed scripts that can be used simultaneously is 70. The game currently has 78 defined streamed scripts.

Tutorial

In order to add more external script files, you have to define the number of files you are going to use:
DEFINE EXTERNAL_SCRIPTS 78
Add the external script to the list with this:
DEFINE SCRIPT NAME AT LABEL
At the end of the file add your code in.

This section is incomplete. You can help by fixing and expanding it.

Opcodes

  • 07D3 - Adds a script brain for peds.
  • 0884 - Adds a script brain for peds triggered by attractors.
  • 08A9 - Loads a streamed script.
  • 08AB - Checks if the streamed script has been loaded.
  • 08E8 - Attaches an animation to a ped model.
  • 090F - Marks a previously loaded streamed script as no longer needed.
  • 0910 - Frees an streamed script from the memory (shouldn't be used).
  • 0913 - Runs the streamed script (needs to be loaded first).
  • 091C - Gets an ped using an attractor with the specified model and in the specified area.
  • 0926 - Gets the number of instances of a script.
  • 0928 - Tells the engine to start a streamed script when the player is within the range of the specified ped.
  • 0929 - Tells the engine to start a streamed script when the player is within the range of the specified model.

Problems

There is one main problem with streamed scripts: the script doesn't work if you save while the script is running. If you reload the game, the streamed script will be disabled. You have to force the script to end before saving to prevent this from happening.

GTA IV

This section is incomplete. You can help by fixing and expanding it.

See also

v · d · e
San Andreas Grand Theft Auto: San Andreas
File Formats.b • .col • .cfg • .cut • .dff • .dat • .fxp • .gxt • .ide • .ifp • .img • .ipl • nodes*.dat • .ped • .rep • .rrr • .scm • .set • .txd
DocumentationAudio • Cryptography • Cutscenes • Game memory • Handling.cfg • Map Listing • Mission Packs • Instructions • Paths • Replays • Saves • Scripts • Sound Effects • Statistics • Vehicles • Wanted levels
ToolsCLEO • Collision File Editor II • ENBSeries • G-Tools • IMG Tool • Limit Adjuster • Map Editor • Mod Loader • San Andreas Audio Toolkit • Sanny Builder • TXD Workshop • Magic.TXD
TutorialsSan Andreas v2.0 Modding • How to create a mission • How to create a script • How to use Map Editor • Vehicle Mod Installation
ModificationsDesign Your Own Mission • Gostown Paradise • GTA: United • Myriad Islands
MultiplayergtaTournament • Multi Theft Auto • San Andreas Multiplayer • (more...)
Useful linksCommunity Portal • Discussion Forums • Modding Forums • Mods on GTAGarage.com • Mobile Modding • Opcodes Database
v · d · e
GTA IV Grand Theft Auto IV
File Formats.dat • .gxt • .ide • .img • .ipl • .nod • .sco • .rpf • .rrr • .wad • .wbd/.wbn • .wdd • .wdr • .wft • .whm • .wpl • .wtd
DocumentationAudio • Bink Video • Cryptography • Cutscenes • GXT Text • Image listing • Keycodes • Map Listing • Native functions • Paths • Radar Blips • Radio Stations • Saves • Scenarios • VTable • Weapons
ToolsASI Loader • ENBSeries • G-Texture • GIMS IV • Ingame WPL Editor • IV Needle • OpenIV • SparkIV • XLiveLess • WPL Manager • X Mod Installer
Alice • C++ Script Hook • .NET Script Hook • Scocl
TutorialsImporting Textures with OpenIV • Importing Textures with SparkIV
ModificationsGostown IV • Four Multiplayer • IV Multiplayer • CitizenMP:IV Reloaded
Useful linksCommunity portal • Discussion forums • Modding forums • Mods on GTAGarage.com
Retrieved from "https://gtamods.com/mediawiki/index.php?title=Streamed_Script&oldid=12998"