Template:Chest: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
(Updated documentation)
 
(One intermediate revision by one other user not shown)
Line 5: Line 5:
{{{contents|Empty}}}</div>
{{{contents|Empty}}}</div>
</div></includeonly><noinclude>
</div></includeonly><noinclude>
Everything is optional. You don't have to set a DC. You don't even have to set an image or a link!
{{see also|Template:Trader}}
Display the contents of a chest, inventory, trader, etc. in a collapsible box.


Usage:
All the parameters are optional. You don't have to set a DC. You don't even have to set an image or a link!


<nowiki>{{Chest</nowiki>
== Examples ==
<nowiki>|icon=Gilded Chest A Icon.png</nowiki>
{{Template demo
<nowiki>|link=Gilded Chest</nowiki>
| style = list
<nowiki>|DC=25</nowiki>
| <nowiki>
<nowiki>|contents=</nowiki>
{{Chest
<nowiki>* {{RarityItem|Acquisitions Record}}</nowiki>
| icon = Jeweled Chest A Faded.webp
<nowiki>* {{RarityItem|Torch of Revocation}}</nowiki>
| link = Gilded Chest
<nowiki>* {{RarityItem|Gold}} 54pcs</nowiki>
| DC = 25
<nowiki>* {{RarityItem|Topaz}}</nowiki>
| contents =
<nowiki>* {{RarityItem|Arrow of Ilmater}}</nowiki>
* {{RarityItem|Acquisitions Record}}
<nowiki>* {{RarityItem|Arrow of Dragon Slaying}}</nowiki>
<nowiki>}}</nowiki>
 
Result: {{Chest|icon=Gilded Chest A Icon.png|link=Gilded Chest|DC=25
|contents=* {{RarityItem|Acquisitions Record}}
* {{RarityItem|Torch of Revocation}}
* {{RarityItem|Torch of Revocation}}
* {{RarityItem|Gold}} 54pcs
* {{RarityItem|Gold}} 54pcs
* {{RarityItem|Topaz}}
* {{RarityItem|Topaz}}
* {{RarityItem|Arrow of Ilmater}}
* {{RarityItem|Arrow of Ilmater}}
* {{RarityItem|Arrow of Dragon Slaying}}}}
* {{RarityItem|Arrow of Dragon Slaying}}
 
}}
Or even:
</nowiki>
 
| <nowiki>
 
{{Chest
Usage:
| link = Gilded Chest
 
| nograd = 1
<nowiki>{{Chest</nowiki>
| contents =
<nowiki>|link=Gilded Chest</nowiki>
* {{SmIconLink|Book Note M Image.png|Acquisitions Record}}
<nowiki>|contents=</nowiki>
<nowiki>* {{RarityItem|Acquisitions Record}}</nowiki>
<nowiki>* {{RarityItem|Torch of Revocation}}</nowiki>
<nowiki>* {{RarityItem|Gold}} 54pcs</nowiki>
<nowiki>* {{RarityItem|Topaz}}</nowiki>
<nowiki>* {{RarityItem|Arrow of Ilmater}}</nowiki>
<nowiki>* {{RarityItem|Arrow of Dragon Slaying}}</nowiki>
<nowiki>}}</nowiki>
 
Result: {{Chest|link=Gilded Chest|contents=* {{SmIconLink|Book Note M Image.png|Acquisitions Record}}
* {{RarityItem|Torch of Revocation}}
* {{RarityItem|Torch of Revocation}}
* {{RarityItem|Gold}} 54pcs
* {{RarityItem|Gold}} 54pcs
* {{RarityItem|Topaz}}
* {{RarityItem|Topaz}}
* {{RarityItem|Arrow of Ilmater}}
* {{RarityItem|Arrow of Ilmater}}
* {{RarityItem|Arrow of Dragon Slaying}}}}
* {{RarityItem|Arrow of Dragon Slaying}}
 
}}
There is also a [[Template:Trader]]. Usage:
</nowiki>
<nowiki>{{Trader</nowiki>
| <nowiki>
<nowiki>|title_override=This shop shop</nowiki>
{{Trader
<nowiki>|contents=</nowiki>
| title_override = This shop
<nowiki>* {{GoldIcon|592}} 592 [[Gold]]</nowiki>
| contents =
<nowiki>}}</nowiki>
* {{GoldIcon|592}} 592 [[Gold]]
 
}}
{{Trader|title_override=This shop|contents=* {{GoldIcon|592}} 592 [[Gold]]}}
</nowiki>
 
}}
And as always, {{InfoBlob|nograd}}=1 will remove the gradient.
== Template data ==
 
<templatedata>
{
"params": {
"link": {
"label": "Link",
"description": "A link to the chest item.",
            "type": "wiki-page-name",
"required": false
},
        "DC": {
"label": "DC",
"description": "The difficulty class to pick the chest's lock, if applicable.",
            "type": "string",
"required": false
},
"title_override": {
"label": "Title override",
"description": "Ignore all the previous parameters used for title creation and use this instead.",
            "type": "string",
"required": false
},
        "icon": {
"label": "Icon",
"description": "An icon to display for the collapsible box.",
            "type": "wiki-file-name",
            "default": "Concentration Icon.png",
"required": false
},
        "nograd": {
"label": "No gradient",
"description": "Don't display the color gradient for the collapsible box.",
            "type": "boolean",
"required": false
}
    },
    "description": "Display the contents of a chest in a collapsible box.",
    "format": "block"
}
</templatedata>
[[Category:Templates]]
[[Category:Templates]]
</noinclude>
</noinclude>

Latest revision as of 06:11, 20 July 2024

See also: Template:Trader

Display the contents of a chest, inventory, trader, etc. in a collapsible box.

All the parameters are optional. You don't have to set a DC. You don't even have to set an image or a link!

Examples

Markup
{{Chest
| icon = Jeweled Chest A Faded.webp
| link = Gilded Chest
| DC = 25
| contents =
* {{RarityItem|Acquisitions Record}}
* {{RarityItem|Torch of Revocation}}
* {{RarityItem|Gold}} 54pcs
* {{RarityItem|Topaz}}
* {{RarityItem|Arrow of Ilmater}}
* {{RarityItem|Arrow of Dragon Slaying}}
}}
Renders as

Jeweled Chest A Faded.webp Gilded Chest with the DC 25 to lockpick contains the following items:

Markup
{{Chest
| link = Gilded Chest
| nograd = 1
| contents =
* {{SmIconLink|Book Note M Image.png|Acquisitions Record}}
* {{RarityItem|Torch of Revocation}}
* {{RarityItem|Gold}} 54pcs
* {{RarityItem|Topaz}}
* {{RarityItem|Arrow of Ilmater}}
* {{RarityItem|Arrow of Dragon Slaying}}
}}
Renders as

Concentration Icons.png Gilded Chest contains the following items:

Markup
{{Trader
| title_override = This shop
| contents =
* {{GoldIcon|592}} 592 [[Gold]]
}}
Renders as

Trade Icon.png This shop contains the following items:

Template data

Display the contents of a chest in a collapsible box.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Linklink

A link to the chest item.

Page nameoptional
DCDC

The difficulty class to pick the chest's lock, if applicable.

Stringoptional
Title overridetitle_override

Ignore all the previous parameters used for title creation and use this instead.

Stringoptional
Iconicon

An icon to display for the collapsible box.

Default
Concentration Icon.png
Fileoptional
No gradientnograd

Don't display the color gradient for the collapsible box.

Booleanoptional
Retrieved from "https://bg3.wiki/w/index.php?title=Template:Chest&oldid=209307"