No edit summary |
No edit summary |
||
Line 122: | Line 122: | ||
| <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>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> |
*<code>"{{pht|Custom text}}"</code> |
||
− | **Use <code><nowiki><br></nowiki></code> for a line break. |
+ | **Use <code><nowiki><br></nowiki></code> for a line break, twice for a new paragraph or page break. |
|- |
|- |
||
| <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>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> |
*<code>"{{pht|Custom text}}"</code> |
||
− | **Use <code><nowiki><br></nowiki></code> for a line break. |
+ | **Use <code><nowiki><br></nowiki></code> for a line break, twice for a new paragraph or page break. |
|- |
|- |
||
| <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>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> |
*<code>"{{pht|Custom text}}"</code> |
||
− | **Use <code><nowiki><br></nowiki></code> for a line break. |
+ | **Use <code><nowiki><br></nowiki></code> for a line break, twice for a new paragraph or page break. |
|- |
|- |
||
| <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>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> |
*<code>"{{pht|Custom text}}"</code> |
||
− | **Use <code><nowiki><br></nowiki></code> for a line break. |
+ | **Use <code><nowiki><br></nowiki></code> for a line break, twice for a new paragraph or page break. |
|- |
|- |
||
| <code>spectator_map_available</code> || Availability of an official spectator map. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
| <code>spectator_map_available</code> || Availability of an official spectator map. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
Revision as of 12:47, 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