The Deadlock Wiki

Template:ItemBox/doc: Difference between revisions

Browse history interactively
← Older edit

Vergir (talk | contribs)

2 user groups
1,631 edits
undo
VisualWikitext
Jannepg (talk | contribs)
153 edits
mNo edit summary
Vergir (talk | contribs)
Contributors, Interface administrators
1,631 edits
Add a Low graphics example showing normal vs lowGraphics cards side by side across tiers and slots (with help from vergir-bot LLM)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{TS}}
{{TS}}
The data for each item is populated from [[Data:ItemData.json]] and retrieved by [[Module:ItemData]].
== Usage ==
===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}}
{{ItemBox|Surge of Power}}
{{ItemBox|Echo Shard}}
{{ItemBox|Frostbite Charm}}
</pre>


{{ItemBox|Close Quarters}}
{{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|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}}
{{ItemBox|Surge of Power}}
{{ItemBox|Echo Shard}}
{{ItemBox|Frostbite Charm}}


<pre>
<pre>
{{ItemBox|Restorative Shot|showTierTag = true}}
{{ItemBox|Extended Magazine}}
{{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": {
    "label": "Item Name",
"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": {
    "label": "Show Tier Tag",
"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",
"suggestedvalues": ["true, false"],
"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": {
    "label": "Override Display Name",
"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": {
    "label": "Override Tier",
"description": "Replaces the card's tier.",
"description": "Overrides the cards tier.",
"type": "number",
"suggestedvalues": ["1, 2, 3, 4, 5"],
"suggestedvalues": ["1", "2", "3", "4", "5"]
"type": "string"
},
},
"overrideSlot": {
"overrideSlot": {
    "label": "Override Slot",
"description": "Replaces the card's background (type).",
"description": "Overrides the cards slot type.",
"type": "string",
"suggestedvalues": ["Weapon, Armor, Tech"],
"suggestedvalues": ["Weapon", "Vitality", "Spirit"]
"type": "string"
},
},
"overrideIsActive": {
"overrideIsActive": {
    "label": "Override Is Active",
"description": "Forces the ACTIVE tag on or off.",
"description": "Overrides the ACTIVE tag.",
"type": "boolean",
"suggestedvalues": ["true, false"],
"suggestedvalues": ["true", "false"]
"type": "string"
},
},
"overrideIsImbue": {
"overrideIsImbue": {
    "label": "Override Is Imbue",
"description": "Forces the IMBUE tag on or off.",
"description": "Overrides the IMBUE tag.",
"type": "boolean",
"suggestedvalues": ["true, false"],
"suggestedvalues": ["true", "false"]
"type": "string"
},
},
"overrideLinkTooltip": {
"overrideLinkTooltip": {
    "label": "Override Link Tooltip",
"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": {
    "label": "Override Link Image",
"description": "Page/file the icon image comes from.",
"description": "Overrides the link from where the ItemBox gets the image.",
"type": "string",
"example": "Extended Magazine",
"example": "Extended Magazine"
"type": "string"
},
},
"overrideLinkClick": {
"overrideLinkClick": {
    "label": "Override Link Click",
"description": "Page the card links to when clicked.",
"description": "Overrides where the ItemBox links to when clicked on.",
"type": "string",
"example": "Bullet Lifesteal (item)",
"example": "Bullet Lifesteal (item)"
"type": "string"
}
}
},
},
"description": " "
"paramOrder": [
"itemName", "size", "showTierTag", "lowGraphics",
"overrideDisplayName", "overrideTier", "overrideSlot",
"overrideIsActive", "overrideIsImbue",
"overrideLinkTooltip", "overrideLinkImage", "overrideLinkClick"
],
"format": "inline"
}
}
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>
</templatedata>
 
== 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>
Retrieved from "https://deadlock.wiki/Template:ItemBox/doc"