GrizzledAlchemistb40f9cb5: module documentation

2026-07-05T17:16:08Z

module documentation

New page

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

Renders a single inventory-style item slot: a <code>span.sanko-inventory-slot</code> containing a 28 px item sprite (via [[Template:ItemSprite]], linked to the item's page) and, when the quantity is anything other than <code>1</code>, a <code>span.sanko-inventory-qty</code> badge.

== Functions ==
=== slot ===
Wikitext entry point: <code><nowiki>{{#invoke:InventorySlot|slot|item=...|qty=...}}</nowiki></code>. <code>item</code> and <code>qty</code> may also be given as the first and second positional parameters.

{| class="wikitable sanko-table"
! Parameter !! Meaning !! Default
|-
| <code>item</code> (or first positional) || Item name; also used as the sprite's link target. Empty renders an empty slot. || —
|-
| <code>qty</code> (or second positional) || Quantity badge text. Hidden when empty or exactly <code>1</code>. || hidden
|}

Example:
<pre>{{#invoke:InventorySlot|slot|Iron Bar|3}}</pre>

=== _slot ===
Module-to-module entry point: <code>p._slot(frame, item, qty)</code>. Takes the same values as plain Lua arguments and returns the rendered HTML string. This is how [[Module:Recipe]] draws its input and output slots.

== Used by ==
* [[Module:Recipe]] — via <code>require('Module:InventorySlot')</code> and <code>inventory._slot(frame, item, qty)</code>.
* No template currently calls <code>#invoke:InventorySlot</code> directly.

== Notes and sharp edges ==
* The sprite is produced with <code>frame:expandTemplate{ title = 'ItemSprite', ... }</code>, so this module breaks if [[Template:ItemSprite]] is renamed or deleted, and the item name must exist in [[Module:Sprite/Item]] or the slot shows the missing-sprite <code>?</code> placeholder.
* The quantity check is a string comparison: only the exact string <code>1</code> (or empty) is suppressed. Values like <code>01</code> or <code>1 </code> will display. The value is shown verbatim — no number formatting.
* Sprite size is fixed at 28 px and the link always targets the item name; neither is parameterized.

Module:InventorySlot/doc - Revision history

GrizzledAlchemistb40f9cb5: module documentation