Differences

This shows you the differences between two versions of the page.

--- world_setup:weapons_reference [2020/02/17 18:50] – [NOTIFYMODE] mit
+++ world_setup:weapons_reference [2020/02/17 19:11] (current) – [Weapons.txt Field Reference] mit
@@ Line 2: / Line 2: @@
 ===== Weapons.txt Field Reference ======
-Data\Weapons.txt sets up the behaviours for each weapon type on your world. The following parameters are supported ; some are only applicable to particular configurations.
+Your server's **Data\Weapons.txt** sets up the behaviours for each weapon type on your world. The following parameters are supported ; some are only applicable to particular configurations.
@@ Line 48: / Line 48: @@
 ==== PARAM ====
 This is a global parameter value that can take on different meanings depending on the Fire and Control type chosen. It is often ignored, but it's essential for MGs and a few other weapon types, for example. E.g. Param=400
-==== ITEM ====
-This is the item (ammo) required to use the weapon. If set to NONE, no ammo is required. (This is the default if this field is omitted).
-==== MAXCARRIED ====
-The amount of a weapon item that can be carried. E.g. MaxCarried=50
-==== AMMOPERLIFE ====
-Adding this field provides an alternate method for controlling how many times a player may use a particular weapon item. It overrides the Item/Ammo options. The value you provide here is the number of times the weapon can be fired until the player next dies. e.g. AmmoPerLife=3  means the weapon can be fired 3 times in each 'life'. (The count is reset if their vehicle explodes or their character dies).
-==== ENERGY ====
-This field is only required when using *settings -> Subgame -> Weapons Control Mode  set to 2.  In this mode each player has an 'energy bar', which is depleted when they receive damage and when they fire weapons. The amount of energy each weapon takes is set in this field. The total amount of energy for each player is 65000, so (ignoring any energy recharge rate), setting a weapon to Energy=32500 means it could be fired twice before the player ran out of energy.
 ==== BUILDDAMAGE ====
@@ Line 75: / Line 63: @@
 ==== VELEFFECT ====
 This controls whether the speed that the player is moving it is included in the speed that the weapon is launched at. 0 means it isn't, 1 means it is (default). E.g. VelEffect=1
+===== Ammunition & Item restrictions =====
+==== ITEM ====
+This is the item (ammo) required to use the weapon. If set to NONE, no ammo is required. (This is the default if this field is omitted).
+==== MAXCARRIED ====
+The amount of a weapon item that can be carried. E.g. MaxCarried=50
+==== AMMOPERLIFE ====
+Adding this field provides an alternate method for controlling how many times a player may use a particular weapon item. It overrides the Item/Ammo options. The value you provide here is the number of times the weapon can be fired until the player next dies. e.g. AmmoPerLife=3  means the weapon can be fired 3 times in each 'life'. (The count is reset if their vehicle explodes or their character dies).
+==== ENERGY ====
+This field is only required when using *settings -> Subgame -> Weapons Control Mode  set to 2.  In this mode each player has an 'energy bar', which is depleted when they receive damage and when they fire weapons. The amount of energy each weapon takes is set in this field. The total amount of energy for each player is 65000, so (ignoring any energy recharge rate), setting a weapon to Energy=32500 means it could be fired twice before the player ran out of energy.
 ===== Weapon Graphics & Sounds =====
@@ Line 148: / Line 151: @@
 ==== NOTIFYMODE ====
-You can use NotifyMode to have the server trigger a script function when something happens to the weapon.
+You can use NotifyMode to have the server trigger a script function when something happens to the weapon. \\
-NotifyMode = 1, means the server triggers the "WeaponHitGround" event when the weapon hits the ground (with the weapon number as param).
+**NotifyMode = 1**, means the server triggers the "WeaponHitGround" event when the weapon hits the ground (with the weapon number as param).\\
-NotifyMode = 2, means the server triggers the "WeaponHitPlayer" event when the weapon hits a player.
+**NotifyMode = 2**, means the server triggers the "WeaponHitPlayer" event when the weapon hits a player. \\
-NotifyMode = 3 activates both the above systems.
+**NotifyMode = 3** activates both the above systems.\\
 ==== RESTRICTIONS ====
-TBD
+Currently this just supports mode 1, which means the weapon is not allowed to be fired if the player is within 30m of a crow flag. Further, more configurable options will be added if/as required.
 ===== Weapons debugging and comments =====