# HG changeset patch
# User almikes@aol.com
# Date 1438078628 0
# Node ID 814f54a83d069536d1295436ee390eddf075e074
# Parent d0c74d14c7b66d7aba54b1f6ca8ae0751bfaacde
Update AddCaption
diff -r d0c74d14c7b6 -r 814f54a83d06 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 ==
=== !AddCaption(text) ===
-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`.
+
+=== !AddCaption(text, color, captiongroup) ===
+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. ||
+
=== !ShowMission(caption, subcaption, text, icon, time) ===
Use to tell the player what he is supposed to do.