383 |
383 |
384 || *Setting* || *Type* || *Description* || |
384 || *Setting* || *Type* || *Description* || |
385 || `Progress` || Integer || Since version 0.9.23, this variable stands for the number of completed missions in a linear campaign, starting with mission 1. For each completed mission, the next one gets unlocked. Previous versions have a slightly trickier definition: If present, this number of missions _additional to the first mission_ are unlocked in the menu, starting with the second mission and continuing with the following missions in their regular order (as specified in `campaign.ini`). If the number is `0`, only the first mission is available. || |
385 || `Progress` || Integer || Since version 0.9.23, this variable stands for the number of completed missions in a linear campaign, starting with mission 1. For each completed mission, the next one gets unlocked. Previous versions have a slightly trickier definition: If present, this number of missions _additional to the first mission_ are unlocked in the menu, starting with the second mission and continuing with the following missions in their regular order (as specified in `campaign.ini`). If the number is `0`, only the first mission is available. || |
386 || `UnlockedMissions` || Integer || 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. || |
386 || `UnlockedMissions` || Integer || 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. || |
387 || `MissionX` || Integer || E.g. `Mission1`, `Mission2`, etc. Contains the `campaign.ini` ID of the `X`th unlocked mission, must be used together with `UnlockedMissions` || |
387 || `MissionX` || Integer || E.g. `Mission1`, `Mission2`, etc. Contains the `campaign.ini` ID of the `X`th unlocked mission, must be used together with `UnlockedMissions` || |
388 || `MissionXWon` || Boolean || Since 0.9.23. E.g. `Mission1Won`, `Mission2Won`, etc. If `true`, the mission with the number `X` in `campaign.ini` has been completed. || |
388 || `MissionXWon` || Boolean || E.g. `Mission1Won`, `Mission2Won`, etc. If `true`, the mission with the number `X` in `campaign.ini` has been completed. || |
389 || `Won` || Boolean || Since 0.9.23. If `true`, the team has completed the campaign. Note that campaign victory is completely seperate from mission victory, so this setting must be set seperately. || |
389 || `Won` || Boolean || If `true`, the team has completed the campaign. Note that campaign victory is completely separate from mission victory, so this setting must be set seperately. || |
390 |
390 |
391 By default, the first mission (Mission 1 in `campaign.ini`) is available. |
391 By default, the first mission (Mission 1 in `campaign.ini`) is available. |
392 |
392 |
393 ==== Examples ==== |
393 ==== Examples ==== |
394 Simple campaign with 10 missions, missions 1-5 are available and missions 1-4 count as completed: |
394 Simple campaign with 10 missions, missions 1-5 are available and missions 1-4 count as completed: |
421 [Campaign%20Another_Campaign] |
421 [Campaign%20Another_Campaign] |
422 Progress=2 |
422 Progress=2 |
423 MyCustomVariable=54 |
423 MyCustomVariable=54 |
424 MyCustomString=Hedgewars |
424 MyCustomString=Hedgewars |
425 }}} |
425 }}} |
|
426 |
|
427 === {{{[Mission%20<MISSION_NAME>]}}} === |
|
428 This section stores mission variables. Mission variables are very similar to campaign variables, but they are for single missions (training/challenge/scenario) that are not part of a campaign. Replace “`<MISSION_NAME>` with the file name of the mission. |
|
429 |
|
430 Like campaign variables, mission variables are stored on a key-value basis. You can choose custom names but there are also a few special key names with a special meaning. |
|
431 |
|
432 `Won` is to mark victory and it's often useful to be used together with `onGameResult`. The other special keys are to store challenge records. Use these only when they make sense. |
|
433 |
|
434 || *Setting* || *Type* || *Description* || |
|
435 || `Won` || Boolean || If `true`, the team has completed the mission. || |
|
436 || `Highscore` || Integer || Best score in this mission, where higher = better || |
|
437 || `Lowscore` || Integer || Best score in this mission, where lower = better || |
|
438 || `TimeRecord` || Integer || Best time in this mission, where faster = better || |
|
439 || `TimeRecordHigh` || Integer || Best time in this mission, where longer = better || |
|
440 || `AccuracyRecord` || Integer || Highest accuracy in this mission in percent || |
|
441 |
|
442 By default, the first mission (Mission 1 in `campaign.ini`) is available. |