No edit summary |
No edit summary |
||
Line 90: | Line 90: | ||
**For multi-map scenarios, put these tables of each map again into a table. |
**For multi-map scenarios, put these tables of each map again into a table. |
||
|- |
|- |
||
− | | <code>difficulties</code> || || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
+ | | <code>difficulties</code> || Available difficulties for the scenario. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
+ | *<code><nowiki>{</nowiki>{standard = {{pht|boolean}}, advanced = {{pht|boolean}}, expert = {{pht|boolean}}},<nowiki>}</nowiki></code> |
||
− | *<code>{{pht|Custom text}}</code> |
||
+ | **If available: <code>true</code> |
||
+ | **If not available: <code>false</code> |
||
|- |
|- |
||
− | | <code>campaign_name</code> || || style="text-align:center;" | [[File: |
+ | | <code>campaign_name</code> || Name of the campaign story of which the scenario is part. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
*<code>{{pht|Custom text}}</code> |
*<code>{{pht|Custom text}}</code> |
||
|- |
|- |
||
− | | <code>prerequisites</code> || || style="text-align:center;" | [[File: |
+ | | <code>prerequisites</code> || Names of scenarios that need to be unlocked first to play this scenario. || style="text-align:center;" | [[File:True.svg|17px|link=|False]] || |
*<code>{{pht|Custom text}}</code> |
*<code>{{pht|Custom text}}</code> |
||
|- |
|- |
||
− | | <code>unlocks</code> || || style="text-align:center;" | [[File: |
+ | | <code>unlocks</code> || Names of scenarios that will be unlocked by winning this scenario. || style="text-align:center;" | [[File:True.svg|17px|link=|False]] || |
*<code>{{pht|Custom text}}</code> |
*<code>{{pht|Custom text}}</code> |
||
|- |
|- |
Revision as of 14:27, 26 June 2021
Description
This module stores all data about the currently existing playable maps in alphabetical order. Whenever map changes occur this module needs to be updated respectively.
- Syntax
All maps' data is stored in a standardized way as shown below.
["map name"] = { type = , map_names = {"", "", ""}, min_players = , starting_positions = , chest_positions = , quest_positions = {}, difficulties = , campaign_name = "", prerequisites = "", unlocks = "", setup_description = "", mission_briefing_description = "", loading_screen_text = "", spectator_map_available = , rankings = { { ranking_numberplayers = n(max), ranking_time = "", ranking_players = {"", ""}, ranking_date = "", ranking_difficulty = "" }, { ranking_numberplayers = 1, ranking_time = "", ranking_players = {"", ""}, ranking_date = "", ranking_difficulty = "" } } },
- Parameter and Syntax Explanation
Parameter | Explanation / Usage Notes | Omissible | Accepted Input |
---|---|---|---|
["<map name>"] |
Full name of the map. |
| |
type |
Matchmaking type. |
| |
map_names |
Enter the map tab names if scenario consists of multiple maps. |
| |
min_players |
Minimum number of players requiered for the scenario. |
| |
starting_positions |
Coordinates of starting positions. First entry represents player 1, second entry player 2, and so on. The number of entries is used to determine the maximum amount of starting players on this map. |
| |
chest_positions |
Coordinates of gold chest positions. The number of entries is used to determine the maximum amount of obtainable chests on this map. |
| |
quest_positions |
Coordinates of quest goal positions. |
| |
difficulties |
Available difficulties for the scenario. |
| |
campaign_name |
Name of the campaign story of which the scenario is part. |
| |
prerequisites |
Names of scenarios that need to be unlocked first to play this scenario. |
| |
unlocks |
Names of scenarios that will be unlocked by winning this scenario. |
| |
setup_description |
| ||
mission_briefing_description |
| ||
loading_screen_text |
| ||
spectator_map_available |
| ||
Ranking related parameters (this block repeats as many times as there are filterable rankings for the map) | |||
ranking_numberplayers |
| ||
ranking_time |
| ||
ranking_players |
| ||
ranking_date |
| ||
ranking_difficulty |
|
See also