Difference between revisions of "Template:Map infobox/doc"

From Team Fortress Wiki
Jump to: navigation, search
m (→‎Usage)
(Added 'map-has-magic-spells' to documentation)
 
(6 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
== Usage ==
 
== Usage ==
 
{{Note|The map stamp image, map overview image, and map loading screen image are all automatically added based on their filename. '''These files should always be .png files!'''<br>
 
{{Note|The map stamp image, map overview image, and map loading screen image are all automatically added based on their filename. '''These files should always be .png files!'''<br>
−
For the '''overview image''', the file name should be page name (i.e. "Upward" or "Orange (custom map)") followed by "overview" (see [[:File:Upward overview.png]]).<br>
+
For the '''thumbnail image''', the file name should be the {{code|map-file-name}} parameter input (e.g. "arena_byre") (see [[:File:Arena byre.png]]). If a filename that matches this format exists, it will ignore the {{code|map-image}} parameter.<br>
−
For the '''map stamp image''', the file name should be "Item icon Map Stamp - " followed by the page name (see [[:File:Item icon Map Stamp - Cascade.png]]).<br>
+
For the '''overview image''', the file name should be the {{code|map-name}} parameter input (e.g. "Upward", "Orange_X") followed by "overview" (see [[:File:Upward overview.png]]).<br>
−
For the '''map loading screen images''', the file name should be "Menu photos" followed by the map's file name (i.e. koth_viaduct) (see [[:File:Menu photos koth viaduct.png]]).}}
+
For the '''map stamp image''', the file name should be "Item icon Map Stamp - " followed by the {{code|map-name}} parameter input (see [[:File:Item icon Map Stamp - Cascade.png]]).<br>
 +
For the '''map loading screen images''', the file name should be "Menu photos" followed by the {{code|map-file-name}} parameter input (e.g. "koth_viaduct") (see [[:File:Menu photos koth viaduct.png]]).}}
 
<pre>
 
<pre>
 
{{Map infobox
 
{{Map infobox
−
| map-name-override =  
+
| map-status                  =
−
| map-image =  
+
| map-stamp-link              =
−
| game-type =  
+
| map-workshopid              =  
−
| file-name =  
+
| map-image                   =  
−
| current-version =  
+
| map-game-type               =  
−
| release-date =  
+
| map-file-name               =  
−
| last-updated =  
+
| map-version                 =
−
| developer =  
+
| map-released                =  
−
| link =  
+
| map-released-major          =  
−
| map-multiple-stages =  
+
| map-updated                 =  
−
| map-environment =  
+
| map-developer               =  
−
| map-setting =  
+
| map-links                  =  
−
| map-deep-water =  
+
| map-environment            =  
−
| map-hazards =  
+
| map-setting                =  
−
| map-underworld-hazards =  
+
| map-has-n-stages            =  
−
| map-pyrovision =  
+
| map-has-deep-water         =  
−
| map-items =  
+
| map-has-bots                =  
−
| map-health-pickups-small =  
+
| map-has-vscript            =  
−
| map-health-pickups-medium =  
+
| map-hazards                =  
−
| map-health-pickups-large =  
+
| map-hazards-underworld      =  
−
| map-ammo-pickups-small =  
+
| map-has-pyrovision          =  
−
| map-ammo-pickups-medium =  
+
| map-has-magic-spells        =
−
| map-ammo-pickups-large =  
+
| map-items                  =  
−
| map-special-pickups-sgg =  
+
| map-pickups-health-small   =  
−
| map-special-pickups-pumpkin =  
+
| map-pickups-health-medium   =  
−
| map-stamp-link =  
+
| map-pickups-health-large   =  
−
| map-bots =  
+
| map-pickups-ammo-small      =
 +
| map-pickups-ammo-medium    =  
 +
| map-pickups-ammo-large      =  
 +
| map-pickups-special-sgg    =  
 +
| map-pickups-special-pumpkin =  
 
}}
 
}}
 
</pre>
 
</pre>
Line 41: Line 46:
 
{| class="wikitable grid"
 
{| class="wikitable grid"
 
! Parameter
 
! Parameter
 +
! Values
 
! Required?
 
! Required?
 
! Function
 
! Function
 
|-
 
|-
−
| <code>map-name-override</code>
+
| <code>game</code>
−
| No
+
| tfc<br>tf
−
| The name of the map if it is anything other than the page name.
+
| TFC, TF maps
 +
| Specifies the game the map is designed for. Accepts values such as <code>tfc</code> (Team Fortress Classic), <code>tf</code> (Quake Team Fortress) and ''[none/empty]'' (Team Fortress 2).
 +
|-
 +
| <code>map-status</code>
 +
| official<br>community<br>custom<br>etc.
 +
| '''Always'''
 +
| Indicates the ''current'' status of the map. Accepts values such as <code>valve</code>, <code>official</code> ([[:Category:Valve maps‎]]), <code>community</code> ([[:Category:Community maps‎]]), <code>custom</code> ([[:Category:Custom maps‎]]), <code>beta</code>, <code>cut</code>, <code>unused</code> ([[:Category:Beta, cut or unused maps]]), <code>test</code>, <code>dev</code> ([[:Category:Dev and test maps‎]]).
 +
* If set to <code>community</code>, the map infobox will display a "Buy Map Stamp" button to encourage supporting map creators.
 +
* If set to  <code>custom</code>, and <code>map-workshopid</code> is filled, the map infobox will display a "{{common string|workshop subscribe}}" button leading to the map's page on the [[Steam Workshop]].
 +
|-
 +
| <code>map-stamp-link</code>
 +
| <code><nowiki>https://steamcommunity.com/stats/TF2/leaderboards/{id_here}</nowiki></code>
 +
| Community maps
 +
| If a map stamp is available in the Mann Co. Store, provide a link to the supporters leaderboard.<br>Set to <code>unavailable</code> to display the map stamp and a "''Supporters leaderboard not yet available''" line.
 +
|-
 +
| <code>map-workshopid</code>
 +
| number
 +
| Custom maps
 +
| Specifies the ID of the map in the Steam Workshop.
 +
|-
 +
| <code>map-name</code>
 +
| text
 +
| Custom maps
 +
| Specifies the name of the map if it differs from the page name.
 
|-
 
|-
 
| <code>map-image</code>
 
| <code>map-image</code>
−
| '''Yes'''
+
| file name
−
| File name of image of map, automatically resized to 300px wide. Defaults to [[:File:Screenshot needed.png]].
+
| No
 +
| Specifies the file name of the map image, automatically resized to 300px wide.
 +
* For Valve-made maps, it defaults to [[File:<code>map-file-name</code>.png]] ("arena_byre.png").
 +
*For custom maps, it defaults to [[File:<code><nowiki>{{BASEPAGENAME}}</nowiki></code>.png]] ("Hardhat (custom map).png").
 +
'''Note:''' if an image that matches the "default" format is uploaded, this parameter will have no effect.
 
|-
 
|-
−
| <code>game-type</code>
+
| <code>map-game-type</code>
 +
| Arena<br>Capture the Flag<br>etc.
 
| No
 
| No
−
| Game type or mode, such as ''Arena'', in English. Automatically linked, categorizing and translated.
+
| Specifies the game type or mode, such as <code>Arena</code>.
 
|-
 
|-
−
| <code>file-name</code>
+
| <code>map-file-name</code>
 +
| text
 
| No
 
| No
−
| File name of map.
+
| Specifies the file name of the map.
 
|-
 
|-
−
| <code>current-version</code>
+
| <code>map-version</code>
 +
| text
 
| Custom maps
 
| Custom maps
−
| Latest version of the map, such as ''A2'', ''B5'', ''RC5''.
+
| Specifies the latest version of the map, such as ''A2'', ''B5'' or ''RC5''.
 
|-
 
|-
−
| <code>release-date</code>
+
| <code>map-released</code>
 +
| {{tlx|patch name}}
 
| No
 
| No
−
| The date the map was released to the public in a Valve [[Patch|Update]].
+
| Specifies the date/patch the map was released. Please use {{tlx|Patch name}} instead of plain text.
 
|-
 
|-
−
| <code>last-updated</code>
+
| <code>map-released-major</code>
 +
| [[:Template:Dictionary/common_strings#major_update_titles|major_update_title]]
 
| No
 
| No
−
| The last time the map was updated by a Valve patch.
+
| Specifies the named patch the map was released in. Check [[:Template:Dictionary/common_strings#major_update_titles]] for a list of parameters.
 
|-
 
|-
−
| <code>developer</code>
+
| <code>map-updated</code>
 +
| {{tlx|patch name}}
 
| Custom maps
 
| Custom maps
−
| Name and optional Steam id profile link for the developer/author and contributors of the map in the same order their names appear in the map's start screen. Do not name individual Valve employees. ''See [[Help_talk:Style_guide/Maps#Change_to_map_developer_credits|Policy]].''
+
| Specifies the last time the map was updated.
 
|-
 
|-
−
| <code>link</code>
+
| <code>map-developer</code>
 +
| text
 
| Custom maps
 
| Custom maps
−
| Link(s) to development threads, websites, etc.
+
| Specifies the name and optional Steam ID profile link for the developer/author and contributors of the map in the same order their names appear in the map's start screen.<br>Do not name individual Valve employees. See [[Help_talk:Style_guide/Maps#Change_to_map_developer_credits|Policy]].<br>For official maps (Valve-made, Steam Workshop), names are stored in the {{tlx|Map credits}} template.
 
|-
 
|-
−
| <code>map-multiple-stages</code>
+
| <code>map-links</code>
−
| No
+
| text
−
| Number of stages the map is composed of.
+
| Custom maps
 +
| Specifies link(s) to development threads, websites, etc.
 
|-
 
|-
 
| <code>map-environment</code>
 
| <code>map-environment</code>
 +
| text
 
| No
 
| No
−
| Map environment (Alpine, Desert, etc). Also enables the '''Map Info''' section header.
+
| Specifies the map environment (Alpine, Desert, etc.). Also enables the '''Map Info''' section header.
 
|-
 
|-
 
| <code>map-setting</code>
 
| <code>map-setting</code>
 +
| text
 
| No
 
| No
−
| Map setting, as daytime and weather.
+
| Specifies the map setting, such as daytime and weather.
 
|-
 
|-
−
| <code>map-deep-water</code>
+
| <code>map-has-n-stages</code>
 +
| number
 
| No
 
| No
−
| Deep water present in map.
+
| Specifies the number of stages the map is composed of.
 
|-
 
|-
−
| <code>map-hazards</code>
+
| <code>map-has-deep-water</code>
 +
| yes<br>no<br>custom text
 +
| No
 +
| Indicates whether there is deep water present in the map.
 +
|-
 +
| <code>map-has-pyrovision</code>
 +
| yes<br>no
 +
| No
 +
| Indicates whether the map is [[Pyroland|Pyrovision]] compatible.
 +
|-
 +
| <code>map-has-magic-spells</code>
 +
| yes<br>no
 
| No
 
| No
−
| Various environmental hazards present in map.
+
| Indicates whether the map contains [[Magic spells|magic spells]].
 
|-
 
|-
−
| <code>map-underworld-hazards</code>
+
| <code>map-has-bots</code>
 +
| yes<br>no
 
| No
 
| No
−
| Various environmental hazards present in map's underworld.
+
| Indicates whether the map [[Bots]]. The robot horde in [[Mann vs. Machine]] does not count.
 
|-
 
|-
−
| <code>map-pyrovision</code>
+
| <code>map-has-vscript</code>
 +
| yes<br>no
 
| No
 
| No
−
| Map is [[Pyroland|pyrovision]] compatible.
+
| Indicates whether the map uses [[VScript]], in any form.
 
|-
 
|-
−
| <code>map-items</code>
+
| <code>map-hazards</code>
 +
| text
 
| No
 
| No
−
| Set to '''none''' shows the '''Map Items''' section header and a single entry saying ''None''. (Useful for <tt>item_test</tt>-like maps.)
+
| Specifies various environmental hazards present in the map.
 
|-
 
|-
−
| <code>map-health-pickups-small</code>
+
| <code>map-hazards-underworld</code>
 +
| text
 
| No
 
| No
−
| Number of small health pickups present in map.
+
| Specifies various environmental hazards present in the map's underworld.
 
|-
 
|-
−
| <code>map-health-pickups-medium</code>
+
| <code>map-items</code>
 +
| text
 
| No
 
| No
−
| Number of medium health pickups present in map.  
+
| Set to '''none''' to show the '''Map Items''' section header and a single entry saying ''None.'' (Useful for <tt>item_test</tt>-like maps.)
 
|-
 
|-
−
| <code>map-health-pickups-large</code>
+
| <code>map-pickups-health-small</code>
 +
| number
 
| No
 
| No
−
| Number of large health pickups present in map.
+
| Specifies the number of small health pickups present in the map.
 
|-
 
|-
−
| <code>map-ammo-pickups-small</code>
+
| <code>map-pickups-health-medium</code>
 +
| number
 
| No
 
| No
−
| Number of small ammo pickups present in map.
+
| Specifies the number of medium health pickups present in the map.  
 
|-
 
|-
−
| <code>map-ammo-pickups-medium</code>
+
| <code>map-pickups-health-large</code>
 +
| number
 
| No
 
| No
−
| Number of medium ammo pickups present in map.  
+
| Specifies the number of large health pickups present in the map.  
 
|-
 
|-
−
| <code>map-ammo-pickups-large</code>
+
| <code>map-pickups-ammo-small</code>
 +
| number
 
| No
 
| No
−
| Number of large ammo pickups present in map.
+
| Specifies the number of small ammo pickups present in the map.
 
|-
 
|-
−
| <code>map-special-pickups-sgg</code>
+
| <code>map-pickups-ammo-medium</code>
 +
| number
 
| No
 
| No
−
| [[Soul Gargoyle]]s present in map.  
+
| Specifies the number of medium ammo pickups present in the map.
 
|-
 
|-
−
| <code>map-special-pickups-pumpkin</code>
+
| <code>map-pickups-ammo-large</code>
 +
| number
 
| No
 
| No
−
| [[Halloween pumpkin]]s present in map.  
+
| Specifies the number of large ammo pickups present in the map.
 
|-
 
|-
−
| <code>map-stamp-link</code>
+
| <code>map-pickups-special-sgg</code>
 +
| yes<br>no
 
| No
 
| No
−
| If a map stamp is available in Mann Co. Store, provide link to supporters leaderboard.
+
| Indicates whether the map can spawn [[Soul Gargoyle]]s.  
−
 
 
−
Set to '''unavailable''' displays the map stamp and a "''Supporters leaderboard not yet available''" line.
 
 
|-
 
|-
−
| <code>map-bots</code>
+
| <code>map-pickups-special-pumpkin</code>
 +
| yes<br>no
 
| No
 
| No
−
| [[Bots]] supported. The robot horde in [[Mann vs. Machine]] does not count.
+
| Indicates whether the map can spawn [[Halloween pumpkin]]s.
 
|}
 
|}
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 02:33, 22 August 2024

This template adds in information box to articles on maps. It adds pages to Category:Maps.

Usage

Pictogram comment.png The map stamp image, map overview image, and map loading screen image are all automatically added based on their filename. These files should always be .png files!
For the thumbnail image, the file name should be the map-file-name parameter input (e.g. "arena_byre") (see File:Arena byre.png). If a filename that matches this format exists, it will ignore the map-image parameter.
For the overview image, the file name should be the map-name parameter input (e.g. "Upward", "Orange_X") followed by "overview" (see File:Upward overview.png).
For the map stamp image, the file name should be "Item icon Map Stamp - " followed by the map-name parameter input (see File:Item icon Map Stamp - Cascade.png).
For the map loading screen images, the file name should be "Menu photos" followed by the map-file-name parameter input (e.g. "koth_viaduct") (see File:Menu photos koth viaduct.png).

{{Map infobox
| map-status                  = 
| map-stamp-link              = 
| map-workshopid              = 
| map-image                   = 
| map-game-type               = 
| map-file-name               = 
| map-version                 = 
| map-released                = 
| map-released-major          = 
| map-updated                 = 
| map-developer               = 
| map-links                   = 
| map-environment             = 
| map-setting                 = 
| map-has-n-stages            = 
| map-has-deep-water          = 
| map-has-bots                = 
| map-has-vscript             = 
| map-hazards                 = 
| map-hazards-underworld      = 
| map-has-pyrovision          = 
| map-has-magic-spells        =
| map-items                   = 
| map-pickups-health-small    = 
| map-pickups-health-medium   = 
| map-pickups-health-large    = 
| map-pickups-ammo-small      = 
| map-pickups-ammo-medium     = 
| map-pickups-ammo-large      = 
| map-pickups-special-sgg     = 
| map-pickups-special-pumpkin = 
}}

Parameters

Parameter Values Required? Function
game tfc
tf 		TFC, TF maps Specifies the game the map is designed for. Accepts values such as tfc (Team Fortress Classic), tf (Quake Team Fortress) and [none/empty] (Team Fortress 2).
map-status official
community
custom
etc. 		Always Indicates the current status of the map. Accepts values such as valve, official (Category:Valve maps‎), community (Category:Community maps‎), custom (Category:Custom maps‎), beta, cut, unused (Category:Beta, cut or unused maps), test, dev (Category:Dev and test maps‎).
  • If set to community, the map infobox will display a "Buy Map Stamp" button to encourage supporting map creators.
  • If set to custom, and map-workshopid is filled, the map infobox will display a "Subscribe on the Steam Workshop" button leading to the map's page on the Steam Workshop.
map-stamp-link https://steamcommunity.com/stats/TF2/leaderboards/{id_here} Community maps If a map stamp is available in the Mann Co. Store, provide a link to the supporters leaderboard.
Set to unavailable to display the map stamp and a "Supporters leaderboard not yet available" line.
map-workshopid number Custom maps Specifies the ID of the map in the Steam Workshop.
map-name text Custom maps Specifies the name of the map if it differs from the page name.
map-image file name No Specifies the file name of the map image, automatically resized to 300px wide.
  • For Valve-made maps, it defaults to [[File:map-file-name.png]] ("arena_byre.png").
  • For custom maps, it defaults to [[File:{{BASEPAGENAME}}.png]] ("Hardhat (custom map).png").

Note: if an image that matches the "default" format is uploaded, this parameter will have no effect.

map-game-type Arena
Capture the Flag
etc. 		No Specifies the game type or mode, such as Arena.
map-file-name text No Specifies the file name of the map.
map-version text Custom maps Specifies the latest version of the map, such as A2, B5 or RC5.
map-released {{patch name}} No Specifies the date/patch the map was released. Please use {{Patch name}} instead of plain text.
map-released-major major_update_title No Specifies the named patch the map was released in. Check Template:Dictionary/common_strings#major_update_titles for a list of parameters.
map-updated {{patch name}} Custom maps Specifies the last time the map was updated.
map-developer text Custom maps Specifies the name and optional Steam ID profile link for the developer/author and contributors of the map in the same order their names appear in the map's start screen.
Do not name individual Valve employees. See Policy.
For official maps (Valve-made, Steam Workshop), names are stored in the {{Map credits}} template.
map-links text Custom maps Specifies link(s) to development threads, websites, etc.
map-environment text No Specifies the map environment (Alpine, Desert, etc.). Also enables the Map Info section header.
map-setting text No Specifies the map setting, such as daytime and weather.
map-has-n-stages number No Specifies the number of stages the map is composed of.
map-has-deep-water yes
no
custom text 		No Indicates whether there is deep water present in the map.
map-has-pyrovision yes
no 		No Indicates whether the map is Pyrovision compatible.
map-has-magic-spells yes
no 		No Indicates whether the map contains magic spells.
map-has-bots yes
no 		No Indicates whether the map Bots. The robot horde in Mann vs. Machine does not count.
map-has-vscript yes
no 		No Indicates whether the map uses VScript, in any form.
map-hazards text No Specifies various environmental hazards present in the map.
map-hazards-underworld text No Specifies various environmental hazards present in the map's underworld.
map-items text No Set to none to show the Map Items section header and a single entry saying None. (Useful for item_test-like maps.)
map-pickups-health-small number No Specifies the number of small health pickups present in the map.
map-pickups-health-medium number No Specifies the number of medium health pickups present in the map.
map-pickups-health-large number No Specifies the number of large health pickups present in the map.
map-pickups-ammo-small number No Specifies the number of small ammo pickups present in the map.
map-pickups-ammo-medium number No Specifies the number of medium ammo pickups present in the map.
map-pickups-ammo-large number No Specifies the number of large ammo pickups present in the map.
map-pickups-special-sgg yes
no 		No Indicates whether the map can spawn Soul Gargoyles.
map-pickups-special-pumpkin yes
no 		No Indicates whether the map can spawn Halloween pumpkins.
Retrieved from "https://wiki.teamfortress.com/w/index.php?title=Template:Map_infobox/doc&oldid=3800274"