Template:Advancement/doc: Difference between revisions

From Official Gamemode 4 Wiki
Jump to navigation Jump to search
(Created documentation)
m (-ing)
 
(3 intermediate revisions by the same user not shown)
Line 12: Line 12:


The second and third parameters, <code>{{{title}}}</code> and <code>{{{desc}}}</code>, are used in the advancement title and its description.
The second and third parameters, <code>{{{title}}}</code> and <code>{{{desc}}}</code>, are used in the advancement title and its description.
''Optional.'' <code>{{{desc-color}}}</code>, is used to give the description a different color.  Hex codes are inputted without the hashtag.  Example: <code><nowiki>{{Advancement|desc-color=A800A8}}</nowiki></code>
''Optional.'' <code>{{{hover}}}</code>, is used to display only the advancement icon until hovered over.  This is used to mimic the in-game advancement tab.  '''When using hover advancements, spacing needs to be replicated using non-breaking spaces, <code>&amp;nbsp;</code>.'''  ''Note, this overlays the title and description over anything surrounding it, as it does in-game.''


=== Icon ===
=== Icon ===
Line 19: Line 23:


The optional parameters of [[Template:AdvancementIcon]] can be given in the Advancement call, however they must be given by name.
The optional parameters of [[Template:AdvancementIcon]] can be given in the Advancement call, however they must be given by name.
''Optional.'' <code>{{{enchanted}}}</code>, is used to give the advancement icon an enchanted glint.


== Example Usage ==
== Example Usage ==
Line 28: Line 34:
  | title = Magical Thief
  | title = Magical Thief
  | desc = Successfully extract the mending enchantment from a tool with an Enchantment Extractor
  | desc = Successfully extract the mending enchantment from a tool with an Enchantment Extractor
| enchanted = true
}}
}}
{{Advancement
{{Advancement
Line 35: Line 42:
  | title = Return to Sender
  | title = Return to Sender
  | desc = Destroy a Ghast with a fireball
  | desc = Destroy a Ghast with a fireball
| desc-color = A800A8
}}
{{Advancement
| item = Emerald
| title = What a Deal!
| desc = Successfully&nbsp;trade with a Villager
| hover = true
}}
}}
</pre>
</pre>
Line 45: Line 59:
  | title = Magical Thief
  | title = Magical Thief
  | desc = Successfully extract the mending enchantment from a tool with an Enchantment Extractor
  | desc = Successfully extract the mending enchantment from a tool with an Enchantment Extractor
| enchanted = true
}}
}}


Line 53: Line 68:
  | state = worn
  | state = worn
  | title = Return to Sender
  | title = Return to Sender
  | desc = <span style="color:#A800A8;">Destroy a Ghast with a fireball</span>
  | desc = Destroy a Ghast with a fireball
| desc-color = A800A8
}}
 
 
{{Advancement
| item = Emerald
| title = What a Deal!
| desc = Successfully&nbsp;trade with a Villager
| hover = true
}}
}}
__NOTOC__
__NOTOC__

Latest revision as of 00:24, 19 April 2021

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

The badge is created using the [[Template:AdvancementIcon]] template, with images taken from {{Module:InvSprite}}.

Gamemode 4
Semi-funny blurb about GM4

Usage

Using the first parameter, {{{item}}}, you can set the image to the specified block or item or a fallback image. For Gamemode 4 specific items or blocks, gm4: must prefix the name, e.g., gm4:Boots of Ostara.

The second and third parameters, {{{title}}} and {{{desc}}}, are used in the advancement title and its description.

Optional. {{{desc-color}}}, is used to give the description a different color. Hex codes are inputted without the hashtag. Example: {{Advancement|desc-color=A800A8}}

Optional. {{{hover}}}, is used to display only the advancement icon until hovered over. This is used to mimic the in-game advancement tab. When using hover advancements, spacing needs to be replicated using non-breaking spaces, &nbsp;. Note, this overlays the title and description over anything surrounding it, as it does in-game.

Icon

The badge and item are created with the first parameter, {{{item}}}, and uses the plain and uncompleted advancement badge.

The optional parameters of Template:AdvancementIcon can be given in the Advancement call, however they must be given by name.

Optional. {{{enchanted}}}, is used to give the advancement icon an enchanted glint.

Example Usage

{{Advancement|gm4:Boots of Ostara|Green Feet|Wear the Boots of Ostara}}
{{Advancement
 | item = Enchantment Table
 | title = Magical Thief
 | desc = Successfully extract the mending enchantment from a tool with an Enchantment Extractor
 | enchanted = true
}}
{{Advancement
 | item = Fire Charge
 | bg = fancy
 | state = worn
 | title = Return to Sender
 | desc = Destroy a Ghast with a fireball
 | desc-color = A800A8
}}
{{Advancement
 | item = Emerald
 | title = What a Deal!
 | desc = Successfully trade with a Villager
 | hover = true
}}
Green Feet
Wear the Boots of Ostara


Magical Thief
Successfully extract the mending enchantment from a tool with an Enchantment Extractor


Return to Sender
Destroy a Ghast with a fireball


What a Deal!
Successfully trade with a Villager