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}}
{{TS}}
== Usage ==
The data for each item is populated from [[Data:ItemData.json]] and retrieved by [[Module:ItemData]].
===Examples===
<pre>
{{ItemBox|Close Quarters}}
{{ItemBox|Spirit Shredder Bullets}}
{{ItemBox|Shadow Weave}}
{{ItemBox|Silencer}}
{{ItemBox|Haunting Shot}}
{{ItemBox|Extra Health}}
{{ItemBox|Bullet Lifesteal|overrideLinkClick = Bullet_Lifesteal_(item)}}
{{ItemBox|Dispel Magic}}
{{ItemBox|Unstoppable}}
{{ItemBox|Celestial Blessing}}
{{ItemBox|Golden Goose Egg}}
{{ItemBox|Duration Extender|overrideIsImbue = true}}
{{ItemBox|Surge of Power|overrideIsImbue = true}}
{{ItemBox|Echo Shard|overrideIsImbue = true}}
{{ItemBox|Frostbite Charm}}
</pre>


{{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]].
{{ItemBox|Close Quarters}}
{{ItemBox|Spirit Shredder Bullets}}
{{ItemBox|Shadow Weave}}
{{ItemBox|Silencer}}
{{ItemBox|Haunting Shot}}
{{ItemBox|Extra Health}}
{{ItemBox|Bullet Lifesteal|overrideLinkClick = Bullet_Lifesteal_(item)}}
{{ItemBox|Dispel Magic}}
{{ItemBox|Unstoppable}}
{{ItemBox|Celestial Blessing}}
{{ItemBox|Golden Goose Egg}}
{{ItemBox|Duration Extender|overrideIsImbue = true}}
{{ItemBox|Surge of Power|overrideIsImbue = true}}
{{ItemBox|Echo Shard|overrideIsImbue = true}}
{{ItemBox|Frostbite Charm}}


<pre>
<pre>
{{ItemBox|Extended Magazine}}
{{ItemBox|Restorative Shot|showTierTag = true}}
{{ItemBox|High-Velocity Rounds|overrideDisplayName = Test Name}}
{{ItemBox|Intensifying Magazine|overrideTier = 4}}
{{ItemBox|Weakening Headshot|overrideSlot = Tech}}
{{ItemBox|Recharging Rush|overrideIsActive = true}}
{{ItemBox|Alchemical Fire|overrideIsImbue = true}}
{{ItemBox|Ballistic Enchantment|overrideLinkTooltip = Extended Magazine}}
{{ItemBox|Escalating Resilience|overrideLinkImage = Extended Magazine}}
{{ItemBox|Headhunter|overrideLinkClick = Extended Magazine}}
</pre>
</pre>
{{ItemBox|Extended Magazine}}
== Parameters ==


{{ItemBox|Restorative Shot|showTierTag = true}}
{{ItemBox|High-Velocity Rounds|overrideDisplayName = Test Name}}
{{ItemBox|Intensifying Magazine|overrideTier = 4}}
{{ItemBox|Weakening Headshot|overrideSlot = Tech}}
{{ItemBox|Recharging Rush|overrideIsActive = true}}
{{ItemBox|Alchemical Fire|overrideIsImbue = true}}
{{ItemBox|Ballistic Enchantment|overrideLinkTooltip = Extended Magazine}}
{{ItemBox|Escalating Resilience|overrideLinkImage = Extended Magazine}}
{{ItemBox|Headhunter|overrideLinkClick = Extended Magazine}}
<templatedata>
<templatedata>
{
{
"description": "",
"params": {
"params": {
"itemName": {
"itemName": {
"description": "Item name; keys into Module:ItemData. Positional.",
"description": "Name of the item. Will be used to get the item data from [[Module:ItemData]]",
"example": "Extended Magazine",
"type": "string",
"type": "string",
"required": true,
"required": true,
"aliases": ["1"],
"aliases": ["1"]
"example": "Extended Magazine"
},
"size": {
"description": "Scales the whole card. 1 = default (80px wide), 1.5 = 150%, 0.75 = 75%.",
"type": "number",
"default": "1",
"example": "1.5"
},
},
"showTierTag": {
"showTierTag": {
"description": "Set to true to show the tier corner badge.",
"description": "Enable a tag top right on the card to show its tier.",
"type": "boolean",
"example": "true",
"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": {
"overrideDisplayName": {
"description": "Replaces the name shown on the card.",
"description": "Overrides the name that is displayed on the card.",
"type": "string",
"example": "Test",
"example": "Test Name"
"type": "string"
},
},
"overrideTier": {
"overrideTier": {
"description": "Replaces the card's tier.",
"description": "Overrides the cards tier.",
"type": "number",
"example": "1, 2, 3, 4 or 5",
"suggestedvalues": ["1", "2", "3", "4", "5"]
"type": "string"
},
},
"overrideSlot": {
"overrideSlot": {
"description": "Replaces the card's background (type).",
"description": "Overrides the cards slot type.",
"type": "string",
"example": "Weapon, Armor or Tech",
"suggestedvalues": ["Weapon", "Vitality", "Spirit"]
"type": "string"
},
},
"overrideIsActive": {
"overrideIsActive": {
"description": "Forces the ACTIVE tag on or off.",
"description": "Overrides the ACTIVE tag.",
"type": "boolean",
"example": "true or false",
"suggestedvalues": ["true", "false"]
"type": "string"
},
},
"overrideIsImbue": {
"overrideIsImbue": {
"description": "Forces the IMBUE tag on or off.",
"description": "Overrides the IMBUE tag.",
"type": "boolean",
"example": "true or false",
"suggestedvalues": ["true", "false"]
"type": "string"
},
},
"overrideLinkTooltip": {
"overrideLinkTooltip": {
"description": "Page the hover tooltip reads its info from.",
"description": "Overrides the link from where the tooltip gets its info.",
"type": "string",
"example": "Extended Magazine",
"example": "Extended Magazine"
"type": "string"
},
},
"overrideLinkImage": {
"overrideLinkImage": {
"description": "Page/file the icon image comes from.",
"description": "Overrides the link from where ItemBox gets the image.",
"type": "string",
"example": "Extended Magazine",
"example": "Extended Magazine"
"type": "string"
},
},
"overrideLinkClick": {
"overrideLinkClick": {
"description": "Page the card links to when clicked.",
"description": "The name of the item's link in cases where itemName is incorrect",
"type": "string",
"example": "Bullet Lifesteal (item)",
"example": "Bullet Lifesteal (item)"
"type": "string"
}
}
},
},
"paramOrder": [
"paramOrder": [
"itemName", "size", "showTierTag", "lowGraphics",
"itemName",
"overrideDisplayName", "overrideTier", "overrideSlot",
"showTierTag",
"overrideIsActive", "overrideIsImbue",
        "overrideDisplayName",
"overrideLinkTooltip", "overrideLinkImage", "overrideLinkClick"
"overrideTier",
"overrideSlot",
"overrideIsActive",
"overrideIsImbue",
"overrideLinkTooltip",
"overrideLinkImage",
"overrideLinkClick"
],
],
"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"