Template:ItemBox/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Jannepg (talk | contribs)
Updated documentation for the new ItemBox
Jannepg (talk | contribs)
mNo edit summary
Line 61: Line 61:
"params": {
"params": {
"itemName": {
"itemName": {
    "label": "Item Name",
"description": "Name of the item. Will be used to get the item data from [[Module:ItemData]]",
"description": "Name of the item. Will be used to get the item data from [[Module:ItemData]]",
"example": "Extended Magazine",
"example": "Extended Magazine",
Line 68: Line 69:
},
},
"showTierTag": {
"showTierTag": {
    "label": "Show Tier Tag",
"description": "Enable a tag top right on the card to show its tier.",
"description": "Enable a tag top right on the card to show its tier.",
"example": "true",
"suggestedvalues": ["true, false"],
"type": "string"
"type": "string"
},
},
"overrideDisplayName": {
"overrideDisplayName": {
    "label": "Override Display Name",
"description": "Overrides the name that is displayed on the card.",
"description": "Overrides the name that is displayed on the card.",
"example": "Test",
"example": "Test",
Line 78: Line 81:
},
},
"overrideTier": {
"overrideTier": {
    "label": "Override Tier",
"description": "Overrides the cards tier.",
"description": "Overrides the cards tier.",
"example": "1, 2, 3, 4 or 5",
"suggestedvalues": ["1, 2, 3, 4, 5"],
"type": "string"
"type": "string"
},
},
"overrideSlot": {
"overrideSlot": {
    "label": "Override Slot",
"description": "Overrides the cards slot type.",
"description": "Overrides the cards slot type.",
"example": "Weapon, Armor or Tech",
"suggestedvalues": ["Weapon, Armor, Tech"],
"type": "string"
"type": "string"
},
},
"overrideIsActive": {
"overrideIsActive": {
    "label": "Override Is Active",
"description": "Overrides the ACTIVE tag.",
"description": "Overrides the ACTIVE tag.",
"example": "true or false",
"suggestedvalues": ["true, false"],
"type": "string"
"type": "string"
},
},
"overrideIsImbue": {
"overrideIsImbue": {
    "label": "Override Is Imbue",
"description": "Overrides the IMBUE tag.",
"description": "Overrides the IMBUE tag.",
"example": "true or false",
"suggestedvalues": ["true, false"],
"type": "string"
"type": "string"
},
},
"overrideLinkTooltip": {
"overrideLinkTooltip": {
    "label": "Override Link Tooltip",
"description": "Overrides the link from where the tooltip gets its info.",
"description": "Overrides the link from where the tooltip gets its info.",
"example": "Extended Magazine",
"example": "Extended Magazine",
Line 103: Line 111:
},
},
"overrideLinkImage": {
"overrideLinkImage": {
"description": "Overrides the link from where ItemBox gets the image.",
    "label": "Override Link Image",
"description": "Overrides the link from where the ItemBox gets the image.",
"example": "Extended Magazine",
"example": "Extended Magazine",
"type": "string"
"type": "string"
},
},
"overrideLinkClick": {
"overrideLinkClick": {
"description": "The name of the item's link in cases where itemName is incorrect",
    "label": "Override Link Click",
"description": "Overrides where the ItemBox links to when clicked on.",
"example": "Bullet Lifesteal (item)",
"example": "Bullet Lifesteal (item)",
"type": "string"
"type": "string"
}
}
},
},
"paramOrder": [
"description": " "
"itemName",
"showTierTag",
        "overrideDisplayName",
"overrideTier",
"overrideSlot",
"overrideIsActive",
"overrideIsImbue",
"overrideLinkTooltip",
"overrideLinkImage",
"overrideLinkClick"
],
"format": "inline"
}
}
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 02:01, 19 May 2026

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

The data for each item is populated from Data:ItemData.json and retrieved by Module:ItemData.

Examples

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

Close Quarters

Active
Imbue

Spirit Shredder Bullets

Active
Imbue

Shadow Weave

Active
Imbue

Silencer

Active
Imbue

Haunting Shot

Active
Imbue

Extra Health

Active
Imbue

Bullet Lifesteal

Active
Imbue

Dispel Magic

Active
Imbue

Unstoppable

Active
Imbue

Celestial Blessing

Active
Imbue

Golden Goose Egg

Active
Imbue

Duration Extender

Active
Imbue

Surge of Power

Active
Imbue

Echo Shard

Active
Imbue

Frostbite Charm

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

Restorative Shot

Active
Imbue

Test Name

Active
Imbue

Intensifying Magazine

Active
Imbue

Weakening Headshot

Active
Imbue

Recharging Rush

Active
Imbue

Alchemical Fire

Active
Imbue

Ballistic Enchantment

Active
Imbue

Escalating Resilience

Active
Imbue

Headhunter

Active

Template parameters

ParameterDescriptionTypeStatus
Item NameitemName 1

Name of the item. Will be used to get the item data from [[Module:ItemData]]

Example
Extended Magazine
Stringrequired
Show Tier TagshowTierTag

Enable a tag top right on the card to show its tier.

Suggested values
true, false
Stringoptional
Override Display NameoverrideDisplayName

Overrides the name that is displayed on the card.

Example
Test
Stringoptional
Override TieroverrideTier

Overrides the cards tier.

Suggested values
1, 2, 3, 4, 5
Stringoptional
Override SlotoverrideSlot

Overrides the cards slot type.

Suggested values
Weapon, Armor, Tech
Stringoptional
Override Is ActiveoverrideIsActive

Overrides the ACTIVE tag.

Suggested values
true, false
Stringoptional
Override Is ImbueoverrideIsImbue

Overrides the IMBUE tag.

Suggested values
true, false
Stringoptional
Override Link TooltipoverrideLinkTooltip

Overrides the link from where the tooltip gets its info.

Example
Extended Magazine
Stringoptional
Override Link ImageoverrideLinkImage

Overrides the link from where the ItemBox gets the image.

Example
Extended Magazine
Stringoptional
Override Link ClickoverrideLinkClick

Overrides where the ItemBox links to when clicked on.

Example
Bullet Lifesteal (item)
Stringoptional