Changes: Module:Map/data/doc

Revision as of 13:13, 13 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 = ,
        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	Accepted Input
`["<map name>"]`	Full name of the map.	`<Custom text>`
`type`		`<Custom text>`
`min_players`		`<Custom text>`
`starting_positions`		`<Custom text>`
`chest_positions`		`<Custom text>`
`quest_positions`		`<Custom text>`
`difficulties`		`<Custom text>`
`campaign_name`		`<Custom text>`
`prerequisites`		`<Custom text>`
`unlocks`		`<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>`

@@ Line 1: / Line 1: @@
-{{WIP}}{{Documentation subpage}}__NOTOC__
+{{Documentation subpage}}__NOTOC__
 == 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.
@@ Line 8: / Line 8: @@
     ["map name"] = {
         type = ,
-        minimap_image = ,
         min_players = ,
         starting_positions = ,
@@ Line 14: / Line 13: @@
         quest_positions = ,
         difficulties = ,
-        campaign_name =
+        campaign_name = "",
-        prerequisites = ,
+        prerequisites = "",
-        unlocks = ,
+        unlocks = "",
-        setup_description =
+        setup_description = "",
-        mission_briefing_description = ,
+        mission_briefing_description = "",
-        loading_screen_text = ,
+        loading_screen_text = "",
         spectator_map_available = ,
         rankings = {
@@ Line 48: / Line 47: @@
 |-
 | <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> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>min_players</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>starting_positions</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>chest_positions</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>quest_positions</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>difficulties</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>campaign_name</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>prerequisites</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>unlocks</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>setup_description</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>mission_briefing_description</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>loading_screen_text</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>spectator_map_available</code> ||   || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</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> ||  || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>ranking_time</code> ||  || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>ranking_players</code> ||  || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>ranking_date</code> ||  || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
+*<code>{{pht|Custom text}}</code>
+|-
+| <code>ranking_difficulty</code> ||  || style="text-align:center;" | [[File:False.svg|17px|link=|False]] ||
 *<code>{{pht|Custom text}}</code>
 |}

Changes: Module:Map/data/doc

Revision as of 13:13, 13 June 2021

Description

See also