Template:ItemBox/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Browse history interactively
← Older edit

Vergir (talk | contribs)

2 user groups
1,631 edits
undo
VisualWikitext
m Added High-Velocity Mag as another example of an item with a long name.
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)
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
A port of the initial box in [[Template:Infobox item]] with links, for use on pages that could use it without the whole infobox.
{{TS}}
== Usage ==


All data for each item is populated using data from [[Data:ItemData.json]], retrieved by [[Module:ItemData]].
{{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]].


===Examples===
<pre>
<pre>
{{ItemBox|item_name = Soul Shredder Bullets|link=Basic Magazine}}
{{ItemBox|Extended Magazine}}
{{ItemBox|item_name = High-Velocity Mag}}
{{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)}}
</pre>
</pre>
{{ItemBox|item_name = Soul Shredder Bullets|link=Basic Magazine}}  
{{ItemBox|Extended Magazine}}
{{ItemBox|item_name = High-Velocity Mag}}
 
{{ItemBox|item_name = Titanic Magazine}}
== Parameters ==
{{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)}}


<templatedata>
<templatedata>
{
{
"description": "",
"params": {
"params": {
"item_name": {
"itemName": {
"description": "Name of the item",
"description": "Item name; keys into Module:ItemData. Positional.",
"example": "Basic Magazine",
"type": "string",
"type": "string",
"required": true,
"required": true,
"aliases": [
"aliases": ["1"],
"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": {
"description": "Set to true to show the tier corner badge.",
"type": "boolean",
"suggestedvalues": ["true", "false"]
},
"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": {
"description": "Replaces the card's background (type).",
"type": "string",
"suggestedvalues": ["Weapon", "Vitality", "Spirit"]
},
"overrideIsActive": {
"description": "Forces the ACTIVE tag on or off.",
"type": "boolean",
"suggestedvalues": ["true", "false"]
},
"overrideIsImbue": {
"description": "Forces the IMBUE tag on or off.",
"type": "boolean",
"suggestedvalues": ["true", "false"]
},
},
"link": {
"overrideLinkTooltip": {
"description": "The name of the item's link in cases where item_name is incorrect",
"description": "Page the hover tooltip reads its info from.",
"example": "Bullet Lifesteal (item)",
"type": "string",
"type": "string"
"example": "Extended Magazine"
},
},
"item_type": {
"overrideLinkImage": {
"description": "Overrides default item type. See Module:ItemData",
"description": "Page/file the icon image comes from.",
"example": "Spirit",
"type": "string",
"type": "string",
"suggestedvalues": [
"example": "Extended Magazine"
"Weapon",
"Vitality",
"Spirit"
]
},
},
"item_price": {
"overrideLinkClick": {
"description": "Overrides default item price. See Module:ItemData",
"description": "Page the card links to when clicked.",
"example": "500",
"type": "string",
"type": "number"
"example": "Bullet Lifesteal (item)"
}
}
},
},
"paramOrder": [
"paramOrder": [
"item_name",
"itemName", "size", "showTierTag", "lowGraphics",
"link",
"overrideDisplayName", "overrideTier", "overrideSlot",
"item_type",
"overrideIsActive", "overrideIsImbue",
"item_price"
"overrideLinkTooltip", "overrideLinkImage", "overrideLinkClick"
],
],
"format": "inline"
"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>

Latest revision as of 10:14, 25 July 2026

CSS3 logo.svg
This template uses CSS found at ItemBox/styles.css.

Usage

[edit source]

{{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|Extended Magazine}}
Imbue

Extended Magazine

Active

Parameters

[edit source]

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
itemNameitemName 1

Item name; keys into Module:ItemData. Positional.

Example
Extended Magazine
Stringrequired
sizesize

Scales the whole card. 1 = default (80px wide), 1.5 = 150%, 0.75 = 75%.

Default
1
Example
1.5
Numberoptional
showTierTagshowTierTag

Set to true to show the tier corner badge.

Suggested values
true false
Booleanoptional
lowGraphicslowGraphics

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.

Suggested values
true false
Booleanoptional
overrideDisplayNameoverrideDisplayName

Replaces the name shown on the card.

Example
Test Name
Stringoptional
overrideTieroverrideTier

Replaces the card's tier.

Suggested values
1 2 3 4 5
Numberoptional
overrideSlotoverrideSlot

Replaces the card's background (type).

Suggested values
Weapon Vitality Spirit
Stringoptional
overrideIsActiveoverrideIsActive

Forces the ACTIVE tag on or off.

Suggested values
true false
Booleanoptional
overrideIsImbueoverrideIsImbue

Forces the IMBUE tag on or off.

Suggested values
true false
Booleanoptional
overrideLinkTooltipoverrideLinkTooltip

Page the hover tooltip reads its info from.

Example
Extended Magazine
Stringoptional
overrideLinkImageoverrideLinkImage

Page/file the icon image comes from.

Example
Extended Magazine
Stringoptional
overrideLinkClickoverrideLinkClick

Page the card links to when clicked.

Example
Bullet Lifesteal (item)
Stringoptional

Examples

[edit source]

Basic

[edit source]
{{ItemBox|Close Quarters}}
{{ItemBox|Spirit Shredder Bullets}}
{{ItemBox|Silencer}}
{{ItemBox|Extra Health}}
{{ItemBox|Echo Shard}}
{{ItemBox|Celestial Blessing}}
Imbue

Close Quarters

Active
Imbue

Spirit Shredder Bullets

Active
Imbue

Silencer

Active
Imbue

Extra Health

Active
Imbue

Echo Shard

Active
Imbue

Celestial Blessing

Active

Tier tag

[edit source]
{{ItemBox|Extended Magazine|showTierTag = true}}
{{ItemBox|Berserker|showTierTag = true}}
{{ItemBox|Echo Shard|showTierTag = true}}
{{ItemBox|Celestial Blessing|showTierTag = true}}
Imbue

Extended Magazine

Active
Imbue

Berserker

Active
Imbue

Echo Shard

Active
Imbue

Celestial Blessing

Active

Size

[edit source]
{{ItemBox|Extended Magazine|size = 0.75}}
{{ItemBox|Extended Magazine}}
{{ItemBox|Extended Magazine|size = 1.5}}
Imbue

Extended Magazine

Active
Imbue

Extended Magazine

Active
Imbue

Extended Magazine

Active

Low graphics

[edit source]

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. 

{{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}}

Normal

Imbue

Extra Health

Active
Imbue

Kinetic Dash

Active
Imbue

Metal Skin

Active
Imbue

Echo Shard

Active

Low graphics

Imbue

Extra Health

Active
Imbue

Kinetic Dash

Active
Imbue

Metal Skin

Active
Imbue

Echo Shard

Active

Overrides

[edit source]
{{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}}
Imbue

Test Name

Active
Imbue

Intensifying Magazine

Active
Imbue

Weakening Headshot

Active
Imbue

Recharging Rush

Active
Imbue

Alchemical Fire

Active
Imbue

Bullet Lifesteal

Active

References

[edit source]
Retrieved from "https://deadlock.wiki/Template:ItemBox/doc?oldid=100300"