No edit summary |
No edit summary |
||
(40 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}}__NOTOC__ |
{{Documentation subpage}}__NOTOC__ |
||
== Description == |
== Description == |
||
− | This module stores all data about the currently existing playable maps in alphabetical order. Whenever map changes occur this |
+ | 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 |
||
− | STILL WIP |
||
+ | All maps' data is stored in a standardized way as shown below. |
||
+ | <pre> |
||
+ | ["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 = "", |
||
+ | plot2 = "", |
||
+ | conclusion1 = "", |
||
+ | conclusion2 = "", |
||
+ | 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 = "" |
||
+ | } |
||
+ | } |
||
+ | }, |
||
+ | </pre> |
||
+ | |||
+ | ;Parameter and Syntax Explanation |
||
+ | {| class="wikitable mw-collapsible mw-collapsed" style="width: 100%;" |
||
+ | ! width=20% | Parameter |
||
+ | ! width=22% | Explanation / Usage Notes |
||
+ | ! width=10% | {{tt|Omissible|'✔' means true, '✘' means false, '⭘' means conditional}} |
||
+ | ! width=48% | Accepted Input |
||
+ | |- |
||
+ | | <code>["{{pht|map name}}"]</code> || Full name of the map. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
||
+ | *<code>{{pht|Custom text}}</code> |
||
+ | |- |
||
+ | | <code>type</code> || Matchmaking type. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
||
+ | *<code>"PvE"</code> |
||
+ | *<code>"PvP"</code> |
||
+ | |- |
||
+ | | <code>map_names</code> || Enter the map tab names if scenario consists of multiple maps. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only mandatory for 12 player maps]] || |
||
+ | *Currently only applicable for 12-player scenarios. |
||
+ | **<code><nowiki>{</nowiki>"{{pht|map name}}", "{{pht|map name}}", "{{pht|map name}}"<nowiki>},</nowiki></code> |
||
+ | |- |
||
+ | | <code>min_players</code> || Minimum number of players requiered to sucessfully play the map. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
||
+ | *<code>1</code> |
||
+ | *<code>2</code> |
||
+ | *<code>3</code> |
||
+ | *<code>4</code> |
||
+ | *For 12-player scenarios use the following syntax: |
||
+ | **<code><nowiki>{</nowiki>{{pht|map 1 value}}, {{pht|map 2 value}}, {{pht|map 3 value}}<nowiki>},</nowiki></code> |
||
+ | |- |
||
+ | | <code>starting_positions</code> || 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. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
||
+ | *The location is given by inputting coordinates representaing percentages of the minimap image in the following format: |
||
+ | **<code><nowiki>{</nowiki>{{pht|% of x-axis}},{{pht|% of y-axis}}<nowiki>},</nowiki></code> |
||
+ | *If it is a multiplayer map, use a table instead: |
||
+ | **<code><nowiki>{</nowiki>{{pht|set of coordinates}}, ..., {{pht|set of coordinates}}<nowiki>},</nowiki></code> |
||
+ | **For multi-map scenarios, put these tables of each map again into a table. |
||
+ | |- |
||
+ | | <code>chest_positions</code> || Coordinates of gold chest positions. The number of entries is used to determine the maximum amount of obtainable chests on this map. || style="text-align:center;" | [[File:True.svg|17px|link=|False]] || |
||
+ | *The location is given by inputting coordinates representaing percentages of the minimap image in the following format: |
||
+ | **<code><nowiki>{</nowiki>{{pht|% of x-axis}},{{pht|% of y-axis}}<nowiki>},</nowiki></code> |
||
+ | *If it is a multiplayer map, use a table instead: |
||
+ | **<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. |
||
+ | |- |
||
+ | | <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><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. |
||
+ | ***When no letter parameter is given, the goal icon will be empty. |
||
+ | **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> || Available difficulties for the scenario. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only mandatory for PvE]] || |
||
+ | *<code><nowiki>{</nowiki>standard = {{pht|boolean}}, advanced = {{pht|boolean}}, expert = {{pht|boolean}}<nowiki>},</nowiki></code> |
||
+ | **If available: <code>true</code> |
||
+ | **If not available: <code>false</code> |
||
+ | |- |
||
+ | | <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|campaign story name}}"</code> |
||
+ | |- |
||
+ | | <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=|True]] || |
||
+ | *<code>"{{pht|scenario name}}"</code> |
||
+ | **If it is more than one, use a table instead: |
||
+ | **<code><nowiki>{</nowiki>"{{pht|scenario name 1}}", ..., "{{pht|scenario name n}}"<nowiki>},</nowiki></code> |
||
+ | |- |
||
+ | | <code>unlocks</code> || Names of scenarios that will be unlocked by winning this scenario. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
||
+ | *<code>"{{pht|scenario name}}"</code> |
||
+ | **If it is more than one, use a table instead: |
||
+ | **<code><nowiki>{</nowiki>"{{pht|scenario name 1}}", ..., "{{pht|scenario name n}}"<nowiki>},</nowiki></code> |
||
+ | |- |
||
+ | | <code>setup_description</code> || Description of the PvE scenario shown in the Setup Window. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only required for PvE]] || |
||
+ | *<code>"{{pht|Custom text}}"</code> |
||
+ | **Use <code><nowiki><br></nowiki></code> for a line break. |
||
+ | **May contain template styling and links. |
||
+ | |- |
||
+ | | <code>mission_briefing_description</code> || Description of the map shown in the Mission Briefing Window. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
||
+ | *<code>"{{pht|Custom text}}"</code> |
||
+ | **Use <code><nowiki><br></nowiki></code> for a line break. |
||
+ | |- |
||
+ | | <code>loading_screen_text</code> || Text shown during [[Loading Screens|loading screen]] of the scenario. If the scenario has a story book entry, this text is identical with the first part of the plot there. A respective audio file does then always exist. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only required for PvE]] || |
||
+ | *<code>"{{pht|Custom text}}"</code> |
||
+ | **Use <code><nowiki><br></nowiki></code> for a line break, twice for a new paragraph or page break. |
||
+ | **Use <code>“</code> and <code>”</code> for quotation marks. |
||
+ | |- |
||
+ | | <code>plot2</code> || Second plot text of the scenario which is displayed in the story book. Does not exist for all scenarios. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only applicable for some PvE scenarios]] || |
||
+ | *<code>"{{pht|Custom text}}"</code> |
||
+ | **Use <code><nowiki><br></nowiki></code> for a line break, twice for a new paragraph or page break. |
||
+ | **Use <code>“</code> and <code>”</code> for quotation marks. |
||
+ | *<code>nil</code>, if it does not exist. |
||
+ | |- |
||
+ | | <code>conclusion1</code> || First conclusion text of the scenario which is displayed in the story book. A respective audio file does always exist. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only required for PvE]] || |
||
+ | *<code>"{{pht|Custom text}}"</code> |
||
+ | **Use <code><nowiki><br></nowiki></code> for a line break, twice for a new paragraph or page break. |
||
+ | **Use <code>“</code> and <code>”</code> for quotation marks. |
||
+ | *<code>nil</code>, if it does not exist. |
||
+ | |- |
||
+ | | <code>conclusion2</code> || Second conclusion text of the scenario which is displayed in the story book. Does not exist for all scenarios. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only applicable for some PvE scenarios]] || |
||
+ | *<code>"{{pht|Custom text}}"</code> |
||
+ | **Use <code><nowiki><br></nowiki></code> for a line break, twice for a new paragraph or page break. |
||
+ | **Use <code>“</code> and <code>”</code> for quotation marks. |
||
+ | *<code>nil</code>, if it does not exist. |
||
+ | |- |
||
+ | | <code>spectator_map_available</code> || Availability of an official spectator map. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
||
+ | *If available: <code>true</code> |
||
+ | *If not available: <code>false</code> |
||
+ | |- |
||
+ | | colspan="4" style="background-color:#070F19;" | '''Ranking related parameters''' (This block repeats as many times as there are filterable rankings for the map.) |
||
+ | |- |
||
+ | | <code>ranking_numberplayers</code> || Ranking category based on the maximum number of players in which this time is the fastest. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only required for PvE]] || |
||
+ | *Only list rankings that are applicable based on the maximum number of starting players of this map. |
||
+ | **<code>12</code> |
||
+ | **<code>11</code> |
||
+ | **... |
||
+ | **<code>2</code> |
||
+ | **<code>1</code> |
||
+ | |- |
||
+ | | <code>ranking_time</code> || Time in which the scenario was won. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only required for PvE]] || |
||
+ | *<code>"{{pht|mm:ss.ds}}"</code> |
||
+ | |- |
||
+ | | <code>ranking_players</code> || Names of players that achieved the time. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only required for PvE]] || |
||
+ | *List the names alphabetically from left to right in a table: |
||
+ | **<code><nowiki>{</nowiki>"{{pht|player name 1}}", ..., "{{pht|player name n}}"<nowiki>},</nowiki></code> |
||
+ | |- |
||
+ | | <code>ranking_date</code> || Date when the time was achieved. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only required for PvE]] || |
||
+ | *<code>"{{pht|month year}}"</code> |
||
+ | |- |
||
+ | | <code>ranking_difficulty</code> || Difficulty at which this time was achieved. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Only required for PvE]] || |
||
+ | *Usually the highest available difficulty: |
||
+ | **<code>"Standard"</code> |
||
+ | **<code>"Advanced"</code> |
||
+ | **<code>"Expert"</code> |
||
+ | |} |
||
== See also == |
== See also == |
Latest revision as of 18:32, 3 July 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 = "", plot2 = "", conclusion1 = "", conclusion2 = "", 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 to sucessfully play the map. |
| |
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 |
Description of the PvE scenario shown in the Setup Window. |
| |
mission_briefing_description |
Description of the map shown in the Mission Briefing Window. |
| |
loading_screen_text |
Text shown during loading screen of the scenario. If the scenario has a story book entry, this text is identical with the first part of the plot there. A respective audio file does then always exist. |
| |
plot2 |
Second plot text of the scenario which is displayed in the story book. Does not exist for all scenarios. |
| |
conclusion1 |
First conclusion text of the scenario which is displayed in the story book. A respective audio file does always exist. |
| |
conclusion2 |
Second conclusion text of the scenario which is displayed in the story book. Does not exist for all scenarios. |
| |
spectator_map_available |
Availability of an official spectator map. |
| |
Ranking related parameters (This block repeats as many times as there are filterable rankings for the map.) | |||
ranking_numberplayers |
Ranking category based on the maximum number of players in which this time is the fastest. |
| |
ranking_time |
Time in which the scenario was won. |
| |
ranking_players |
Names of players that achieved the time. |
| |
ranking_date |
Date when the time was achieved. |
| |
ranking_difficulty |
Difficulty at which this time was achieved. |
|
See also