LuaGameplay: Add SetAmmoSlot draft
authorWuzzy
Fri, 21 Jun 2019 23:45:42 +0100
changeset 1940 37a2cc377a4f
parent 1939 0cb80de3d5bb
child 1941 c11105f7579a
LuaGameplay: Add SetAmmoSlot
LuaGameplay.wiki
--- a/LuaGameplay.wiki	Fri Jun 21 23:26:34 2019 +0100
+++ b/LuaGameplay.wiki	Fri Jun 21 23:45:42 2019 +0100
@@ -181,6 +181,13 @@
 === <tt>!GetAmmoName(ammoType [, ignoreOverwrite ])</tt> (0.9.23) ===
 Returns the localized name for the specified `ammoType`, taking an ammo name overwritten by `SetAmmoTexts` into account. If `ignoreOverwrite` is `true`, this function will always return the original ammo name of the weapon and ignores names which may have been overwritten by `SetAmmoTexts`.
 
+=== <tt>!SetAmmoSlot(ammoType, slot)</tt> (1.0.0) ===
+Sets the slot number of `ammoType` to the given `slot` (counting starts from 1).
+
+Use with care! It is your responsibility that each ammo slot does not hold more weapons than the maximum ammo menu width, otherwise, crashes are possible. Test with a full ammo menu to be sure.
+
+Use this function only if you absolutely must! For usability reasons and to help the player's muscle memory, we should normally not re-arrange the weapons. This function was actually only created for the “Frenzy” game style in which we needed to re-arrange the ammo slots to give each weapon an unique ammo slot.
+
 == Map ==
 === <tt>!MapHasBorder()</tt> ===
 Returns `true`/`false` if the map has a border or not.