Template:Advancement: Difference between revisions
m (No need to have examples on this page) |
(Added TemplateData) |
||
Line 3: | Line 3: | ||
{{#ifeq:{{{hover}}}|true|<div class="hover-advancement-text">|}}<div class="{{#ifeq:{{{hover}}}|true|hover-title|advancement-title}}">{{{2|{{{title|Gamemode 4}}}}}}</div><div class="{{#ifeq:{{{hover}}}|true|hover-description|advancement-description}}">{{#if:{{{desc-color|}}}|<span style="color:#{{{desc-color}}};">}}{{{3|{{{desc|Semi-funny blurb about GM4}}}}}}{{#if:{{{desc-color|}}}|</span>}}</div>{{#ifeq:{{{hover}}}|true|</div>|}}</div></includeonly><noinclude> | {{#ifeq:{{{hover}}}|true|<div class="hover-advancement-text">|}}<div class="{{#ifeq:{{{hover}}}|true|hover-title|advancement-title}}">{{{2|{{{title|Gamemode 4}}}}}}</div><div class="{{#ifeq:{{{hover}}}|true|hover-description|advancement-description}}">{{#if:{{{desc-color|}}}|<span style="color:#{{{desc-color}}};">}}{{{3|{{{desc|Semi-funny blurb about GM4}}}}}}{{#if:{{{desc-color|}}}|</span>}}</div>{{#ifeq:{{{hover}}}|true|</div>|}}</div></includeonly><noinclude> | ||
{{Documentation}} | {{Documentation}} | ||
</noinclude> | <templatedata> | ||
{ | |||
"params": { | |||
"hover": { | |||
"label": "Hover", | |||
"description": "If true, this mimics the functionality from the Advancement tab", | |||
"example": "true", | |||
"type": "line", | |||
"autovalue": "" | |||
}, | |||
"item": { | |||
"aliases": [ | |||
"1" | |||
], | |||
"label": "Display Item", | |||
"description": "Advancement Icon", | |||
"example": "Grass Block", | |||
"type": "line", | |||
"required": true | |||
}, | |||
"bg": { | |||
"label": "Frame", | |||
"description": "The Advancement icon frame", | |||
"example": "fancy", | |||
"type": "line" | |||
}, | |||
"state": { | |||
"label": "State", | |||
"description": "Advancement completion state", | |||
"example": "worn", | |||
"type": "line" | |||
}, | |||
"enchanted": { | |||
"label": "Enchanted", | |||
"description": "If true, the Advancement icon will show as enchanted", | |||
"example": "true", | |||
"type": "line" | |||
}, | |||
"title": { | |||
"aliases": [ | |||
"2" | |||
], | |||
"label": "Title", | |||
"description": "The Advancement text", | |||
"example": "Gamemode 4", | |||
"type": "line", | |||
"required": true | |||
}, | |||
"desc-color": { | |||
"label": "Description Color", | |||
"description": "A hex code for the color of the Advancement description", | |||
"example": "A800A8", | |||
"type": "line" | |||
}, | |||
"desc": { | |||
"aliases": [ | |||
"3" | |||
], | |||
"label": "Description", | |||
"description": "The Advancement description text", | |||
"example": "Semi-funny blurb about GM4", | |||
"type": "line", | |||
"required": true | |||
} | |||
}, | |||
"description": "Create Advancements as seen within Minecraft.", | |||
"paramOrder": [ | |||
"item", | |||
"title", | |||
"bg", | |||
"state", | |||
"desc", | |||
"desc-color", | |||
"enchanted", | |||
"hover" | |||
] | |||
} | |||
</templatedata></noinclude> |
Revision as of 04:14, 7 June 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}}
.
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,
. 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 }}
The above documentation is transcluded from Template:Advancement/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |
Create Advancements as seen within Minecraft.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Display Item | item 1 | Advancement Icon
| Line | required |
Title | title 2 | The Advancement text
| Line | required |
Frame | bg | The Advancement icon frame
| Line | optional |
State | state | Advancement completion state
| Line | optional |
Description | desc 3 | The Advancement description text
| Line | required |
Description Color | desc-color | A hex code for the color of the Advancement description
| Line | optional |
Enchanted | enchanted | If true, the Advancement icon will show as enchanted
| Line | optional |
Hover | hover | If true, this mimics the functionality from the Advancement tab
| Line | optional |