Update AddCaption
authoralmikes@aol.com
Tue, 28 Jul 2015 10:17:08 +0000
changeset 561 814f54a83d06
parent 560 d0c74d14c7b6
child 562 89d9153aaf4f
Update AddCaption
LuaAPI.wiki
--- a/LuaAPI.wiki	Tue Jul 28 10:03:22 2015 +0000
+++ b/LuaAPI.wiki	Tue Jul 28 10:17:08 2015 +0000
@@ -923,7 +923,19 @@
 == Functions affecting the GUI ==
 
 === <tt>!AddCaption(text)</tt> ===
-Display event text in the upper part of the screen.
+Display an event text in the upper part of the screen. The text will be white and the caption group will be `capgrpMessage`.
+
+=== <tt>!AddCaption(text, color, captiongroup)</tt> ===
+Display an event text in the upper part of the screen with the specified [LuaAPI#Color color] and caption group.
+
+|| *`captiongroup`* || *Meaning* ||
+|| `capgrpGameState` || Used for important global game events, like Sudden Death ||
+|| `capgrpAmmoinfo` || Used for new weapon crates and some other events ||
+|| `capgrpVolume` || Used when adjusting volume ||
+|| `capgrpMessage` || Generic message ||
+|| `capgrpMessage2` || Generic message ||
+|| `capgrpAmmostate` || Used to show information about weapon state, i.e. bounce level, timer, remaining shots, etc. ||
+
 
 === <tt>!ShowMission(caption, subcaption, text, icon, time)</tt> ===
 Use to tell the player what he is supposed to do.