This is an old revision of the document!
Minigames & Weapons Overview
Introduction to Weapons
Weapons on your world are created using a combination of settings, the weapons definition file and (optionally) 3d models.
1. Whether your world allows weapons, or not. To enable weapons on your world you need to set a global World Setting called Fighting.
*settings → World Rules → Fighting
If you set it to 0, weapons will be disabled. If you set it to 1, weapons will be enabled.
2. Whether weapons work everywhere or just in certain places. This is determined by the Surface Properties of your world - see Weapon Surface Properties. By default, weapons will be allowed everywhere as long as you have set Fighting to 1, as above, and you haven't altered any of the surface properties.
3. How people on your world are allowed to use weapons. You have two options. You can make the weapons people can use depend on the vehicle they are currently in. Or, you can let anyone use any weapon as long as they own the relevant weapon ammo. This is determined by a global World Setting called Weapon Selection Mode, and is set in the usual way through the settings menu (type *settings, choose World Settings, and scroll down to Weapon Selection Mode).
If you set it to 0, the weapons a player can use will depend on which vehicle they are in. If you set it to 1, players will be able to use any weapon item that is currently in their inventory.
4. Which vehicle uses which weapon. This only applies if you have Weapon Selection Mode set to 0 (see above). By default, each vehicle on your world can have two weapons: a Primary and a Secondary. This is set for each vehicle in the Vehicle Settings menu. On your world, type *settings and choose Vehicle Settings. Scroll down to the relevant Primary or Secondary weapon setting for each vehicle, and set it to a number between 1 and 48. That's the weapon number it will use. The number corresponds to the weapon numbers in the Weapon Script.
There are also some more advanced modes that allow more than two weapons per vehicle. These are explained in Weapons Control Mode.
5. Which controls a player must use to fire different weapons. By default, a vehicle will fire its Primary weapon when a player presses the Tab key, and fire its secondary weapon when a player presses Shift + Tab at the same time.
There are a few other options for setting the “fire” key for weapons, as well as other modes that allow more than two weapons per vehicle. Which mode you use depends to a large extent on what kind of game you're trying to create. These options are explained in Weapons Control Mode.
6. How each weapon works and what effect it has. How quickly does a weapon fire? How much damage does it do? What's the reload time? All this and more is determined by the parameters set in your Weapon Script.
7. What each weapon looks like. This is determined by a combination of the settings in your Weapon Script and the 3d models and textures you assign in your world server. See the sections on Changing Weapon Graphics, and Weapon Script Parameters.