Difference between revisions of "Template:ItemStack/doc"

Latest revision as of 08:50, 17 October 2021

Description: A template to generate stack counter for item icons.; Interestingly, the two main arguments of this template will work with most (if not all) existing viewer templates and can be used as a generic way to overlay text.
Standard usage with 50px item images

{{ItemStack
|item = [[File:Item Icon Improvement Material.png{{!}}50px{{!}}link=]]
|text = x7
}}

x7

Main arguments

item

The background image. Default value is

text

The overlay text (images and audio also work). Defaults to default-text or empty string.

link

Embedded link using clickbox overlay.

[1]

Used for nested ItemStack calls, the generated element will be block-level.

Styling arguments

font-size

Set the size of the overlay text. Default value is 12px

text-position

Set the position of the overlay text. Default value is right:4px;bottom:-18px

position

Set the position of the overlay generated by nested ItemStack call.

text-color

Set the color of the text. Default value is f61

glow-size

Set the glow size of the text. Default value is 5px

glow-color

Set the color of the glow. Default value is fff

clickbox-opacity

Set the opacity of clickbox from 0 to 1 (used for aligning clickbox). Default value is 0.

clickbox-size

Set the size of the clickbox

clickbox-pos

Set the position of the clickbox

Custom usage with Template:Equipment/Card

{{ItemStack
|item = {{Equipment/Card|Prototype 51cm Twin Gun Mount|size=100px}}
|text-position = bottom:-40px;right:6px;
|font-size = 18px
|text = x9000
|glow-size = 15px
|text-color = fff
|glow-color = f00
}}

x9000

Nesting template usage

{{ItemStack
|item = {{Ship/Card|Ikazuchi/Kai|size=218px}}
|position = left:130px;
|{{ItemStack
|item = {{Ship/Card|Hibiki/Kai|size=218px}}
|position = left:130px;
|{{ItemStack
|item = {{Ship/Card|Akatsuki/Kai|size=218px}}
|position = left:130px;
|{{ItemStack
|item = {{Ship/Card|Inazuma/Kai|size=218px}}
|text = DesDiv6
|text-position = bottom:-130px;right:5px
|font-size = 20px
}}}}}}}}

DesDiv6

Image overlay

{{ItemStack
|item = {{Ship/Card|Ikazuchi/Kai|size=218px}}
|text-position = bottom:-135px;right:5px
|text = [[File:Marriage Ring Icon.png]]
}}

@@ Line 5: / Line 5: @@
 <pre>
 {{ItemStack
-|item = [[File:Improvement material.png{{!}}50px{{!}}link=]]
+|item = [[File:Item Icon Improvement Material.png{{!}}50px{{!}}link=]]
 |text = x7
 }}
 </pre>
 {{ItemStack
-|item = [[File:Improvement material.png{{!}}50px{{!}}link=]]
+|item = [[File:Item Icon Improvement Material.png{{!}}50px{{!}}link=]]
 |text = x7
 }}
 ;Main arguments
 :<code><nowiki>item</nowiki></code>
-::The background image. Default value is [[File:Empty equipment card slot.png|50px|link=]]
+::The background image. Default value is [[File:Empty Equipment Card.png|50px|link=]]
 :<code><nowiki>text</nowiki></code>
-::The overlay text. Default value is なのです！
+::The overlay text (images and audio also work). Defaults to <code>default-text</code> or empty string.
+:<code><nowiki>link</nowiki></code>
+::Embedded link using clickbox overlay.
 :<code><nowiki>[1]</nowiki></code>
-::The non-text overlay (e.g. image or nested <code><nowiki>ItemStack</nowiki></code> call).
+::Used for nested <code><nowiki>ItemStack</nowiki></code> calls, the generated element will be [[Wikipedia:HTML_element#Block_elements|block-level]].
 ;Styling arguments
 :<code><nowiki>font-size</nowiki></code>
@@ Line 26: / Line 28: @@
 ::Set the position of the overlay text. Default value is right:4px;bottom:-18px
 :<code><nowiki>position</nowiki></code>
-::Set the position of the non-text overlay.
+::Set the position of the overlay generated by nested <code><nowiki>ItemStack</nowiki></code> call.
 :<code><nowiki>text-color</nowiki></code>
 ::Set the color of the text. Default value is f61
@@ Line 33: / Line 35: @@
 :<code><nowiki>glow-color</nowiki></code>
 ::Set the color of the glow. Default value is fff
+:<code><nowiki>clickbox-opacity</nowiki></code>
+::Set the opacity of clickbox from 0 to 1 (used for aligning clickbox). Default value is 0.
+:<code><nowiki>clickbox-size</nowiki></code>
+::Set the size of the clickbox
+:<code><nowiki>clickbox-pos</nowiki></code>
+::Set the position of the clickbox
-;Custom usage with [[Template:EquipmentCardKai]]
+;Custom usage with [[Template:Equipment/Card]]
 <pre>
 {{ItemStack
-|item = {{EquipmentCardKai|Prototype 51cm Twin Gun Mount|size=100px}}
+|item = {{Equipment/Card|Prototype 51cm Twin Gun Mount|size=100px}}
 |text-position = bottom:-40px;right:6px;
 |font-size = 18px
@@ Line 47: / Line 55: @@
 </pre>
 {{ItemStack
-|item = {{EquipmentCardKai|Prototype 51cm Twin Gun Mount|size=100px}}
+|item = {{Equipment/Card|Prototype 51cm Twin Gun Mount|size=100px}}
 |text-position = bottom:-40px;right:6px;
 |font-size = 18px
@@ Line 58: / Line 66: @@
 <pre>
 {{ItemStack
-|item = {{ShipCardKai|Ikazuchi/Kai}}
+|item = {{Ship/Card|Ikazuchi/Kai|size=218px}}
 |position = left:130px;
 |{{ItemStack
-  |item = {{ShipCardKai|Hibiki/Kai}}
+|item = {{Ship/Card|Hibiki/Kai|size=218px}}
-  |position = left:130px;
+|position = left:130px;
-  |{{ItemStack
+|{{ItemStack
-    |item = {{ShipCardKai|Akatsuki/Kai}}
+|item = {{Ship/Card|Akatsuki/Kai|size=218px}}
-    |position = left:130px;
+|position = left:130px;
-    |{{ItemStack
+|{{ItemStack
-      |item = {{ShipCardKai|Inazuma/Kai}}
+|item = {{Ship/Card|Inazuma/Kai|size=218px}}
-      |text = DesDiv6
+|text = DesDiv6
-      |text-position = bottom:-130px;right:5px
+|text-position = bottom:-130px;right:5px
-      |font-size = 20px
+|font-size = 20px
-      }}
+}}}}}}}}
-    }}
-  }}
-}}
 </pre>
 {{ItemStack
-|item = {{ShipCardKai|Ikazuchi/Kai}}
+|item = {{Ship/Card|Ikazuchi/Kai|size=218px}}
+|position = left:130px;
+|{{ItemStack
+|item = {{Ship/Card|Hibiki/Kai|size=218px}}
+|position = left:130px;
+|{{ItemStack
+|item = {{Ship/Card|Akatsuki/Kai|size=218px}}
 |position = left:130px;
 |{{ItemStack
-  |item = {{ShipCardKai|Hibiki/Kai}}
+|item = {{Ship/Card|Inazuma/Kai|size=218px}}
-  |position = left:130px;
+|text = DesDiv6
-  |{{ItemStack
+|text-position = bottom:-130px;right:5px
-    |item = {{ShipCardKai|Akatsuki/Kai}}
+|font-size = 20px
-    |position = left:130px;
+}}}}}}}}
-    |{{ItemStack
+;Image overlay
-      |item = {{ShipCardKai|Inazuma/Kai}}
+<pre>
-      |text = DesDiv6
+{{ItemStack
-      |text-position = bottom:-130px;right:5px
+|item = {{Ship/Card|Ikazuchi/Kai|size=218px}}
-      |font-size = 20px
+|text-position = bottom:-135px;right:5px
-      }}
+|text = [[File:Marriage Ring Icon.png]]
-    }}
+}}
-  }}
+</pre>
+{{ItemStack
+|item = {{Ship/Card|Ikazuchi/Kai|size=218px}}
+|text-position = bottom:-135px;right:5px
+|text = [[File:Marriage Ring Icon.png]]
 }}