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 durability 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}}}}}}]]{{#if: {{{ | + | <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: {{{amount|}}}|<span class="item-amount">{{{amount|}}}</span>}}{{#if: {{{durability|}}}|<span class="item-durability" data-durability="{{{durability|}}}"></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> | ||
− | | | + | | amount = <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 21: | Line 21: | ||
<pre><nowiki> | <pre><nowiki> | ||
− | {{I-slot|name= <file-name>| | + | {{I-slot|name= <file-name>|amount= <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 39: | Line 39: | ||
| Recommended | | Recommended | ||
|- | |- | ||
− | ! <code> | + | ! <code>amount</code> |
| Number of the same item. | | Number of the same item. | ||
+ | | Integer | ||
+ | | None | ||
+ | | Optional | ||
+ | |- | ||
+ | ! <code>durability</code> | ||
+ | | Amount of durability of the item, expressed in percentages multiples of 10. | ||
| Integer | | Integer | ||
| None | | None | ||
Line 99: | Line 105: | ||
| name = Wooden Planks}} | | name = Wooden Planks}} | ||
|- | |- | ||
− | | Name and | + | | Name and amount |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
}} | }} | ||
</nowiki></pre> | </nowiki></pre> | ||
Line 110: | Line 116: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount and link |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
}} | }} | ||
Line 125: | Line 131: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount, link, and size |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 142: | Line 148: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount, link, size, and icon class |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 161: | Line 167: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 167: | Line 173: | ||
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount, link, size, icon class, and default tooltip text |
| | | | ||
<pre><nowiki> | <pre><nowiki> | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 181: | Line 187: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 188: | Line 194: | ||
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount, 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 | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 203: | Line 209: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 211: | Line 217: | ||
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount, 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 | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 227: | Line 233: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 235: | Line 241: | ||
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount, 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 | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 251: | Line 257: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 259: | Line 265: | ||
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount, 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 | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 274: | Line 280: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 282: | Line 288: | ||
}} | }} | ||
|- | |- | ||
− | | Name, | + | | Name, amount, 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 | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 298: | Line 304: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 308: | Line 314: | ||
{{I-slot | {{I-slot | ||
| name = Wooden Planks | | name = Wooden Planks | ||
− | | | + | | amount = 64 |
| link = Cow | | link = Cow | ||
| size = 24 | | size = 24 | ||
Line 323: | Line 329: | ||
** Using any other value will make the icon to not be centered. | ** 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. | ** Using a value higher than the ones mentioned above will make the icon overflow from its container box. | ||
+ | * The values supported by the <code>durability</code> parameter are: <code>10</code>, <code>20</code>, <code>30</code>, <code>40</code>, <code>50</code>, <code>60</code>, <code>70</code>, <code>80</code>, <code>90</code>, and <code>100</code>. | ||
+ | ** Any other value will make the durability bar empty. | ||
* 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. | * 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. | ||
</noinclude> | </noinclude> |
Revision as of 18:53, 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> | amount = <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>|amount= <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 |
amount
|
Number of the same item. | Integer | None | Optional |
durability
|
Amount of durability of the item, expressed in percentages multiples of 10. | 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 amount |
{{I-slot | name = Wooden Planks | amount = 64 }} |
|
Name, amount and link |
{{I-slot | name = Wooden Planks | amount = 64 | link = Cow }} |
|
Name, amount, link, and size |
{{I-slot | name = Wooden Planks | amount = 64 | link = Cow | size = 24 }} |
|
Name, amount, link, size, and icon class |
{{I-slot | name = Wooden Planks | amount = 64 | link = Cow | size = 24 | class = thumb-class }} |
|
Name, amount, link, size, icon class, and default tooltip text |
{{I-slot | name = Wooden Planks | amount = 64 | link = Cow | size = 24 | class = thumb-class | tooltip = Default tooltip text. }} |
|
Name, amount, link, size, icon class, default tooltip text, and empty mb tooltip title |
{{I-slot | name = Wooden Planks | amount = 64 | link = Cow | size = 24 | class = thumb-class | tooltip = Default tooltip text. | minetip-title = }} |
|
Name, amount, link, size, icon class, default tooltip text, and mb tooltip title with custom text |
{{I-slot | name = Wooden Planks | amount = 64 | link = Cow | size = 24 | class = thumb-class | tooltip = Default tooltip text. | minetip-title = Lorem Ipsum }} |
|
Name, amount, link, size, icon class, default tooltip text, and empty mb tooltip text |
{{I-slot | name = Wooden Planks | amount = 64 | link = Cow | size = 24 | class = thumb-class | tooltip = Default tooltip text. | minetip-text = }} |
|
Name, amount, link, size, icon class, default tooltip text, and mb tooltip with custom text |
{{I-slot | name = Wooden Planks | amount = 64 | link = Cow | size = 24 | class = thumb-class | tooltip = Default tooltip text. | minetip-text = Dolor sit amet. }} |
|
Name, amount, link, size, icon class, default tooltip text, mb tooltip title with custom text, and mb tooltip with custom text |
{{I-slot | name = Wooden Planks | amount = 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.
- The values supported by the
durability
parameter are:10
,20
,30
,40
,50
,60
,70
,80
,90
, and100
.- Any other value will make the durability bar empty.
- 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.