LuaAPI: Update special escape characters for ShowMission
authorWuzzy
Thu, 04 Apr 2019 13:50:56 +0100
changeset 1715 5cac9aadcc27
parent 1714 749b203b1fd7
child 1716 029712a337ba
LuaAPI: Update special escape characters for ShowMission
LuaAPI.wiki
--- a/LuaAPI.wiki	Tue Apr 02 15:54:02 2019 +0100
+++ b/LuaAPI.wiki	Thu Apr 04 13:50:56 2019 +0100
@@ -179,7 +179,7 @@
 || `SuddenDeathTurns` || `15` || Number of rounds until Sudden Death begins, _after the first round is over_. E.g. 0 = SD starts in 2nd round ||
 || `WaterRise` || `47` || Height of water rise in pixels for each Sudden Death turn ||
 || `HealthDecrease` || `5` || Amount of health decreased on each turn in Sudden Death ||
-|| `Goals` || `""` || Use this to add additional text to the goal text popup shown at the beginning and when using the quit or pause keys. The text is added to the default text which usually explains the game modifiers and does not replace it. Use `|` for line breaks. Also, all text before and including a `:` in a line will be highlighted. See also `ShowMission`. ||
+|| `Goals` || `""` || Use this to add additional text to the goal text popup shown at the beginning and when using the quit or pause keys. The text is added to the default text which usually explains the game modifiers and does not replace it. The text supports the same special characters as in `ShowMission` ||
 || `WorldEdge` || `weNone` || Type edges being used at the left and right sides of the terrain (see below). ||
 || `ScreenWidth` || _N/A_ || Width of the Hedgewars window or screen ||
 || `ScreenHeight` || _N/A_ || Height of the Hedgewars window or screen ||
@@ -1507,7 +1507,14 @@
 
 `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.
 
-`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.
+`text` uses some special characters for formatting:
+
+|| Special character || Meaning ||
+|| `|` || Line break ||
+|| `:` || Highlight itself and all text before that character in this line. The colon itself will be written. ||
+|| `::` || Like above, except the two colons will not be written. ||
+|| `\|` || Will be replaced with “:” without triggering highlighting (escape sequence) ||
+|| `\:` || Will be replaced with “|” without triggering a line break (escape sequence) ||
 
 `icon` accepts the following values: