View source for Template:AdvancementIcon/doc

Using this template, you can create the advancement icons as seen within the game.  

The images used are taken from <code><nowiki>{{</nowiki>[[Module:InvSprite|InvSprite]]<nowiki>}}</nowiki></code>.

{{AdvancementIcon}}

== Usage ==
=== Image ===

Using the first parameter, {{Code|{{{1}}}}}, you can set the image to the specified block or item or a fallback image.

For Gamemode 4 specific items or blocks, <code>gm4:</code> must prefix the name, e.g., <code>gm4:Boots of Ostara</code>

=== Background ===

''Optional.'' The second parameter, {{Code|{{{bg}}}}}, is used to set the background.

''Optional.'' The third parameter, {{Code|{{{state}}}}}, is used to display advancement completion state.

{| class = "wikitable"
! style = "text-align:center" | Background
! Parameters
|-
| style = "text-align:center" | {{AdvancementIcon|Air|bg=plain|state=raw}}
| {{Code|plain<nowiki>|</nowiki>raw}}
|-
| style = "text-align:center" | {{AdvancementIcon|Air|bg=oval|state=raw}}
| {{Code|oval<nowiki>|</nowiki>raw}}
|-
| style = "text-align:center" | {{AdvancementIcon|Air|bg=fancy|state=raw}}
| {{Code|fancy<nowiki>|</nowiki>raw}}
|-
| style = "text-align:center" | {{AdvancementIcon|Air|bg=plain|state=worn}}
| {{Code|plain<nowiki>|</nowiki>worn}}
|-
| style = "text-align:center" | {{AdvancementIcon|Air|bg=oval|state=worn}}
| {{Code|oval<nowiki>|</nowiki>worn}}
|-
| style = "text-align:center" | {{AdvancementIcon|Air|bg=fancy|state=worn}}
| {{Code|fancy<nowiki>|</nowiki>worn}}
|}

=== Link ===

<span style = "color:red">NOTE: Link is not implemented, as <code><nowiki>{{</nowiki>AdvancementIcon<nowiki>}}</nowiki></code> currently uses <code><nowiki>{{</nowiki>Stack<nowiki>}}</nowiki></code> and not <code><nowiki>{{</nowiki>InventoryIcon<nowiki>}}</nowiki></code>.</span>

''Optional.''  An advancement icon can contain a link using {{Code|{{{link}}}}}.

To link [[Boots of Ostara]], you would use <code><nowiki>{{</nowiki>AdvancementIcon|gm4:Boots of Ostara|link=Boots of Ostara<nowiki>}}</nowiki></code>.

== Example Usage ==

Advancement Icons can be placed inline by placing two <code><nowiki>{{</nowiki>AdvancementIcon<nowiki>}}</nowiki></code>s next to one another, without spaces or newlines.

New lines and spacing within <code><nowiki>{{</nowiki>AdvancementIcon<nowiki>}}</nowiki></code> is ignored, as long as the parameter is stated, e.g., <code>bg = plain</code>.

The second and third parameters can be written inline, as shown in the last example, but unless the template is written without spaces, the output will fail.

<pre>
{{AdvancementIcon
 | Furnace
 | bg = plain
 | state = raw}}{{AdvancementIcon|Furnace|bg = oval|state = worn}}

{{AdvancementIcon
 | gm4:SCUBA Helmet
 | bg = fancy
 | state = worn
 | link = SCUBA Gear
}}{{AdvancementIcon|Diamond Hoe|fancy|raw}}
</pre>

{{AdvancementIcon
 | Furnace
 | bg = plain
 | state = raw
}}{{AdvancementIcon|Furnace|bg = oval|state = worn}}

{{AdvancementIcon
 | gm4:SCUBA Helmet
 | bg = fancy
 | state = worn
 | link = SCUBA Gear
}}{{AdvancementIcon|Diamond Hoe|fancy|raw}}

== See Also ==
* <code><nowiki>{{</nowiki>[[Module:InvSprite|InvSprite]]<nowiki>}}</nowiki></code>


__NOTOC__