No edit summary |
No edit summary |
||
Line 12: | Line 12: | ||
starting_positions = , |
starting_positions = , |
||
chest_positions = , |
chest_positions = , |
||
− | quest_positions = , |
+ | quest_positions = {}, |
difficulties = , |
difficulties = , |
||
campaign_name = "", |
campaign_name = "", |
||
Line 77: | Line 77: | ||
**<code><nowiki>{</nowiki>{{pht|% of x-axis}},{{pht|% of y-axis}}<nowiki>}</nowiki></code>. |
**<code><nowiki>{</nowiki>{{pht|% of x-axis}},{{pht|% of y-axis}}<nowiki>}</nowiki></code>. |
||
*If it is a multiplayer map, use a table instead: |
*If it is a multiplayer map, use a table instead: |
||
− | **<code><nowiki>{</nowiki>{{pht|set of coordinates}}, ..., {{pht|set of coordinates}}<nowiki>}</nowiki></code> |
+ | **<code><nowiki>{</nowiki>{{pht|set of coordinates 1}}, ..., {{pht|set of coordinates n}}<nowiki>}</nowiki></code> |
**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>quest_positions</code> || Coordinates of quest goal positions. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
+ | | <code>quest_positions</code> || Coordinates of quest goal positions. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
+ | *Each goal has to be organized in a table as shown below: |
||
− | *<code>letter="{{pht|letter}}", {{pht|% of x-axis}},{{pht|% of y-axis}}, "{{pht|custom tooltip text}}"</code> |
+ | **<code><nowiki>{</nowiki>letter="{{pht|letter}}", {{pht|% of x-axis}},{{pht|% of y-axis}}, "{{pht|custom tooltip text}}"<nowiki>}</nowiki></code> |
**All letters from <code>A</code> - <code>Z</code> are available. |
**All letters from <code>A</code> - <code>Z</code> are available. |
||
***When no letter parameter is given, the goal icon will be empty. |
***When no letter parameter is given, the goal icon will be empty. |
||
− | **An alternate custom tooltip that will be displayed upon hovering over the goal |
+ | **An alternate custom tooltip can be specified that will be displayed upon hovering over the goal. |
+ | *All goals of a map have to be organized in a table aswell: |
||
+ | **<code><nowiki>{</nowiki>{{pht|goal 1}}, ..., {{pht|goal n}}<nowiki>}</nowiki></code> |
||
+ | **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> || || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
Revision as of 14:12, 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 |
| ||
campaign_name |
| ||
prerequisites |
| ||
unlocks |
| ||
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