@@ 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}}
-All data for each item is populated using data from [[Data:ItemData.json]], retrieved by [[Module:ItemData]].
+== Usage ==
-===Examples===
+{{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]].
 <pre>
-{{ItemBox|item_name = Spirit Shredder Bullets|link=Basic Magazine}}
+{{ItemBox|Extended Magazine}}
-{{ItemBox|item_name = High-Velocity Rounds}}
-{{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)}}
-{{ItemBox|item_name = Custom Item|item_price=800|item_type=Weapon|ignore=1}}
 </pre>
-{{ItemBox|item_name = Spirit Shredder Bullets|link=Basic Magazine}}
+{{ItemBox|Extended Magazine}}
-{{ItemBox|item_name = High-Velocity Rounds}}
-{{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)}}
-{{ItemBox|item_name = Custom Item|item_price=800|item_type=Weapon|ignore=1}}
 <templatedata>
 {
+	"description": "",
 	"params": {
-		"item_name": {
+		"itemName": {
-			"description": "Name of the item",
+			"description": "Item name; keys into Module:ItemData. Positional.",
-			"example": "Basic Magazine",
 			"type": "string",
 			"required": true,
-			"aliases": [
+			"aliases": ["1"],
-				"1"
+			"example": "Extended Magazine"
-			]
 		},
-		"link": {
+		"size": {
-			"description": "The name of the item's link in cases where item_name is incorrect",
+			"description": "Scales the whole card. 1 = default (80px wide), 1.5 = 150%, 0.75 = 75%.",
-			"example": "Bullet Lifesteal (item)",
+			"type": "number",
-			"type": "string"
+			"default": "1",
+			"example": "1.5"
 		},
-        "item_loc": {
+		"showTierTag": {
-			"description": "The name of the item, when is needed get data from a item, but print other item's name.",
+			"description": "Set to true to show the tier corner badge.",
-			"example": "Bullet Lifesteal (item)",
+			"type": "boolean",
-			"type": "string"
+			"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"]
 		},
-		"item_type": {
+		"overrideSlot": {
-			"description": "Overrides default item type. See Module:ItemData",
+			"description": "Replaces the card's background (type).",
-			"example": "Spirit",
 			"type": "string",
-			"suggestedvalues": [
+			"suggestedvalues": ["Weapon", "Vitality", "Spirit"]
-				"Weapon",
-				"Vitality",
-				"Spirit"
-			]
 		},
-		"item_price": {
+		"overrideIsActive": {
-			"description": "Overrides default item price. See Module:ItemData",
+			"description": "Forces the ACTIVE tag on or off.",
-			"example": "500",
+			"type": "boolean",
-			"type": "number"
+			"suggestedvalues": ["true", "false"]
 		},
-		"ignore": {
+		"overrideIsImbue": {
-			"description": "Skip database lookups for items not in ItemData.json. When set to 1, the template will not attempt to retrieve data from Module:ItemData and will use default or override values only. Useful for custom items, test items, or items not yet in the database.",
+			"description": "Forces the IMBUE tag on or off.",
-			"example": "1",
 			"type": "boolean",
-			"suggestedvalues": [
+			"suggestedvalues": ["true", "false"]
-				"1 or 0"
+		},
-			]
+		"overrideLinkTooltip": {
+			"description": "Page the hover tooltip reads its info from.",
+			"type": "string",
+			"example": "Extended Magazine"
+		},
+		"overrideLinkImage": {
+			"description": "Page/file the icon image comes from.",
+			"type": "string",
+			"example": "Extended Magazine"
+		},
+		"overrideLinkClick": {
+			"description": "Page the card links to when clicked.",
+			"type": "string",
+			"example": "Bullet Lifesteal (item)"
 		}
 	},
 	"paramOrder": [
-		"item_name",
+		"itemName", "size", "showTierTag", "lowGraphics",
-		"link",
+		"overrideDisplayName", "overrideTier", "overrideSlot",
-        "item_loc",
+		"overrideIsActive", "overrideIsImbue",
-		"item_type",
+		"overrideLinkTooltip", "overrideLinkImage", "overrideLinkClick"
-		"item_price",
-		"ignore"
 	],
 	"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>

Template:ItemBox/doc: Difference between revisionsGive feedback

Vergir (talk | contribs)