LuaAPI: Clarify SetAmmoTexts usage: Must not be called before onGameStart was fired
authorWuzzy
Tue, 02 May 2017 17:36:48 +0100
changeset 1006 160112dc2fcf
parent 1005 02833f7365e4
child 1007 74af6339638b
LuaAPI: Clarify SetAmmoTexts usage: Must not be called before onGameStart was fired
LuaAPI.wiki
--- a/LuaAPI.wiki	Thu Apr 27 23:39:49 2017 +0100
+++ b/LuaAPI.wiki	Tue May 02 17:36:48 2017 +0100
@@ -942,7 +942,7 @@
 Changes the delay of a specified [AmmoTypes Ammo Type].
 
 ==== <tt>!SetAmmoTexts(ammoType, name, caption, description)</tt> (0.9.23) ====
-Allows you to overwrite the displayed name and tooltip descriptions of a given ammo type.
+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.