Module:Map/data/doc

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.		<Custom text>
type	Matchmaking type.		"PvE" "PvP"
map_names	Enter the map tab names if scenario consists of multiple maps.		Currently only applicable for 12-player scenarios. {"<map name>", "<map name>", "<map name>"}
min_players	Minimum number of players requiered to sucessfully play the map.		1 2 3 4 For 12-player scenarios use the following syntax: {<map 1 value>, <map 2 value>, <map 3 value>}
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.		The location is given by inputting coordinates representaing percentages of the minimap image in the following format: {<% of x-axis>,<% of y-axis>}. If it is a multiplayer map, use a table instead: {<set of coordinates>, ..., <set of coordinates>} For multi-map scenarios, put these tables of each map again into a table.
chest_positions	Coordinates of gold chest positions. The number of entries is used to determine the maximum amount of obtainable chests on this map.		The location is given by inputting coordinates representaing percentages of the minimap image in the following format: {<% of x-axis>,<% of y-axis>}. If it is a multiplayer map, use a table instead: {<set of coordinates 1>, ..., <set of coordinates n>} For multi-map scenarios, put these tables of each map again into a table.
quest_positions	Coordinates of quest goal positions.		Each goal has to be organized in a table as shown below: {letter="<letter>", <% of x-axis>,<% of y-axis>, "<custom tooltip text>"} All letters from A - Z 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: {<goal 1>, ..., <goal n>} For multi-map scenarios, put these tables of each map again into a table.
difficulties	Available difficulties for the scenario.		{{standard = <boolean>, advanced = <boolean>, expert = <boolean>},} If available: true If not available: false
campaign_name	Name of the campaign story of which the scenario is part.		<Custom text>
prerequisites	Names of scenarios that need to be unlocked first to play this scenario.		<Custom text>
unlocks	Names of scenarios that will be unlocked by winning this scenario.		<Custom text>
setup_description			<Custom text>
mission_briefing_description			<Custom text>
loading_screen_text			<Custom text>
spectator_map_available			<Custom text>
Ranking related parameters (this block repeats as many times as there are filterable rankings for the map)
ranking_numberplayers			<Custom text>
ranking_time			<Custom text>
ranking_players			<Custom text>
ranking_date			<Custom text>
ranking_difficulty			<Custom text>

See also

• Module Map
• Category Modules