Garage eXtender

---

What is Garage eXtender

---

Garage eXtender (GRGX) is a plugin for GTA San Andreas that adds more options and more garage slots into the game.

San Andreas have 50 slots for garages, but those slots are already used by default, so no mapper can create custom garages for their maps, that's sad...
This plugin solves this and also add more possibilites into garage system, like parking garages (as in GTA IV), new door movement styles, more garage opcodes...

Feel free to use this plugin within your mods to be capable of adding more garages into the game, I suggest you to add a link in the readme file into the GTA Forums topic, the mediafire link or the gta garage link, so if I need to update this plugin sometime you're not distributing a old version. But that's your choice, what do you think about it? ;)

Usage

---

There's two ways to create a GRGX. The first one is using a IPL file and the second way is by script (SCM, CLEO...), I wanted to give both (mappers and scripters) the hability to create garages, but of course scripters will have a higher liberty to do whatever he wants to.

Let's talk about the two ways of creating a garage.

Creating a GRGX by IPL

---

The task to create a GRGX by IPL is extremely simple, it's almost like creating a normal garage but with additional parameters.

You should put the garage creation line inside a grge section (like a normal garage) and then we're done.
The difference from the regular garage line and the grgx line is that grgx have more params, let's compare:

Regular garage line:
x1, y1, z1, x2, y2, x3, y3, z3, flags, type, name

GRGX garage line:
x1, y1, z1, x2, y2, x3, y3, z3, flags, unused, name, num_cars, grgx_type, door_style

As you can see, we just added some additional params, in that way we detect if it is a regular garage or a grgx garage being readed from the IPL!
Right, now you should ask the meaning of those params, let me explain.

Garage Flags

Door style flags

Creating a GRGX by script

---

If you didn't read the Setting it up topic yet, read it first!!!

Creating garages by script is also very simple, it uses the method used by III\VC to create garages (CREATE_GARAGE).
Just put this line where you want to create the garage: (don't duplicate the garage, the garage must be created only once!)
0219: create_garage xyz1 2497.3 -1677.37 12.1 xy2 2497.3 -1670.07 xyz3 2504.08 -1677.37 16.3375 type GRGX_HIDEOUT_GARAGE name 'TEST'

Note 1: Remember to include grgx.txt!!!
Note 2: You can also use "CREATE_GARAGE" instead of "0219: create_garage"
Note 3: The garage name must have a maximum number of 7 characteres"

This garage is at grove street, remember: you need a door!
Of course the garage name must be different for each garage, 'TEST' is just a example!
If you're asking yourself what's that 3 coordinates, type and name, please take a look at the IPL params table, it will give you a good explanation, note that type is grgx_type and not a regular type!
Now, you must be asking, how to do those cool stuff, like change the way the door movement? See the next topic, Using the garage by script.

WARNING: If you're going to create garages in a CLEO Script, please look at the topic "WARNING FOR CLEO SCRIPTS"

Using the garage by script

---

Setting it up

Before anything, you should setup your sanny builder files to work within the new garage opcodes. Follow these steps:

1. Open your Sanny Builder root folder, data folder and then sa folder (example: "C:\Program Files (x86)\Sanny Builder 3\data\sa")
2. Open opcodes.txt file and add the following lines:
   
   0219: create_garage xyz1 2497.3 -1677.37 12.1 2497.3 xy2 -1670.07 2504.08 xyz3 -1677.37 16.3375 type GRGX_RESPRAY_GARAGE name 'TEST'
021C: is_car_in_mission_garage 'TEST'
02FA: grgx_command 'TEST' DESTROY_THIS_GARAGE
0329: has_respray_happened_on_garage 'TEST'
03BB: set_garage 'TEST' door_to_rotate
03DA: set_garage 'TEST' camera_follows_player
057A: set_garage 'TEST' max_cars_to 1

   
   
3. Open sascm.ini file and add the following lines: (before insertting those lines check if any of the opcodes are already registered, if yes, remove it and then continue)
   
   0219=10,create_garage xyz1 %1d% %2d% %3d% xy2 %4d% %5d% xyz3 %6d% %7d% %8d% type %9d% name %10d%
021c=1, is_car_in_mission_garage %1d%
0329=1,has_respray_happened %1d%
03bb=1,set_garage %1d% door_to_rotate
03da=1, set_garage %1d% camera_follows_player
057a=2,set_garage %1d% max_cars_to %2d%

   
   
4. [OPTIONAL] Open keywords.txt and add the following lines:
   
   0219=CREATE_GARAGE
021C=IS_CAR_IN_MISSION_GARAGE
02FA=GRGX_COMMAND
0329=HAS_RESPRAY_HAPPENED
03BB=SET_GARAGE_DOOR_TO_ROTATE
03DA=SET_GARAGE_CAMERA_FOLLOWS_PLAYER
057A=SET_GARAGE_MAX_CARS

   
   
5. Copy the file grgx.txt into the Sanny Builder\data\sa folder
   
   0219=CREATE_GARAGE
021C=IS_CAR_IN_MISSION_GARAGE
02FA=GRGX_COMMAND
0329=HAS_RESPRAY_HAPPENED
03BB=SET_GARAGE_DOOR_TO_ROTATE
03DA=SET_GARAGE_CAMERA_FOLLOWS_PLAYER
057A=SET_GARAGE_MAX_CARS

   
   
6. You are done. Now whenever you use GRGX on your project, include the file grgx.txt by putting the following line at the top of the code:
   {$INCLUDE grgx.txt}

Garage Opcodes

With a script you can control during run-time a couple of garage aspects, like if the garage is activated, change the garage type and other stuffs.
We have new opcodes for garage management, opcodes removeds in SA but were in III\VC.

Here we are going to have a format like this: [OPCODE] COMMAND_NAME (params)

[0299] ACTIVATE_GARAGE (string)

[02B9] DEACTIVATE_GARAGE (string)

[02FA] CHANGE_GARAGE_TYPE (string, int)

[0360] OPEN_GARAGE (string)

[0361] CLOSE_GARAGE (string)

[03B0] IS_GARAGE_OPEN (string)

[03B1] IS_GARAGE_CLOSED (string)

[021B] SET_TARGET_CAR_FOR_MISSION_GARAGE (string, int)

[021C] IS_CAR_IN_MISSION_GARAGE (string)

[02FA] GRGX_COMMAND (string, int)

[0329] HAS_RESPRAY_HAPPENED_ON_GARAGE (string)

[03BB] SET_GARAGE_DOOR_TO_ROTATE (string)

[03DA] SET_GARAGE_CAMERA_FOLLOWS_PLAYER (string)

[057A] SET_GARAGE_MAX_CARS_TO (string, int)

[0219] CREATE_GARAGE

GRGX Commands

The following commands can be used with 02FA to change the behaviour of the garage or do something:

Warning for CLEO scripts

After a garage is created by a script, it is saved in a save game and all that stuff, like a create_object. So we came into a problem:
What if the user deletes your script? The garage will be lost in the save-game!!!
But we can solve this easilly by using SET_GARAGE_DEPPENDS_ON_THIS_THREAD or even SET_GARAGE_DONT_SAVE

We have another warning related with the scripter logic, when the user loads the game your script is restarted from the beggining (not if you use 0A95!), so if you came to the begging of your script again, make sure you are not going to duplicate (create again) the garage. Use 0A95 or DOES_GARAGE_EXISTS before creating the garage.

GRGX Garage Types

---

Here is a table showing the GRGX garage types, you should use the constant name if using in a script or the id if using in a IPL.

Garage Door Note

---

Notes taken from: http://www.gtamodding.com/index.php?title=GRGE

• The garage door only opens if the IDE flag value of the door is 2048 and the door is defined in the object.dat file.
• Garage doors are very important for the camera rotation. They control how the camera moves after you have entered a garage. If your camera moves wrong, then simply rotate the pivot of your garage door, map the new one and rotate it until it fits with the rotation you want. Then test if the camera moves correctly in-game.
  
  If you have not mapped a garage door the camera will move to the west, which corresponds to a garage door rotation of 0 degrees around the z axis.
  

Save Files

---

Garage eXtender doesn't store their garages on the default San Andreas save files, there's many reason behid it but the main one is to not corrupt the save file.
The save files for grgx are stored in "GTA San Andreas User Files/grgx/%d.sav", where %d is the save slot.

Credits and Contact

---

This plugin was created by LINK/2012 <dma_2012@hotmail.com>
Visit also Brazillian Modding Studio

Please report if you find any bug!!

Thanks :)