Editing Template:ItemBox/doc

Jump to navigation Jump to search
Warning: You are not logged in. Once you make an edit, a temporary account will be created for you. Learn more. Log in or create an account to continue receiving notifications after this account expires, and to access other features.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
{{TS}}
A port of the initial box in [[Template:Infobox item]] with links, for use on pages that could use it without the whole infobox.
== Usage ==
All data for each item is populated using data from [[Data:ItemData.json]], retrieved by [[Module:ItemData]].
 
===Examples===
{{tl|ItemBox}} renders a Deadlock shop item as a card: icon, tier art, and the item name auto-sized to fit. Pass an item name and everything else — tier, slot, tags, image — is pulled from [[Module:ItemData]].
 
<pre>
<pre>
{{ItemBox|Extended Magazine}}
{{ItemBox|item_name = Spirit Shredder Bullets|link=Basic Magazine}}
{{ItemBox|item_name = High-Velocity Rounds}}
{{ItemBox|item_name = Titanic Magazine}}
{{ItemBox|item_name = Shadow Weave}}
{{ItemBox|item_name = Debuff Remover}}
{{ItemBox|item_name = Duration Extender}}
{{ItemBox|item_name = Improved Spirit}}
{{ItemBox|item_name = Bullet Lifesteal|link=Bullet Lifesteal (item)}}
{{ItemBox|item_name = Custom Item|item_price=800|item_type=Weapon|ignore=1}}
</pre>
</pre>
{{ItemBox|Extended Magazine}}
{{ItemBox|item_name = Spirit Shredder Bullets|link=Basic Magazine}}
 
{{ItemBox|item_name = High-Velocity Rounds}}
== Parameters ==
{{ItemBox|item_name = Titanic Magazine}}  
 
{{ItemBox|item_name = Shadow Weave}}
{{ItemBox|item_name = Debuff Remover}}
{{ItemBox|item_name = Duration Extender}}
{{ItemBox|item_name = Improved Spirit}}
{{ItemBox|item_name = Bullet Lifesteal|link=Bullet Lifesteal (item)}}
{{ItemBox|item_name = Custom Item|item_price=800|item_type=Weapon|ignore=1}}
<templatedata>
<templatedata>
{
{
"description": "",
"params": {
"params": {
"itemName": {
"item_name": {
"description": "Item name; keys into Module:ItemData. Positional.",
"description": "Name of the item",
"example": "Basic Magazine",
"type": "string",
"type": "string",
"required": true,
"required": true,
"aliases": ["1"],
"aliases": [
"example": "Extended Magazine"
"1"
]
},
},
"size": {
"link": {
"description": "Scales the whole card. 1 = default (80px wide), 1.5 = 150%, 0.75 = 75%.",
"description": "The name of the item's link in cases where item_name is incorrect",
"type": "number",
"example": "Bullet Lifesteal (item)",
"default": "1",
"type": "string"
"example": "1.5"
},
},
"showTierTag": {
        "item_loc": {
"description": "Set to true to show the tier corner badge.",
"description": "The name of the item, when is needed get data from a item, but print other item's name.",
"type": "boolean",
"example": "Bullet Lifesteal (item)",
"suggestedvalues": ["true", "false"]
"type": "string"
},
"lowGraphics": {
"description": "Set to true for pages that place many cards at once (the card navboxes). Swaps the paper texture to a cacheable overlay so scrolling stays smooth; the look is nearly identical.",
"type": "boolean",
"suggestedvalues": ["true", "false"]
},
"overrideDisplayName": {
"description": "Replaces the name shown on the card.",
"type": "string",
"example": "Test Name"
},
"overrideTier": {
"description": "Replaces the card's tier.",
"type": "number",
"suggestedvalues": ["1", "2", "3", "4", "5"]
},
},
"overrideSlot": {
"item_type": {
"description": "Replaces the card's background (type).",
"description": "Overrides default item type. See Module:ItemData",
"example": "Spirit",
"type": "string",
"type": "string",
"suggestedvalues": ["Weapon", "Vitality", "Spirit"]
"suggestedvalues": [
"Weapon",
"Vitality",
"Spirit"
]
},
},
"overrideIsActive": {
"item_price": {
"description": "Forces the ACTIVE tag on or off.",
"description": "Overrides default item price. See Module:ItemData",
"type": "boolean",
"example": "500",
"suggestedvalues": ["true", "false"]
"type": "number"
},
},
"overrideIsImbue": {
"ignore": {
"description": "Forces the IMBUE tag on or off.",
"description": "Skip database lookups for items not in ItemData.json. When set to 1, the template will not attempt to retrieve data from Module:ItemData and will use default or override values only. Useful for custom items, test items, or items not yet in the database.",
"example": "1",
"type": "boolean",
"type": "boolean",
"suggestedvalues": ["true", "false"]
"suggestedvalues": [
},
"1 or 0"
"overrideLinkTooltip": {
]
"description": "Page the hover tooltip reads its info from.",
"type": "string",
"example": "Extended Magazine"
},
"overrideLinkImage": {
"description": "Page/file the icon image comes from.",
"type": "string",
"example": "Extended Magazine"
},
"overrideLinkClick": {
"description": "Page the card links to when clicked.",
"type": "string",
"example": "Bullet Lifesteal (item)"
}
}
},
},
"paramOrder": [
"paramOrder": [
"itemName", "size", "showTierTag", "lowGraphics",
"item_name",
"overrideDisplayName", "overrideTier", "overrideSlot",
"link",
"overrideIsActive", "overrideIsImbue",
        "item_loc",
"overrideLinkTooltip", "overrideLinkImage", "overrideLinkClick"
"item_type",
"item_price",
"ignore"
],
],
"format": "inline"
"format": "inline"
}
}
</templatedata>
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>
 
== Examples ==
 
=== Basic ===
 
<pre>
{{ItemBox|Close Quarters}}
{{ItemBox|Spirit Shredder Bullets}}
{{ItemBox|Silencer}}
{{ItemBox|Extra Health}}
{{ItemBox|Echo Shard}}
{{ItemBox|Celestial Blessing}}
</pre>
{{ItemBox|Close Quarters}}
{{ItemBox|Spirit Shredder Bullets}}
{{ItemBox|Silencer}}
{{ItemBox|Extra Health}}
{{ItemBox|Echo Shard}}
{{ItemBox|Celestial Blessing}}
 
=== Tier tag ===
 
<pre>
{{ItemBox|Extended Magazine|showTierTag = true}}
{{ItemBox|Berserker|showTierTag = true}}
{{ItemBox|Echo Shard|showTierTag = true}}
{{ItemBox|Celestial Blessing|showTierTag = true}}
</pre>
{{ItemBox|Extended Magazine|showTierTag = true}}
{{ItemBox|Berserker|showTierTag = true}}
{{ItemBox|Echo Shard|showTierTag = true}}
{{ItemBox|Celestial Blessing|showTierTag = true}}
 
=== Size ===
 
<pre>
{{ItemBox|Extended Magazine|size = 0.75}}
{{ItemBox|Extended Magazine}}
{{ItemBox|Extended Magazine|size = 1.5}}
</pre>
{{ItemBox|Extended Magazine|size = 0.75}}
{{ItemBox|Extended Magazine}}
{{ItemBox|Extended Magazine|size = 1.5}}
 
=== Low graphics ===
 
For pages that place many cards at once. The paper texture becomes a single cacheable overlay so scrolling stays smooth; the look is nearly identical.
 
<pre>
{{ItemBox|Extra Health}}
{{ItemBox|Kinetic Dash}}
{{ItemBox|Metal Skin}}
{{ItemBox|Echo Shard}}
 
{{ItemBox|Extra Health|lowGraphics = true}}
{{ItemBox|Kinetic Dash|lowGraphics = true}}
{{ItemBox|Metal Skin|lowGraphics = true}}
{{ItemBox|Echo Shard|lowGraphics = true}}
</pre>
'''Normal'''<br>
{{ItemBox|Extra Health}}
{{ItemBox|Kinetic Dash}}
{{ItemBox|Metal Skin}}
{{ItemBox|Echo Shard}}
 
'''Low graphics'''<br>
{{ItemBox|Extra Health|lowGraphics = true}}
{{ItemBox|Kinetic Dash|lowGraphics = true}}
{{ItemBox|Metal Skin|lowGraphics = true}}
{{ItemBox|Echo Shard|lowGraphics = true}}
 
=== Overrides ===
 
<pre>
{{ItemBox|High-Velocity Rounds|overrideDisplayName = Test Name}}
{{ItemBox|Intensifying Magazine|overrideTier = 4}}
{{ItemBox|Weakening Headshot|overrideSlot = Spirit}}
{{ItemBox|Recharging Rush|overrideIsActive = true}}
{{ItemBox|Alchemical Fire|overrideIsImbue = true}}
{{ItemBox|Bullet Lifesteal|overrideLinkClick = Heroes}}
</pre>
{{ItemBox|High-Velocity Rounds|overrideDisplayName = Test Name}}
{{ItemBox|Intensifying Magazine|overrideTier = 4}}
{{ItemBox|Weakening Headshot|overrideSlot = Spirit}}
{{ItemBox|Recharging Rush|overrideIsActive = true}}
{{ItemBox|Alchemical Fire|overrideIsImbue = true}}
{{ItemBox|Bullet Lifesteal|overrideLinkClick = Heroes}}
 
== References ==
 
* Item data — [[Data:ItemData.json]], read by [[Module:ItemData]]
* Name sizing and texture variety — [[Module:ItemBox]]
* Card styling — [[Template:ItemBox/styles.css]]
 
<noinclude>[[Category:Template documentation]]</noinclude>
Please note that all contributions to The Deadlock Wiki are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see Deadlock:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Pages included on this page:

Retrieved from "https://deadlock.wiki/Template:ItemBox/doc"