ConfigurationFiles.wiki
changeset 578 b362aae4143f
parent 575 d6959c32b909
child 580 79ecca48492f
--- a/ConfigurationFiles.wiki	Thu Jul 30 22:40:11 2015 +0000
+++ b/ConfigurationFiles.wiki	Thu Jul 30 22:51:31 2015 +0000
@@ -158,4 +158,14 @@
 _TO BE WRITTEN_
 
 == {{{[Campaign%20<CAMPAIGN_NAME>]}}} ==
-This section stores campaign variables which are stored and read by Lua scripts. Replace “`<CAMPAIGN_NAME>` with the folder name of the campaign. Example: The section for “A Classic Fairytale” would be “`[Campaign%20A_Classic_Fairytale]`”.
\ No newline at end of file
+This section stores campaign variables which are stored and read by Lua scripts. Replace “`<CAMPAIGN_NAME>` with the folder name of the campaign. Example: The section for “A Classic Fairytale” would be “`[Campaign%20A_Classic_Fairytale]`”.
+
+Campaign variables are stored on a key-value basis, where the key is the name of the campaign variable and the value is the value of the campaign variable.
+
+Campaign variable names and their values can are chosen by the Lua script authors, but there are some special variables which are used to determine which missions are available in the main menu:
+
+|| *Setting* || *Type* || *Description* ||
+|| `Progress` || Integer || If present, this number of missions is unlocked in the menu, starting with the first mission and continuing with the following missions in their regular order (as specified in `campaign.ini`. ||
+|| `UnlockedMissions` || Integer || An alternative way to store the unlocked missions in the main menu if the missions aren't unlocked in the regular order. This number specifies how many missions are unlocked. If this variable is set, then the variables `Mission1`, `Mission2`, etc. must be used to specfify the IDs of the unlocked missions. ||
+|| `Mission1` || Integer || The `campaign.ini` ID of the first unlocked mission, must be used together with `UnlockedMissions` ||
+|| `Mission2` || Integer || ID of the second unlocked mission (continues with `Mission3`, `Mission4`, and so on) ||
\ No newline at end of file