LuaAPI: Add ShowMission convention
Thu, 04 Apr 2019 14:10:24 +0100
changeset 1718 49d91eb0c2c0
parent 1717 e0911cd9bd82
child 1719 b3b6ed1c822f
LuaAPI: Add ShowMission convention
--- a/	Thu Apr 04 13:52:44 2019 +0100
+++ b/	Thu Apr 04 14:10:24 2019 +0100
@@ -1507,6 +1507,8 @@
 `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.
+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.
 `text` uses some special characters for formatting:
 || *Special character* || *Meaning* ||