Template:ItemBox/doc: Difference between revisions

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>