LuaGameplay: Fix misleading AddAmmo help draft
authorWuzzy
Sun, 08 Sep 2019 21:59:37 +0100
changeset 1971 210ad26e9e94
parent 1970 c85f6f3bb16c
child 1972 71f061ea3941
LuaGameplay: Fix misleading AddAmmo help
LuaGameplay.wiki
--- a/LuaGameplay.wiki	Sun Sep 08 21:55:45 2019 +0100
+++ b/LuaGameplay.wiki	Sun Sep 08 21:59:37 2019 +0100
@@ -176,7 +176,7 @@
 === <tt>!AddAmmo(gearUid, ammoType [, ammoCount])</tt> ===
 Adds or sets the amount of ammo to the specified hedgehog gear.
 
-If `ammoCount` is `nil`, then X ammos of the type `ammoType` will be added to `gearUid`, where X is determined by the `numberInCrate` argument passed via `SetAmmo()` in the `onAmmoStoreInit()` [LuaEvents event handler]. Note that `numberInCrate` defaults to 0 if `SetAmmo()` was not called for the ammo type before.
+If `ammoCount` is `nil`, then X ammos of the type `ammoType` will be added to `gearUid`, where X equals the “number in crate” setting of the weapon scheme, or, if `onAmmoStoreInit()` is used, X equals the `numberInCrate` argument passed via `SetAmmo()` in the `onAmmoStoreInit()` [LuaEvents event handler]. Note that if you use `onAmmoStoreInit()`, `numberInCrate` defaults to 0 if `SetAmmo()` was not called for the ammo type before.
 
 If `ammoCount` is a number, the ammo will *not* be added, but instead set to `ammoCount`. A value of `0` will remove the ammo, a value of `AMMO_INFINITE` will set it to infinite.