Template:Item icon/doc: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(created)
 
(Included related templates)
Line 1: Line 1:
<includeonly>This text is transcluded from [[Template:ItemIcon/doc]]</includeonly>
<includeonly>''This text is transcluded from [[Template:ItemIcon/doc]]''</includeonly>


This template fetches and displays an icon for an item. The information is uploaded using the standard item descriptions. Use [[Template:ItemIcon Insert]] to add a page that doesn't use [[Template:MiscItemPage]], [[Template:EquipmentPage]], or [[Template:WeaponPage]].
This template fetches and displays an icon for an item. The information is uploaded using the standard item descriptions. Use [[Template:ItemIcon Insert]] to add a page that doesn't use [[Template:MiscItemPage]], [[Template:EquipmentPage]], or [[Template:WeaponPage]].
Line 16: Line 16:
Copy-ready template (with item name): <code><nowiki>{{ItemIcon|name=|show_name=true}}</nowiki></code>
Copy-ready template (with item name): <code><nowiki>{{ItemIcon|name=|show_name=true}}</nowiki></code>


=== Examples ===
== Examples ==
<table class="wikitable">
<table class="wikitable">
<tr><th>Result</th><th>Name</th><th>Size</th><th>Show name?</th><th>Rarity?</th><th>Code</th></tr>
<tr><th>Result</th><th>Name</th><th>Size</th><th>Show name?</th><th>Rarity?</th><th>Code</th></tr>
Line 43: Line 43:
{{ItemIcon/Example|The Red Knight's Final Stratagem|25|true|true}}
{{ItemIcon/Example|The Red Knight's Final Stratagem|25|true|true}}
</table>
</table>
== Related templates ==
{{ItemIcon/Family}}

Revision as of 09:44, 9 September 2023


This template fetches and displays an icon for an item. The information is uploaded using the standard item descriptions. Use Template:ItemIcon Insert to add a page that doesn't use Template:MiscItemPage, Template:EquipmentPage, or Template:WeaponPage.

Usage:
{{ItemIcon
|name=the name of the icon page
|size=(optional) the size of the icon
|show_name=(optional) Whether to show the name. Any value will show the name of the item as a link. Omit to hide it.
|show_rarity=(optional) Whether to add a border and background to the icon according to the item's rarity. Omit to not show it.
}}

Templates

Copy-ready template (no item name): {{ItemIcon|name=}}

Copy-ready template (with item name): {{ItemIcon|name=|show_name=true}}

Examples

ResultNameSizeShow name?Rarity?Code
Icon only

Potion of Healing

40 false false {{ItemIcon|name=Potion of Healing|size=40|show_name=false|show_rarity=false}}

Potion of Healing

25 false false {{ItemIcon|name=Potion of Healing|size=25|show_name=false|show_rarity=false}}

Potion of Supreme Healing

40 false false {{ItemIcon|name=Potion of Supreme Healing|size=40|show_name=false|show_rarity=false}}

Potion of Supreme Healing

25 false false {{ItemIcon|name=Potion of Supreme Healing|size=25|show_name=false|show_rarity=false}}

File:The Red Knight's Final Stratagem Unfaded Icon.pngThe Red Knight's Final Stratagem

40 false false {{ItemIcon|name=The Red Knight's Final Stratagem|size=40|show_name=false|show_rarity=false}}

File:The Red Knight's Final Stratagem Unfaded Icon.pngThe Red Knight's Final Stratagem

25 false false {{ItemIcon|name=The Red Knight's Final Stratagem|size=25|show_name=false|show_rarity=false}}
Linked icon

Potion of Healing

40 true false {{ItemIcon|name=Potion of Healing|size=40|show_name=true|show_rarity=false}}

Potion of Healing

25 true false {{ItemIcon|name=Potion of Healing|size=25|show_name=true|show_rarity=false}}

Potion of Supreme Healing

40 true false {{ItemIcon|name=Potion of Supreme Healing|size=40|show_name=true|show_rarity=false}}

Potion of Supreme Healing

25 true false {{ItemIcon|name=Potion of Supreme Healing|size=25|show_name=true|show_rarity=false}}

File:The Red Knight's Final Stratagem Unfaded Icon.pngThe Red Knight's Final Stratagem

40 true false {{ItemIcon|name=The Red Knight's Final Stratagem|size=40|show_name=true|show_rarity=false}}

File:The Red Knight's Final Stratagem Unfaded Icon.pngThe Red Knight's Final Stratagem

25 true false {{ItemIcon|name=The Red Knight's Final Stratagem|size=25|show_name=true|show_rarity=false}}
Rarity icon

Potion of Healing

40 true true {{ItemIcon|name=Potion of Healing|size=40|show_name=true|show_rarity=true}}

Potion of Healing

25 true true {{ItemIcon|name=Potion of Healing|size=25|show_name=true|show_rarity=true}}

Potion of Supreme Healing

40 true true {{ItemIcon|name=Potion of Supreme Healing|size=40|show_name=true|show_rarity=true}}

Potion of Supreme Healing

25 true true {{ItemIcon|name=Potion of Supreme Healing|size=25|show_name=true|show_rarity=true}}

File:The Red Knight's Final Stratagem Unfaded Icon.pngThe Red Knight's Final Stratagem

40 true true {{ItemIcon|name=The Red Knight's Final Stratagem|size=40|show_name=true|show_rarity=true}}

File:The Red Knight's Final Stratagem Unfaded Icon.pngThe Red Knight's Final Stratagem

25 true true {{ItemIcon|name=The Red Knight's Final Stratagem|size=25|show_name=true|show_rarity=true}}

Related templates

Transcluded from Template:ItemIcon/Family.

Template:ItemIcon

The base ItemIcon with all functionality.


Template:SmItemIcon

A version of ItemIcon that always has a image height of 25px and links the item.

Potion of Superior Healing

Template:MdItemIcon

A version of ItemIcon that always has a image height of 30px and links the item.

Potion of Superior Healing

Template:LgItemIcon

A version of ItemIcon that always has an image height of 40px and links the item.

Potion of Supreme Healing


Template:RarityItem

A version of ItemIcon that displays the rarity colors and links the item. Defaults to 25px but can be adjusted.

The Joltshooter


Template:SmRarityItem

A version of RarityItem that defaults to 20px instead of 25. For use in running texts.

The Joltshooter

Template:MdRarityItem

A version of RarityItem that defaults to 30px instead of 25. For use on Template:ActionPage, which specifically needs to be passed a template name.

The Joltshooter

Template:LgRarityItem

A version of RarityItem that defaults to 40px instead of 25. For use on various list pages.

The Joltshooter


Template:ItemIcon Insert

A utility template that inserts information into the "item_icon" table, which is where all information used to provide ItemIcon functionality is stored. This template should only need to be manually called for pages that are not items, but might want to have an icon associated with them, for example Food Supply Table 4.