LuaAPI: Better ShowMission/HideMission texts
authorWuzzy
Thu, 09 Jun 2016 13:59:43 +0100
changeset 894 aa3027b760bb
parent 893 e8664c10f69b
child 895 9db173fcf26e
LuaAPI: Better ShowMission/HideMission texts
LuaAPI.wiki
--- a/LuaAPI.wiki	Thu Jun 09 13:56:22 2016 +0100
+++ b/LuaAPI.wiki	Thu Jun 09 13:59:43 2016 +0100
@@ -1108,8 +1108,10 @@
 </code>
 
 === <tt>!ShowMission(caption, subcaption, text, icon, time)</tt> ===
-Use to tell the player what he is supposed to do. If you use this function, a mission pop-up is shown for the amount of time specified in `time` (in milliseconds). If `time` is set to 0, it will be displayed for a default amount of time.
-This function replaces the *entire* text of the pop-up. Compare this to the global `Goals` variable, which *adds* to the default text without replacing it.
+This function will open the mission panel and set the texts in it.
+
+Use to tell the player what he/she is supposed to do. If you use this function, a mission panel is shown for the amount of time specified in `time` (in milliseconds). If `time` is set to 0, it will be displayed for a default amount of time.
+This function replaces the *entire* text of the mission panel. Compare this to the global `Goals` variable, which *adds* to the default text without replacing it.
 
 `caption` is the text displayed in the first line, `subcaption` is displayed in the second line and `text` is the text displayed in the third and following lines.
 
@@ -1135,7 +1137,7 @@
 </code>
 
 === <tt>!HideMission()</tt> ===
-Hides the mission. This function is currently bugged somehow and will completely ruin your life, and your script should you happen to use it.
+Hides the mission panel if it is currently displayed, otherwise, this function does nothing.
 
 === <tt>!SetZoom(zoomLevel)</tt> ===
 Sets the zoom level. The value for maximum zoom is currently 1.0 and for minimum 3.0 The default zoom level is 2.0