LuaAPI.wiki
changeset 1718 49d91eb0c2c0
parent 1717 e0911cd9bd82
child 1720 fca8c324b341
equal deleted inserted replaced
1717:e0911cd9bd82 1718:49d91eb0c2c0
  1505 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.
  1505 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.
  1506 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.
  1506 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.
  1507 
  1507 
  1508 `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.
  1508 `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.
  1509 
  1509 
       
  1510 By convention, `caption` should *normally* contain the name of the game style or mission and `subcaption` should *normally* contain the type of game style or mission, or a witty tagline. But this is only a loose convention which you don't have to follow all the time.
       
  1511 
  1510 `text` uses some special characters for formatting:
  1512 `text` uses some special characters for formatting:
  1511 
  1513 
  1512 || *Special character* || *Meaning* ||
  1514 || *Special character* || *Meaning* ||
  1513 || `|` || Line break ||
  1515 || `|` || Line break ||
  1514 || `:` || Highlight itself and all text before that character in this line. The colon itself will be written. ||
  1516 || `:` || Highlight itself and all text before that character in this line. The colon itself will be written. ||