Streamed Script

From GTAMods Wiki
Revision as of 13:59, 3 February 2015 by Link2012 (talk | contribs) (Link2012 moved page External Script to Streamed Scripts: native name)
Jump to navigation Jump to search

An external script is a script file used only in San Andreas that is outside the main script file, the main.scm. An external script is a compiled binary file having an extension .scm. It contains the opcodes which are parsed by the game in the same way as the ones located at the main.scm. The difference from an ordinary SCM file is that an external script has no header. All the info about it is compiled at the main.scm header.
External scripts are located in the script.img file in the data/script folder. The file is usually decompiled along with the main.scm. 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

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

You can use the following opcodes to do stuff to your script file.
07D3 - I don't know how this work
0884 - Or this
08A9 - Loads the external script
08AB - Checks if the external script has been loaded
08E8 - Assigns an external script to a ped's model
090F - Ends the external script (doesn't seem to work)
0910 - Releases an external script from the memory (not tested!)
0913 - Runs the external script after it has been loaded
0914 - No operation in PC and XBox versions
091C - Gets an actor within a sphere of the object using an external script
0926 - Gets the status of the external script, 0 if not loaded
0928 - Activates the external script when near the ped's model
0929 - Activates the external script when near the object's model

Problems

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.

See also