LuaAPI.wiki
changeset 645 f161ad0b976d
parent 638 9f17dc37a141
child 646 044ef16b8ac5
equal deleted inserted replaced
644:349ec30bf87c 645:f161ad0b976d
  1048 AddCaption("Melon bomb rain in 2 rounds!", 0xFF0000FF, capgrpGameState)
  1048 AddCaption("Melon bomb rain in 2 rounds!", 0xFF0000FF, capgrpGameState)
  1049 -- Green example message.
  1049 -- Green example message.
  1050 </code>
  1050 </code>
  1051 
  1051 
  1052 === <tt>!ShowMission(caption, subcaption, text, icon, time)</tt> ===
  1052 === <tt>!ShowMission(caption, subcaption, text, icon, time)</tt> ===
  1053 Use to tell the player what he is supposed to do.
  1053 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).
  1054 
  1054 
  1055 As of version 0.9.15, `icon` currently accepts the following values:
  1055 `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.
       
  1056 
       
  1057 `text` uses some special characters for formatting: “`|`” is used for a line break, and everything written before and including a “`:`” in a line is written in a lighter color.
       
  1058 
       
  1059 As of version 0.9.22, `icon` accepts the following values:
  1056 
  1060 
  1057 || *`icon`* || *What is shown* ||
  1061 || *`icon`* || *What is shown* ||
  1058 || _negative number_ || Icon of an ammo type. It is specified as the negative of an ammo type constant (see [AmmoTypes]), i.e. `-amBazooka` for the bazooka icon. ||
  1062 || _negative number_ || Icon of an ammo type. It is specified as the negative of an ammo type constant (see [AmmoTypes]), i.e. `-amBazooka` for the bazooka icon. ||
  1059 || `0` || Golden crown ||
  1063 || `0` || Golden crown ||
  1060 || `1` || Target ||
  1064 || `1` || Target ||
  1063 || `4` || Golden star ||
  1067 || `4` || Golden star ||
  1064 || `5` || Utility crate ||
  1068 || `5` || Utility crate ||
  1065 || `6` || Health crate ||
  1069 || `6` || Health crate ||
  1066 || `7` || Ammo crate ||
  1070 || `7` || Ammo crate ||
  1067 || `8` || Barrel ||
  1071 || `8` || Barrel ||
       
  1072 
       
  1073 Example:
       
  1074 <code language="lua">
       
  1075 ShowMission(loc("Nobody Laugh"), loc("User Challenge"), loc("Eliminate the enemy before the time runs out"), 0, 0)
       
  1076 </code>
  1068 
  1077 
  1069 === <tt>!HideMission()</tt> ===
  1078 === <tt>!HideMission()</tt> ===
  1070 Hides the mission. This function is currently bugged somehow and will completely ruin your life, and your script should you happen to use it.
  1079 Hides the mission. This function is currently bugged somehow and will completely ruin your life, and your script should you happen to use it.
  1071 
  1080 
  1072 === <tt>!SetZoom(zoomLevel)</tt> ===
  1081 === <tt>!SetZoom(zoomLevel)</tt> ===