LuaAPI: Add showExtra for SetAmmoTexts
Tue, 04 Dec 2018 00:03:52 +0000
changeset 1643 2aa0735e0c32
parent 1642 e8da1dd5c93c
child 1644 009208830d85
LuaAPI: Add showExtra for SetAmmoTexts
--- a/	Tue Dec 04 00:01:16 2018 +0000
+++ b/	Tue Dec 04 00:03:52 2018 +0000
@@ -1136,13 +1136,14 @@
 ==== <tt>!SetAmmoDelay(ammoType, delay)</tt> ====
 Changes the delay of a specified [AmmoTypes Ammo Type].
-==== <tt>!SetAmmoTexts(ammoType, name, caption, description)</tt> (0.9.23) ====
+==== <tt>!SetAmmoTexts(ammoType, name, caption, description [, showExtra])</tt> (0.9.23) ====
 Allows you to overwrite the displayed name and tooltip descriptions of a given ammo type. This function must only be called either inside the `onGameStart` callback function, or after the engine has called `onGameStart`.
  * `ammoType`: The ammo type to set the text for
  * `name`: Name of the ammo type (e.g. “Grenade” for `amGrenade`), affects both name in ammo menu and in the “ticker” message on the screen top.
  * `caption`: The second line in the ammo menu (below the title). E.g. “Timed grenade” for `amGrenade`.
  * `description`: Description text in ammo menu, below the caption.
+ * `showExtra`: If `false` the special “extra” text line like “Weapon is not yet available” or “Weapon does not end turn” will be suppressed
 `title`, `caption`, `description` can be `nil`, in which case they will be reverted to the engine default value. This function returns `nil`.