Template:ItemBox/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Vergir (talk | contribs)
Use Vitality/Spirit (not Armor/Tech) for the overrideSlot param and example (with help from vergir-bot LLM)
Vergir (talk | contribs)
mNo edit summary
Line 13: Line 13:
<templatedata>
<templatedata>
{
{
"description": "Renders a Deadlock shop item card.",
"description": "",
"params": {
"params": {
"itemName": {
"itemName": {
"label": "Item name",
"description": "Item name; keys into Module:ItemData. Positional.",
"description": "Item name; keys into Module:ItemData. Positional.",
"type": "string",
"type": "string",
Line 24: Line 23:
},
},
"size": {
"size": {
"label": "Size",
"description": "Scales the whole card. 1 = default (80px wide), 1.5 = 150%, 0.75 = 75%.",
"description": "Scales the whole card. 1 = default (80px wide), 1.5 = 150%, 0.75 = 75%.",
"type": "number",
"type": "number",
Line 31: Line 29:
},
},
"showTierTag": {
"showTierTag": {
"label": "Show tier tag",
"description": "Set to true to show the tier corner badge.",
"description": "Set to true to show the tier corner badge.",
"type": "boolean",
"type": "boolean",
Line 37: Line 34:
},
},
"overrideDisplayName": {
"overrideDisplayName": {
"label": "Override display name",
"description": "Replaces the name shown on the card.",
"description": "Replaces the name shown on the card.",
"type": "string",
"type": "string",
Line 43: Line 39:
},
},
"overrideTier": {
"overrideTier": {
"label": "Override tier",
"description": "Replaces the card's tier.",
"description": "Replaces the card's tier.",
"type": "number",
"type": "number",
Line 49: Line 44:
},
},
"overrideSlot": {
"overrideSlot": {
"label": "Override slot",
"description": "Replaces the card's background (type).",
"description": "Replaces the card's slot.",
"type": "string",
"type": "string",
"suggestedvalues": ["Weapon", "Vitality", "Spirit"]
"suggestedvalues": ["Weapon", "Vitality", "Spirit"]
},
},
"overrideIsActive": {
"overrideIsActive": {
"label": "Override active tag",
"description": "Forces the ACTIVE tag on or off.",
"description": "Forces the ACTIVE tag on or off.",
"type": "boolean",
"type": "boolean",
Line 61: Line 54:
},
},
"overrideIsImbue": {
"overrideIsImbue": {
"label": "Override imbue tag",
"description": "Forces the IMBUE tag on or off.",
"description": "Forces the IMBUE tag on or off.",
"type": "boolean",
"type": "boolean",
Line 67: Line 59:
},
},
"overrideLinkTooltip": {
"overrideLinkTooltip": {
"label": "Override tooltip source",
"description": "Page the hover tooltip reads its info from.",
"description": "Page the hover tooltip reads its info from.",
"type": "string",
"type": "string",
Line 73: Line 64:
},
},
"overrideLinkImage": {
"overrideLinkImage": {
"label": "Override image",
"description": "Page/file the icon image comes from.",
"description": "Page/file the icon image comes from.",
"type": "string",
"type": "string",
Line 79: Line 69:
},
},
"overrideLinkClick": {
"overrideLinkClick": {
"label": "Override click link",
"description": "Page the card links to when clicked.",
"description": "Page the card links to when clicked.",
"type": "string",
"type": "string",
Line 146: Line 135:
{{ItemBox|Recharging Rush|overrideIsActive = true}}
{{ItemBox|Recharging Rush|overrideIsActive = true}}
{{ItemBox|Alchemical Fire|overrideIsImbue = true}}
{{ItemBox|Alchemical Fire|overrideIsImbue = true}}
{{ItemBox|Bullet Lifesteal|overrideLinkClick = Bullet_Lifesteal_(item)}}
{{ItemBox|Bullet Lifesteal|overrideLinkClick = Heroes}}
</pre>
</pre>
{{ItemBox|High-Velocity Rounds|overrideDisplayName = Test Name}}
{{ItemBox|High-Velocity Rounds|overrideDisplayName = Test Name}}
Line 153: Line 142:
{{ItemBox|Recharging Rush|overrideIsActive = true}}
{{ItemBox|Recharging Rush|overrideIsActive = true}}
{{ItemBox|Alchemical Fire|overrideIsImbue = true}}
{{ItemBox|Alchemical Fire|overrideIsImbue = true}}
{{ItemBox|Bullet Lifesteal|overrideLinkClick = Bullet_Lifesteal_(item)}}
{{ItemBox|Bullet Lifesteal|overrideLinkClick = Heroes}}


== References ==
== References ==

Revision as of 18:58, 20 July 2026

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

Usage

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

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

Basic

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

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

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

Overrides

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