Difference between revisions of "Template:I-slot"
Jump to navigation
Jump to search
If you find a typo, inconsistency, or error, please sign up and help out the wiki! We can't do it without your help! :D Thank you!
(Added ammount support) |
|||
| Line 1: | Line 1: | ||
| − | <span class="invslot-item" {{#if: {{{minetip-title|}}}|data-minetip-title="{{{minetip-title|{{{name}}}}}}"}} {{#if: {{{minetip-text|}}}|data-minetip-text="{{{minetip-text|}}}"}}>[[File:{{{name|Invisible-sprite}}}.png|{{{size|16}}}x{{{size|16}}}px|class=item-icon pixel {{{class|}}}|link={{{item-link|{{{name}}}}}}|{{{tooltip|{{{name}}}}}}]]</span><noinclude> | + | <span class="invslot-item" {{#if: {{{minetip-title|}}}|data-minetip-title="{{{minetip-title|{{{name}}}}}}"}} {{#if: {{{minetip-text|}}}|data-minetip-text="{{{minetip-text|}}}"}}>[[File:{{{name|Invisible-sprite}}}.png|{{{size|16}}}x{{{size|16}}}px|class=item-icon pixel {{{class|}}}|link={{{item-link|{{{name}}}}}}|{{{tooltip|{{{name}}}}}}]]{{#if: {{{ammount|}}}|<span class="item-ammount">{{{ammount|}}}</span>}}</span><noinclude> |
== About == | == About == | ||
This templated (named '''I-slot''' as a shortcut for '''item-slot''') serves as an easy method to add icon sprites that are inside of a in-game slot, with tooltip included with the item's name and/or with extra info. | This templated (named '''I-slot''' as a shortcut for '''item-slot''') serves as an easy method to add icon sprites that are inside of a in-game slot, with tooltip included with the item's name and/or with extra info. | ||
| Line 8: | Line 8: | ||
{{I-slot | {{I-slot | ||
| name = <file-name> | | name = <file-name> | ||
| + | | ammount = <number> | ||
| link = <item-link> | | link = <item-link> | ||
| size = <file-size> (width and height at the same time) | | size = <file-size> (width and height at the same time) | ||
| Line 20: | Line 21: | ||
<pre><nowiki> | <pre><nowiki> | ||
| − | {{I-slot|name= <file-name>|link= <item-link>|size= <file-size> (width and height at the same time)|class= <file-class>|tooltip= <default-tooltip-text>|minetip-title= <mb-minetip-title>|minetip-text= <mb-minetip-text>}} | + | {{I-slot|name= <file-name>|ammount= <number>|link= <item-link>|size= <file-size> (width and height at the same time)|class= <file-class>|tooltip= <default-tooltip-text>|minetip-title= <mb-minetip-title>|minetip-text= <mb-minetip-text>}} |
</nowiki></pre> | </nowiki></pre> | ||
| Line 37: | Line 38: | ||
| <code>Invisible-sprite</code> | | <code>Invisible-sprite</code> | ||
| Recommended | | Recommended | ||
| + | |- | ||
| + | | <code>ammount</code> | ||
| + | | Number of the same item. | ||
| + | | Integer | ||
| + | | None | ||
| + | | Optional | ||
|- | |- | ||
! <code>link</code> | ! <code>link</code> | ||
| Line 92: | Line 99: | ||
| name = Wooden Planks}} | | name = Wooden Planks}} | ||
|- | |- | ||
| − | | Name and link | + | | Name and ammount |
| + | | | ||
| + | <pre><nowiki> | ||
| + | {{I-slot | ||
| + | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| + | }} | ||
| + | </nowiki></pre> | ||
| + | | | ||
| + | {{I-slot | ||
| + | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| + | }} | ||
| + | |- | ||
| + | | Name, ammount and link | ||
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
}} | }} | ||
| Line 103: | Line 125: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
}} | }} | ||
|- | |- | ||
| − | | Name, link, and size | + | | Name, ammount, link, and size |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 118: | Line 142: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
}} | }} | ||
|- | |- | ||
| − | | Name, link, size, and icon class | + | | Name, ammount, link, size, and icon class |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 135: | Line 161: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 140: | Line 167: | ||
}} | }} | ||
|- | |- | ||
| − | | Name, link, size, icon class, and default tooltip text | + | | Name, ammount, link, size, icon class, and default tooltip text |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 153: | Line 181: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 159: | Line 188: | ||
}} | }} | ||
|- | |- | ||
| − | | Name, link, size, icon class, default tooltip text, and empty mb tooltip title | + | | Name, ammount, link, size, icon class, default tooltip text, and empty mb tooltip title |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 173: | Line 203: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 180: | Line 211: | ||
}} | }} | ||
|- | |- | ||
| − | | Name, link, size, icon class, default tooltip text, and mb tooltip title with custom text | + | | Name, ammount, link, size, icon class, default tooltip text, and mb tooltip title with custom text |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 195: | Line 227: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 202: | Line 235: | ||
}} | }} | ||
|- | |- | ||
| − | | Name, link, size, icon class, default tooltip text, and empty mb tooltip text | + | | Name, ammount, link, size, icon class, default tooltip text, and empty mb tooltip text |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 217: | Line 251: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 224: | Line 259: | ||
}} | }} | ||
|- | |- | ||
| − | | Name, link, size, icon class, default tooltip text, and mb tooltip with custom text | + | | Name, ammount, link, size, icon class, default tooltip text, and mb tooltip with custom text |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 238: | Line 274: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 245: | Line 282: | ||
}} | }} | ||
|- | |- | ||
| − | | Name, link, size, icon class, default tooltip text, mb tooltip title with custom text, and mb tooltip with custom text | + | | Name, ammount, link, size, icon class, default tooltip text, mb tooltip title with custom text, and mb tooltip with custom text |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
| Line 260: | Line 298: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
| + | | ammount = 64 | ||
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Revision as of 14:03, 18 December 2021
Contents
About
This templated (named I-slot as a shortcut for item-slot) serves as an easy method to add icon sprites that are inside of a in-game slot, with tooltip included with the item's name and/or with extra info.
Usage
The syntax of the template is:
{{I-slot
| name = <file-name>
| ammount = <number>
| link = <item-link>
| size = <file-size> (width and height at the same time)
| class = <file-class>
| tooltip = <default-tooltip-text>
| minetip-title = <mb-minetip-title>
| minetip-text = <mb-minetip-text>
}}
The single line version is:
{{I-slot|name= <file-name>|ammount= <number>|link= <item-link>|size= <file-size> (width and height at the same time)|class= <file-class>|tooltip= <default-tooltip-text>|minetip-title= <mb-minetip-title>|minetip-text= <mb-minetip-text>}}
Note that minetip-title and minetip-text are mandatory for the tooltip to work. In case you don't need minetip-text, you can mention the parameter and leave it empty. minetip-title defaults to the first parameter (file-name)'s text if it's not used.
| Parameter | Function | Value type | Default value | Status |
|---|---|---|---|---|
name
|
It's the item's name. It's mainly used for the image name. No format is needed to specify. | String | Invisible-sprite
|
Recommended |
ammount
|
Number of the same item. | Integer | None | Optional |
link
|
Icon's link. | Wikitext | name's value
|
Optional |
size
|
Icon's size (both width and height share the same value to keep the image fully squared). | Integer | 16
|
Optional |
class
|
Icon's extra classes. | String | None | Optional |
tooltip
|
Icon's default tooltip text. It's automatically removed if the Mine Blocks-themed tooltip isbeing used (see below). | String | name's value
|
Optional |
minetip-title
|
Icon's Mine Block tooltip title. | String | name's value
|
Optional |
minetip-text
|
Icon's Mine Block tooltip text. Use the forward slash (/) as line breaks.
|
String | None | Optional |
Examples
| Values used | Code | Result |
|---|---|---|
| Name |
{{I-slot
| name = Wooden Planks
}}
|
|
| Name and ammount |
{{I-slot
| name = Wooden Planks
| ammount = 64
}}
|
|
| Name, ammount and link |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
}}
|
|
| Name, ammount, link, and size |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
| size = 24
}}
|
|
| Name, ammount, link, size, and icon class |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
| size = 24
| class = thumb-class
}}
|
|
| Name, ammount, link, size, icon class, and default tooltip text |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
| size = 24
| class = thumb-class
| tooltip = Default tooltip text.
}}
|
|
| Name, ammount, link, size, icon class, default tooltip text, and empty mb tooltip title |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
| size = 24
| class = thumb-class
| tooltip = Default tooltip text.
| minetip-title =
}}
|
|
| Name, ammount, link, size, icon class, default tooltip text, and mb tooltip title with custom text |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
| size = 24
| class = thumb-class
| tooltip = Default tooltip text.
| minetip-title = Lorem Ipsum
}}
|
|
| Name, ammount, link, size, icon class, default tooltip text, and empty mb tooltip text |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
| size = 24
| class = thumb-class
| tooltip = Default tooltip text.
| minetip-text =
}}
|
|
| Name, ammount, link, size, icon class, default tooltip text, and mb tooltip with custom text |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
| size = 24
| class = thumb-class
| tooltip = Default tooltip text.
| minetip-text = Dolor sit amet.
}}
|
|
| Name, ammount, link, size, icon class, default tooltip text, mb tooltip title with custom text, and mb tooltip with custom text |
{{I-slot
| name = Wooden Planks
| ammount = 64
| link = Cow
| size = 24
| class = thumb-class
| tooltip = Default tooltip text.
| minetip-title = Lorem Ipsum
| minetip-text = Dolor sit amet.
}}
|
|
Notes
- If a custom value for the icons' size is going to be used, it should be any of these:
16,18,20,22, or24.- Using any other value will make the icon to not be centered.
- Using a value higher than the ones mentioned above will make the icon overflow from its container box.
- Despite the default tooltip being removed if the custom mb tooltip is being used, it's recommended to not remove it (using the parameter but leaving its value empty) since it will display as a fallback in case the user has disabled their JavaScript.
