View source for Module:Icon/doc

{{documentation subpage}}

This module contains several functions for rendering icons from the game, for use with both wikitext templates as well as from other Lua modules.
{{TOC limit|3}}
== Wikitext functions ==
These functions are designed to be used directly in templates via <code>{<nowiki/>{#invoke:}}</code>.

=== <code>renderGameIcon</code> ===
Renders the in-game icon of something.
==== Parameters ====
; type
: The type of thing being shown - quest, item, currency, action, achievement, etc. Usually pulled from [[Property:Has context]]. Used to determine whether the icon should have a frame, and if so, what kind.
; frameType
: Can be specified instead of ''type'' if you need to render an icon with a specific frame type without doing a type lookup. Usually pulled from [[Property:Has game icon frame type]]. Can be one of '''standard''', '''hq''', '''trait''', '''achievement''', or '''none''' (for non-frame icons).
; icon
: Icon file reference, including <code>File:</code> namespace and file extension. Usually pulled from [[Property:Has game icon]].
; link
: Where the icon should link when clicked, usually the article name of the relevant concept.
; size
: Icon size. One of '''small''' (20px), '''mid''' (30px), or '''big''' (40px). Defaults to big.

For item icons specifically, these parameters can also be used:
; hq
: If set, renders a [[high-quality]] {{HQ}} item.
; dyeCount
: If set, renders an item with a number of dye slots. Usually pulled from [[Property:Has dye channels]].

==== Example ====
<pre>{{#invoke: Icon | renderGameIcon
| type = Action
| icon = File:Transpose.png
| link = Transpose
| size = big
}}</pre>
{{#invoke: Icon | renderGameIcon
| type = Action
| icon = File:Transpose.png
| link = Transpose
| size = big
}}

=== <code>renderGameIconWithLabel</code> ===
Renders an in-game icon, alongside a label which links back to the thing, plus an optional quantity.

==== Parameters ====
'''All parameters taken by <code>renderGameIcon</code>''', plus:
; text
: Label text. This text will be a link that directs to the <code>link</code> parameter. Pass nothing or set to "x" to hide the label (useful to display quantity in a condensed way).
; qty
: Quantity, displayed between the item icon and the label.
; allowWrap
: By default, icon and label will be grouped in a container that prevents text wrapping. Set this parameter to disable that behavior. This should only really be used in infoboxes and other narrow templates.

==== Examples ====
<pre>{{#invoke: Icon | renderGameIconWithLabel
| type = Action
| icon = File:Cure.png
| link = Cure
| size = small
| text = Freecure isn't real and can't hurt you
}}</pre>
{{#invoke: Icon | renderGameIconWithLabel
| type = Action
| icon = File:Cure.png
| link = Cure
| size = small
| text = Freecure isn't real and can't hurt you
}}

== Lua functions ==
These functions are designed to be called from other Lua modules and accept Lua values as their parameters instead of <code>mw.frame</code> objects. To use any of these functions, load the module first with e.g.
 local icon = require("Module:Icon")

=== <code>plainIcon</code> ===
Displays a non-framed icon from the game, for example quest icons.

==== Parameters ====
Takes a single table parameter with the following keys:
; icon
: Icon file reference, including File: namespace and file extension.
; link
: Where the icon should link when clicked, usually the article name of the relevant concept.
; size
: Icon size. One of '''small''', '''mid''', or '''large'''. Defaults to small.

==== Returns ====
* A wikitext string.

==== Example ====
 local questIcon = icon.plainIcon({
     icon = "File:Quest icon.png",
     link = "Quest",
     size = "big",
 })

=== <code>frameIcon</code> ===
Displays a framed icon from the game, for example an item or action.

==== Parameters ====
Takes a single table parameter with the following keys:
; icon
: Icon file reference, including File: namespace and file extension.
; link
: Where the icon should link when clicked, usually the article name of the relevant concept.
; frame
: Frame type for the icon. Can be '''standard''' (default), '''hq''', '''trait''', or '''achievement'''.
; dyeCount
: For items, the number of dye slots the item has. Default is 0.
; size
: Icon size. One of '''small''', '''mid''', or '''large'''. Defaults to small.

==== Returns ====
* An [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#HTML_library HTML builder] node.

==== Example ====
 local traitIcon = icon.frameIcon({
     icon = "File:Heavier shot.png",
     link = "Heavier Shot",
     frame = "trait",
     size = "big",
 })

<includeonly>
<!-- Template/module categories and interwiki links go here -->
[[Category:Modules]]
</includeonly>