GrizzledAlchemistb40f9cb5: module documentation

2026-07-05T17:14:26Z

module documentation

New page

This is the documentation page for [[Module:Sprite]].

Renders an item icon from the Sanko item sprite atlas as a CSS background-positioned <code><span></code>. Atlas coordinates come from the data module [[Module:Sprite/Item]] (loaded via <code>mw.loadData</code>).

== Functions ==
=== item ===
The only public function. Called as <code><nowiki>{{#invoke:Sprite|item|name=...|size=...|link=...}}</nowiki></code>.

{| class="wikitable sanko-table"
! Parameter !! Meaning !! Default
|-
| <code>name</code> (or first positional) || Item name; must match a key in <code>Module:Sprite/Item</code>'s <code>items</code> table exactly (trimmed, case-sensitive). || —
|-
| <code>size</code> || Rendered icon size in pixels; the atlas is scaled by <code>size / cell</code> (cell is 32). || 32
|-
| <code>link</code> || Page to wikilink the icon to. Empty = no link. || none
|}

Output is a <code>span.sanko-sprite</code> with <code>role="img"</code>, <code>aria-label</code>, and <code>data-minetip-title</code> set to the item name, plus computed <code>background-position</code>/<code>background-size</code>. When <code>link</code> is set the span is wrapped in <code>span.sanko-sprite-link</code> containing a wikilink.

== Used by ==
* [[Template:ItemSprite]] — <code><nowiki>{{#invoke:Sprite|item|name={{{1|{{{name|}}}}}}|size={{{size|32}}}|link={{{link|}}}}}</nowiki></code>
* [[Template:Sprite]] — identical invocation.

Prefer calling these templates from articles rather than <code>#invoke</code> directly, e.g. <code><nowiki>{{ItemSprite|Air Shard|size=32}}</nowiki></code>.

== Notes and sharp edges ==
* The lookup is exact-match on the trimmed name. An unknown name does not error; it renders a <code>span.sanko-sprite-missing</code> placeholder showing <code>?</code> (minetip "Unknown item" when the name is blank). If an icon shows <code>?</code>, check spelling/capitalization against [[Module:Sprite/Item]].
* The module only reads <code>frame.args</code>, not the parent frame's arguments — templates must pass <code>name</code>/<code>size</code>/<code>link</code> through explicitly, as the two templates above do.
* The module sets background position/size only; the atlas image itself is attached by the <code>.sanko-sprite</code> site CSS, not by this module. The <code>url</code>/<code>image</code> fields in the data module are not read here.
* Offsets are <code>math.floor</code>-ed after scaling, so sizes that are not multiples of the 32 px cell can be off by up to a pixel.

Module:Sprite/doc - Revision history

GrizzledAlchemistb40f9cb5: module documentation