Difference between revisions of "Module:Availability/doc"
m (updated from doc) |
|||
(45 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
− | Module: | + | <div class="plainlinks" style="float:right"><small>[{{fullurl:Module:Availability/doc|action=edit}} Edit this documentation page]</small></div> |
+ | {{clr}} | ||
+ | {{Complex template|user=Darkid}} | ||
+ | {{Ambox | ||
+ | | type = notice | ||
+ | | contents = 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 {{tl|Item infobox}}. Preferably, the shortcut '''{{tl|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 <code>xmas2015</code>, instead add it to the Multipart strings with <code>xmas</code> and use <code>num</code> to represent the 2015. | ||
+ | |||
+ | __FORCETOC__ | ||
=== Entries === | === Entries === | ||
{| class="wikitable grid" | {| class="wikitable grid" | ||
Line 13: | Line 22: | ||
|- | |- | ||
| <code>chemistryset</code> || {{#invoke:Availability|avail|chemistryset}} | | <code>chemistryset</code> || {{#invoke:Availability|avail|chemistryset}} | ||
+ | |- | ||
+ | | <code>case-any</code> || {{#invoke:Availability|avail|case-any}} | ||
+ | |- | ||
+ | | <code>case-bonus</code> || {{#invoke:Availability|avail|case-bonus}} | ||
|- | |- | ||
| <code>collectors</code> || {{#invoke:Availability|avail|collectors}} | | <code>collectors</code> || {{#invoke:Availability|avail|collectors}} | ||
|- | |- | ||
| <code>contract</code> || {{#invoke:Availability|avail|contract}} | | <code>contract</code> || {{#invoke:Availability|avail|contract}} | ||
+ | |- | ||
+ | | <code>contract-unique</code> || {{#invoke:Availability|avail|contract-unique}} | ||
|- | |- | ||
| <code>craft</code> || {{#invoke:Availability|avail|craft}} | | <code>craft</code> || {{#invoke:Availability|avail|craft}} | ||
+ | |- | ||
+ | | <code>craft-expired</code> || {{#invoke:Availability|avail|craft-expired}} | ||
|- | |- | ||
| <code>creepy-crate</code> || {{#invoke:Availability|avail|creepy-crate}} | | <code>creepy-crate</code> || {{#invoke:Availability|avail|creepy-crate}} | ||
+ | |- | ||
+ | | <code>directors</code> || {{#invoke:Availability|avail|directors}} | ||
+ | |- | ||
+ | | <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-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-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> | + | | <code>goodie-cauldron</code> || {{#invoke:Availability|avail|goodie-cauldron}} |
|- | |- | ||
− | | <code> | + | | <code>halloween-package</code> || {{#invoke:Availability|avail|halloween-package}} |
|- | |- | ||
| <code>halloween-purchase</code> || {{#invoke:Availability|avail|halloween-purchase}} | | <code>halloween-purchase</code> || {{#invoke:Availability|avail|halloween-purchase}} | ||
+ | |- | ||
+ | | <code>halloween-purchase-expired</code> || {{#invoke:Availability|avail|halloween-purchase-expired}} | ||
|- | |- | ||
| <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-unusual</code> || {{#invoke:Availability|avail|keyless-crate-unusual}} | ||
|- | |- | ||
| <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>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-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}} | ||
+ | |- | ||
+ | | <code>purchase-limited</code> || {{#invoke:Availability|avail|purchase-limited}} | ||
|- | |- | ||
| <code>retired</code> || {{#invoke:Availability|avail|retired}} | | <code>retired</code> || {{#invoke:Availability|avail|retired}} | ||
Line 44: | Line 103: | ||
| <code>stockpile</code> || {{#invoke:Availability|avail|stockpile}} | | <code>stockpile</code> || {{#invoke:Availability|avail|stockpile}} | ||
|- | |- | ||
− | | <code> | + | | <code>trade-up</code> || {{#invoke:Availability|avail|trade-up}} |
+ | |- | ||
+ | | <code>transmute</code> || {{#invoke:Availability|avail|transmute}} | ||
|- | |- | ||
| <code>unavailable</code> || {{#invoke:Availability|avail|unavailable}} | | <code>unavailable</code> || {{#invoke:Availability|avail|unavailable}} | ||
Line 52: | Line 113: | ||
| <code>unusual</code> || {{#invoke:Availability|avail|unusual}} | | <code>unusual</code> || {{#invoke:Availability|avail|unusual}} | ||
|- | |- | ||
− | | <code> | + | | <code>unusual-expired</code> || {{#invoke:Availability|avail|unusual-expired}} |
|- | |- | ||
− | | colspan="2" | | + | | <code>warpaint</code> || {{#invoke:Availability|avail|warpaint}} |
+ | |- | ||
+ | ! class="header" colspan="2" | [[MvM]] related strings | ||
|- | |- | ||
| <code>mannup</code> || {{#invoke:Availability|avail|mannup}} | | <code>mannup</code> || {{#invoke:Availability|avail|mannup}} | ||
Line 64: | Line 127: | ||
| <code>mvm-both-types</code> || {{#invoke:Availability|avail|mvm-both-types}} | | <code>mvm-both-types</code> || {{#invoke:Availability|avail|mvm-both-types}} | ||
|- | |- | ||
− | + | ! 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 74: | Line 137: | ||
| <code>crate4-haunted</code> || {{#invoke:Availability|avail|crate4-haunted}} | | <code>crate4-haunted</code> || {{#invoke:Availability|avail|crate4-haunted}} | ||
|- | |- | ||
− | | <code> | + | | <code>crate5-bonus</code> || {{#invoke:Availability|avail|crate5-bonus}} |
+ | |- | ||
+ | | <code>crate6-expired</code> || {{#invoke:Availability|avail|crate6-expired}} | ||
+ | |- | ||
+ | | <code>crate91</code> || {{#invoke:Availability|avail|crate91}} | ||
|- | |- | ||
− | | <code> | + | | <code>crate92</code> || {{#invoke:Availability|avail|crate92}} |
|- | |- | ||
+ | | <code>case104</code> || {{#invoke:Availability|avail|case104}} | ||
+ | |- | ||
+ | | <code>case105</code> || {{#invoke:Availability|avail|case105}} | ||
|} | |} | ||
Line 85: | 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}} | ||
− | + | ||
+ | === Backwards compatibility === | ||
+ | {{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="header" | Outdated Parameter | ||
+ | ! class="header" | New Parameter | ||
+ | ! class="header" | Output | ||
+ | |- | ||
+ | | <code>crate-scorched</code> || <code>crate46</code> || {{#invoke:Availability|avail|crate46}} | ||
+ | |- | ||
+ | | <code>crate74</code> || <code>crate74-haunted</code> || {{#invoke:Availability|avail|crate74-haunted}} | ||
+ | |- | ||
+ | | <code>crate74-expired</code> || <code>crate74-haunted</code> || {{#invoke:Availability|avail|crate74-haunted}} | ||
+ | |- | ||
+ | | <code>xmas2015</code> || <code>festive-gift</code> || {{#invoke:Availability|avail|festive-gift}} | ||
+ | |- | ||
+ | | <code>winter2016</code> || <code>case105</code> || {{#invoke:Availability|avail|case105}} | ||
+ | |- | ||
+ | | <code>winter2016-strange</code> || <code>case105</code> || {{#invoke:Availability|avail|case105}} | ||
+ | |- | ||
+ | | <code>winter2016-unusual</code> || <code>case105</code> || {{#invoke:Availability|avail|case105}} | ||
+ | |- | ||
+ | | <code>unusual-#</code> || <code>unusual</code> || {{#invoke:Availability|avail|unusual}} | ||
+ | |} |
Latest revision as of 16:48, 2 January 2024
This 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.
Contents
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
{{avail|drop}}
produces Drop{{avail|drop|craft}}
produces Drop or Craft{{avail|drop|craft|purchase}}
produces Drop, Craft or Purchase{{avail|drop|craft|purchase|promotional}}
produces Drop, Craft, Purchase or Promotional
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) |