LuaAPI: Move non-gear related ammo functions to new section
authorWuzzy
Wed, 09 Nov 2016 14:16:43 +0000
changeset 912 ea13b02292c5
parent 911 eaafb853db57
child 913 33b5b51f54d6
LuaAPI: Move non-gear related ammo functions to new section
LuaAPI.wiki
--- a/LuaAPI.wiki	Wed Nov 09 14:15:20 2016 +0000
+++ b/LuaAPI.wiki	Wed Nov 09 14:16:43 2016 +0000
@@ -741,25 +741,6 @@
 === <tt>!SetGearFriction(gearUid, Friction) </tt> ===
 Sets the friction of the specified gear. The friction normally determines how well the gear will slide on terrain. Higher values are for increased sliding properties. `0` is for no sliding whatsoever, where `9999` is for very long slides, greater values are not recommended.
 
-=== <tt>!SetAmmo(ammoType, count, probability, delay, numberInCrate)</tt> ===
-This updates the settings for a specified [AmmoTypes Ammo Type] as of count available for players, spawn probability, availability delay in turns, and the number available in crates. This is supposed to be used in the `onAmmoStoreInit()` event handler.
-
-Example:
-
-<code language="lua">    SetAmmo(amShotgun, 9, 0, 0, 0) -- unlimited amount of shotgun ammo for players
-    SetAmmo(amGrenade, 0, 0, 0, 3) -- crates should contain always three grenade</code>
-
-=== <tt>!SetAmmoDelay(ammoType, delay)</tt> ===
-Changes the delay of a specified [AmmoTypes Ammo Type].
-
-=== <tt>!AddAmmo(gearUid, ammoType, ammoCount) (0.9.16) </tt> ===
-Adds `ammoType` to the specified gear. The amount added is determined by the arguments passed via `SetAmmo()` in the `onAmmoStoreInit()` event handler. In 0.9.16 ammo can be set directly via the optional third parameter, `ammoCount`. A value of 0 will remove the weapon, a value of 100 will give infinite ammo.
-
-*Note:* The effectiveness of this function may be limited due to problems with `gfPerHogAmmo` in Lua scripting.
-
-=== <tt>!GetAmmoName(ammoType)</tt> (0.9.23) ===
-Returns the localized name for the specified `ammoType`.
-
 === <tt>!SetHealth(gearUid, health)</tt> ===
 Sets the health of the specified gear. The “health” of a gear can refer to many things, depending on the gear type.
 
@@ -931,6 +912,26 @@
 ==== <tt>!EndGame()</tt> ====
 Makes the game end.
 
+=== Ammo ===
+==== <tt>!SetAmmo(ammoType, count, probability, delay, numberInCrate)</tt> ====
+This updates the settings for a specified [AmmoTypes Ammo Type] as of count available for players, spawn probability, availability delay in turns, and the number available in crates. This is supposed to be used in the `onAmmoStoreInit()` event handler.
+
+Example:
+
+<code language="lua">    SetAmmo(amShotgun, 9, 0, 0, 0) -- unlimited amount of shotgun ammo for players
+    SetAmmo(amGrenade, 0, 0, 0, 3) -- crates should contain always three grenade</code>
+
+==== <tt>!SetAmmoDelay(ammoType, delay)</tt> ====
+Changes the delay of a specified [AmmoTypes Ammo Type].
+
+==== <tt>!AddAmmo(gearUid, ammoType, ammoCount) (0.9.16) </tt> ====
+Adds `ammoType` to the specified gear. The amount added is determined by the arguments passed via `SetAmmo()` in the `onAmmoStoreInit()` event handler. In 0.9.16 ammo can be set directly via the optional third parameter, `ammoCount`. A value of 0 will remove the weapon, a value of 100 will give infinite ammo.
+
+*Note:* The effectiveness of this function may be limited due to problems with `gfPerHogAmmo` in Lua scripting.
+
+==== <tt>!GetAmmoName(ammoType)</tt> (0.9.23) ====
+Returns the localized name for the specified `ammoType`.
+
 === Map ===
 ==== <tt>!MapHasBorder()</tt> ====
 Returns `true`/`false` if the map has a border or not.