Difference between revisions of "Module:Availability/doc"

From Team Fortress Wiki
Jump to: navigation, search
(→‎Entries: Add goodie cauldron doc to test and make sure mgpt didn't peer pressure me into breaking all-the-pages-wide template)
m (updated from doc)
 
(12 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
{{Ambox
 
{{Ambox
 
   | type = notice
 
   | type = notice
−
   | contents = To update which crate series are linked as active, change the list in [[Module:Availability/crate]].
+
   | contents = To update which crate series are linked as active, change the list in [[Module:Availability/active]].
 
}}
 
}}
  
Line 20: Line 20:
 
|-
 
|-
 
| <code>bread-box</code> || {{#invoke:Availability|avail|bread-box}}
 
| <code>bread-box</code> || {{#invoke:Availability|avail|bread-box}}
 +
|-
 +
| <code>chemistryset</code> || {{#invoke:Availability|avail|chemistryset}}
 
|-
 
|-
 
| <code>case-any</code> || {{#invoke:Availability|avail|case-any}}
 
| <code>case-any</code> || {{#invoke:Availability|avail|case-any}}
 
|-
 
|-
 
| <code>case-bonus</code> || {{#invoke:Availability|avail|case-bonus}}
 
| <code>case-bonus</code> || {{#invoke:Availability|avail|case-bonus}}
−
|-
 
−
| <code>chemistryset</code> || {{#invoke:Availability|avail|chemistryset}}
 
 
|-
 
|-
 
| <code>collectors</code> || {{#invoke:Availability|avail|collectors}}
 
| <code>collectors</code> || {{#invoke:Availability|avail|collectors}}
Line 42: Line 42:
 
|-
 
|-
 
| <code>distributed</code> || {{#invoke:Availability|avail|distributed}}
 
| <code>distributed</code> || {{#invoke:Availability|avail|distributed}}
 +
|-
 +
| <code>distributed-duels</code> || {{#invoke:Availability|avail|distributed-duels}}
 
|-
 
|-
 
| <code>distributed-expired</code> || {{#invoke:Availability|avail|distributed-expired}}
 
| <code>distributed-expired</code> || {{#invoke:Availability|avail|distributed-expired}}
 +
|-
 +
| <code>distributed-gifts</code> || {{#invoke:Availability|avail|distributed-gifts}}
 +
|-
 +
| <code>distributed-stamps</code> || {{#invoke:Availability|avail|distributed-stamps}}
 
|-
 
|-
 
| <code>drop</code> || {{#invoke:Availability|avail|drop}}
 
| <code>drop</code> || {{#invoke:Availability|avail|drop}}
 +
|-
 +
| <code>drop-expired</code> || {{#invoke:Availability|avail|drop-expired}}
 +
|-
 +
| <code>festive-gift</code> || {{#invoke:Availability|avail|festive-gift}}
 
|-
 
|-
 
| <code>gift-cauldron</code> || {{#invoke:Availability|avail|gift-cauldron}}
 
| <code>gift-cauldron</code> || {{#invoke:Availability|avail|gift-cauldron}}
 
|-
 
|-
−
| <code>goodi-cauldron</code> || {{#invoke:Availability|avail|goodie-cauldron}}
+
| <code>goodie-cauldron</code> || {{#invoke:Availability|avail|goodie-cauldron}}
 
|-
 
|-
 
| <code>halloween-package</code> || {{#invoke:Availability|avail|halloween-package}}
 
| <code>halloween-package</code> || {{#invoke:Availability|avail|halloween-package}}
Line 58: Line 68:
 
|-
 
|-
 
| <code>hauntedgift</code> || {{#invoke:Availability|avail|hauntedgift}}
 
| <code>hauntedgift</code> || {{#invoke:Availability|avail|hauntedgift}}
 +
|-
 +
| <code>jungleinferno-campaign</code> || {{#invoke:Availability|avail|jungleinferno-campaign}}
 +
|-
 +
| <code>jungleinferno-contracts</code> || {{#invoke:Availability|avail|jungleinferno-contracts}}
 
|-
 
|-
 
| <code>keyless-crate</code> || {{#invoke:Availability|avail|keyless-crate}}
 
| <code>keyless-crate</code> || {{#invoke:Availability|avail|keyless-crate}}
Line 64: Line 78:
 
|-
 
|-
 
| <code>mvm</code> || {{#invoke:Availability|avail|mvm}}
 
| <code>mvm</code> || {{#invoke:Availability|avail|mvm}}
 +
|-
 +
| <code>pallet-of-crates</code> || {{#invoke:Availability|avail|pallet-of-crates}}
 
|-
 
|-
 
| <code>pile-of-curses</code> || {{#invoke:Availability|avail|pile-of-curses}}
 
| <code>pile-of-curses</code> || {{#invoke:Availability|avail|pile-of-curses}}
 
|-
 
|-
 
| <code>promotional</code> || {{#invoke:Availability|avail|promotional}}
 
| <code>promotional</code> || {{#invoke:Availability|avail|promotional}}
 +
|-
 +
| <code>promotional-craft</code> || {{#invoke:Availability|avail|promotional-craft}}
 
|-
 
|-
 
| <code>promotional-expired</code> || {{#invoke:Availability|avail|promotional-expired}}
 
| <code>promotional-expired</code> || {{#invoke:Availability|avail|promotional-expired}}
 
|-
 
|-
 
| <code>promotional-expired-codes</code> || {{#invoke:Availability|avail|promotional-expired-codes}}
 
| <code>promotional-expired-codes</code> || {{#invoke:Availability|avail|promotional-expired-codes}}
 +
|-
 +
| <code>promotional-unlock</code> || {{#invoke:Availability|avail|promotional-unlock}}
 
|-
 
|-
 
| <code>purchase</code> || {{#invoke:Availability|avail|purchase}}
 
| <code>purchase</code> || {{#invoke:Availability|avail|purchase}}
Line 93: Line 113:
 
| <code>unusual</code> || {{#invoke:Availability|avail|unusual}}
 
| <code>unusual</code> || {{#invoke:Availability|avail|unusual}}
 
|-
 
|-
−
| <code>xmas2015</code> || {{#invoke:Availability|avail|xmas2015}}
+
| <code>unusual-expired</code> || {{#invoke:Availability|avail|unusual-expired}}
 
|-
 
|-
 
| <code>warpaint</code> || {{#invoke:Availability|avail|warpaint}}
 
| <code>warpaint</code> || {{#invoke:Availability|avail|warpaint}}
 
|-
 
|-
−
| <code>winter2016</code> || {{#invoke:Availability|avail|winter2016}}
+
! class="header" colspan="2" | [[MvM]] related strings
−
|-
 
−
| <code>winter2016-strange</code> || {{#invoke:Availability|avail|winter2016-strange}}
 
−
|-
 
−
| <code>winter2016-unusual</code> || {{#invoke:Availability|avail|winter2016-unusual}}
 
−
|-
 
−
| colspan="2" |
 
 
|-
 
|-
 
| <code>mannup</code> || {{#invoke:Availability|avail|mannup}}
 
| <code>mannup</code> || {{#invoke:Availability|avail|mannup}}
Line 113: Line 127:
 
| <code>mvm-both-types</code> || {{#invoke:Availability|avail|mvm-both-types}}
 
| <code>mvm-both-types</code> || {{#invoke:Availability|avail|mvm-both-types}}
 
|-
 
|-
−
| colspan="2" |
+
! class="header" colspan="2" | Dynamic strings (mostly used for crate numbers). The numeric value is automatically parsed.
 
|-
 
|-
 
| <code>crate1</code> || {{#invoke:Availability|avail|crate1}}
 
| <code>crate1</code> || {{#invoke:Availability|avail|crate1}}
Line 127: Line 141:
 
| <code>crate6-expired</code> || {{#invoke:Availability|avail|crate6-expired}}
 
| <code>crate6-expired</code> || {{#invoke:Availability|avail|crate6-expired}}
 
|-
 
|-
−
| <code>unusual-5</code> || {{#invoke:Availability|avail|unusual-5}}
+
| <code>crate91</code> || {{#invoke:Availability|avail|crate91}}
 +
|-
 +
| <code>crate92</code> || {{#invoke:Availability|avail|crate92}}
 +
|-
 +
| <code>case104</code> || {{#invoke:Availability|avail|case104}}
 
|-
 
|-
 +
| <code>case105</code> || {{#invoke:Availability|avail|case105}}
 
|}
 
|}
  
Line 136: Line 155:
 
* {{tlx|avail|drop|craft|purchase}} produces {{#invoke:Availability|avail|drop|craft|purchase}}
 
* {{tlx|avail|drop|craft|purchase}} produces {{#invoke:Availability|avail|drop|craft|purchase}}
 
* {{tlx|avail|drop|craft|purchase|promotional}} produces {{#invoke:Availability|avail|drop|craft|purchase|promotional}}
 
* {{tlx|avail|drop|craft|purchase|promotional}} produces {{#invoke:Availability|avail|drop|craft|purchase|promotional}}
−
* {{tlx|avail|drop|craft|purchase|promotional|6=availability=<nowiki>[[Main Page|Custom]]</nowiki>}} produces {{#invoke:Availability|avail|drop|craft|purchase|promotional|availability=[[Main Page|Custom]]}}
 
  
 
=== Backwards compatibility ===
 
=== Backwards compatibility ===
−
{{tl|Availability}} has some parameters which have been deprecated. They will still function in this template, but their use will place the page into [[:Category:Outdated Availability Parameters|Outdated Availability Parameters]]. Please replace them with the  
+
{{tl|Availability}} changes over time, and thus has some parameters which have been deprecated. They will still function in this template, but their use will place the page into [[:Category:Outdated Availability Parameters|Outdated Availability Parameters]]. Please replace them with the appropriate new value.
 
{| class="wikitable grid"
 
{| class="wikitable grid"
 
! class="header" | Outdated Parameter
 
! class="header" | Outdated Parameter
 
! class="header" | New Parameter
 
! class="header" | New Parameter
 +
! class="header" | Output
 
|-
 
|-
−
| <code>crate-nice</code> || <code>crate36</code>
+
| <code>crate-scorched</code> || <code>crate46</code> || {{#invoke:Availability|avail|crate46}}
−
|-
 
−
| <code>crate-nice2012</code> || <code>crate53</code>
 
−
|-
 
−
| <code>crate-nice2013</code> || <code>crate79</code>
 
−
|-
 
−
| <code>crate-nice2014</code> || <code>crate89</code>
 
−
|-
 
−
| <code>crate-naughty</code> || <code>crate35-festive</code>
 
−
|-
 
−
| <code>crate-naughty2012</code> || <code>crate52-festive</code>
 
−
|-
 
−
| <code>crate-naughty2013</code> || <code>crate78-festive</code>
 
−
|-
 
−
| <code>crate-naughty2014</code> || <code>crate88-festive</code>
 
−
|-
 
−
| <code>store</code> || <code>purchase</code>
 
 
|-
 
|-
−
| <code>achievement</code> || <code>unlock</code>
+
| <code>crate74</code> || <code>crate74-haunted</code> || {{#invoke:Availability|avail|crate74-haunted}}
 
|-
 
|-
−
| <code>strongbox</code> || <code>crate81</code>
+
| <code>crate74-expired</code> || <code>crate74-haunted</code> || {{#invoke:Availability|avail|crate74-haunted}}
 
|-
 
|-
−
| <code>crate46</code> || <code>crate-scorched</code>
+
| <code>xmas2015</code> || <code>festive-gift</code> || {{#invoke:Availability|avail|festive-gift}}
−
|-
 
−
| <code>crate74</code> || <code>crate74-haunted</code>
 
−
|-
 
−
| <code>winter2016</code> || <code>crate105</code>
 
−
|-
 
−
| <code>crate##-nohaunt</code> || <code>crate##</code>
 
−
|}
 
−
 
 
−
=== Deprecated Parameters ===
 
−
 
 
−
{| class="wikitable grid"
 
−
! class="header" | Parameter
 
−
! class="header" | Deprecation reason
 
 
|-
 
|-
−
| <code>strangifier</code> || Strangifiers do not grant new items, they merely change the quality of existing ones.
+
| <code>winter2016</code> || <code>case105</code> || {{#invoke:Availability|avail|case105}}
 
|-
 
|-
−
| <code>strangifier-strange</code> || Strangifiers do not grant new items, they merely change the quality of existing ones.
+
| <code>winter2016-strange</code> || <code>case105</code> || {{#invoke:Availability|avail|case105}}
 
|-
 
|-
−
| <code>strangifier-series-5</code> || Strangifiers do not grant new items, they merely change the quality of existing ones.
+
| <code>winter2016-unusual</code> || <code>case105</code> || {{#invoke:Availability|avail|case105}}
 
|-
 
|-
−
| <code>strangifier-crate-6</code> || Strangifiers do not grant new items, they merely change the quality of existing ones.
+
| <code>unusual-#</code> || <code>unusual</code> || {{#invoke:Availability|avail|unusual}}
 
|}
 
|}

Latest revision as of 16:48, 2 January 2024

Edit this documentation page
Template complex.pngThis module is very complex. If you have questions about this module, feel free to ask on the IRC. Darkid has offered to maintain this module, you may contact them if you need further assistance.
To update which crate series are linked as active, change the list in Module:Availability/active.

Module:Availability (aka Template:Availability) is used to display and autotranslate the 'Availability' section in {{Item infobox}}. Preferably, the shortcut {{avail}} should be used.

For future reference, if creating new additions, the key cannot include a number, or it will be parsed out. Thus, if you want to add a string like xmas2015, instead add it to the Multipart strings with xmas and use num to represent the 2015.


Entries

Parameter Output
audition-reel Audition Reel
bread-box Bread Box (Unique and Strange)
chemistryset Chemistry Set
case-any Uncrate (any case)
case-bonus Uncrate (bonus)
collectors Chemistry Set (Collector's)
contract Contract (Decorated)
contract-unique ConTracker
craft Craft
craft-expired Craft (expired)
creepy-crate Unlocked Creepy Crate
directors Director's Cut Reel
distributed Distributed
distributed-duels Distributed (periodical)
distributed-expired Distributed (expired)
distributed-gifts Distributed (periodical)
distributed-stamps Distributed (periodical)
drop Drop
drop-expired Drop (expired)
festive-gift Smissmas 2015 Festive Gift
gift-cauldron Halloween Gift Cauldron
goodie-cauldron Antique Halloween Goodie Cauldron (limited)
halloween-package Halloween Package
halloween-purchase Purchase
halloween-purchase-expired Purchase (expired)
hauntedgift Haunted Halloween Gift (expired)
jungleinferno-campaign Jungle Inferno Campaign Pass (limited)
jungleinferno-contracts Jungle Inferno Contracts Pass
keyless-crate Unlocked Cosmetic Crate (Unique and Strange)
keyless-crate-unusual Unlocked Cosmetic Crate (Unique, Strange and Unusual)
mvm As Mann vs. Machine reward
pallet-of-crates Pallet of Crates
pile-of-curses Pile of Curses (expired)
promotional Promotional
promotional-craft Promotional (craft)
promotional-expired Promotional (expired)
promotional-expired-codes Promotional (expired)
promotional-unlock Promotional (unlock)
purchase Purchase
purchase-limited Purchase (limited)
retired Retired
stock Stock
stockpile Stockpile Crate
trade-up Trade-Up
transmute Halloween Transmute (Untradable)
unavailable Unavailable
unlock Unlock
unusual Uncrate (Unusual)
unusual-expired Uncrate (Unusual) (expired)
warpaint War Paint (Decorated)
MvM related strings
mannup Reward
australium Reward (Australium)
botkiller Reward (Botkiller)
mvm-both-types Reward (Botkiller and Australium)
Dynamic strings (mostly used for crate numbers). The numeric value is automatically parsed.
crate1 Uncrate #1
crate2-strange Uncrate #2 (Strange)
crate3-festive Uncrate #3 (Festive)
crate4-haunted Uncrate #4 (Haunted) (expired)
crate5-bonus Uncrate #5 (bonus)
crate6-expired Uncrate #6 (expired)
crate91 Uncrate #91
crate92 Uncrate #92
case104 Uncrate #104 (Creepy Crawly Case)
case105 Uncrate #105 (Unlocked Winter 2016 Cosmetic Case)

Usage

Backwards compatibility

{{Availability}} changes over time, and thus has some parameters which have been deprecated. They will still function in this template, but their use will place the page into Outdated Availability Parameters. Please replace them with the appropriate new value.

Outdated Parameter New Parameter Output
crate-scorched crate46 Uncrate #46
crate74 crate74-haunted Uncrate #74 (Haunted) (expired)
crate74-expired crate74-haunted Uncrate #74 (Haunted) (expired)
xmas2015 festive-gift Smissmas 2015 Festive Gift
winter2016 case105 Uncrate #105 (Unlocked Winter 2016 Cosmetic Case)
winter2016-strange case105 Uncrate #105 (Unlocked Winter 2016 Cosmetic Case)
winter2016-unusual case105 Uncrate #105 (Unlocked Winter 2016 Cosmetic Case)
unusual-# unusual Uncrate (Unusual)
Retrieved from "https://wiki.teamfortress.com/w/index.php?title=Module:Availability/doc&oldid=3598036"