GrizzledAlchemistb40f9cb5: module documentation

2026-07-05T17:17:18Z

module documentation

New page

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

Renders the visual recipe box (<code>div.sanko-recipe</code>) shown by [[Template:Recipe]]: a row of metadata pills, up to six input item slots, an arrow, and an output slot. Item slots are drawn by [[Module:InventorySlot]] (<code>require</code>d, via <code>_slot</code>).

This module is display-only. The Cargo storage for recipes (a <code>Recipes</code> row, plus <code>RecipeIngredients</code>/<code>RecipeOutputs</code> rows stored via [[Template:RecipeIngredient]] and [[Template:RecipeOutput]]) is handled by the wikitext of [[Template:Recipe]] itself, not here.

== Functions ==
=== box ===
Called from [[Template:Recipe]] as <code><nowiki>{{#invoke:Recipe|box}}</nowiki></code> with no explicit arguments: each parameter is taken from <code>frame.args</code> when present there, otherwise from the parent frame's (i.e. the template call's) arguments; a value that is missing or empty after that lookup falls back to the default. (A parameter set to an empty string in <code>frame.args</code> does not fall through to the parent frame — the parent is only consulted when the key is absent.)

{| class="wikitable sanko-table"
! Parameter !! Meaning !! Default
|-
| <code>recipe_kind</code> || Pill text; also switches output rendering (see below). || <code>Crafting</code>
|-
| <code>station</code>, <code>skill</code>, <code>element</code> || Rendered as pills when non-empty. || omitted
|-
| <code>level_req</code>, <code>xp</code>, <code>base_max_hit</code> || Rendered as "Level N", "N XP", "Max hit N" pills when non-empty. || omitted
|-
| <code>input1</code>…<code>input6</code> || Input item names; each non-empty one becomes an inventory slot. || omitted
|-
| <code>input1_qty</code>…<code>input6_qty</code> || Quantity for the matching input. || <code>1</code>
|-
| <code>output</code> (fallback <code>output_item</code>) || Output item name. || —
|-
| <code>output_qty</code> || Output quantity. || <code>1</code>
|}

== Used by ==
* [[Template:Recipe]] — the invocation is the last piece of the template, after its <code>#cargo_store</code> calls. Articles use the template, e.g. from [[Air Missile]]:
<pre>{{Recipe
|recipe_id=spell_air_missile
|recipe_kind=Spell
|output=Air Missile
|output_qty=1
|station=Spellbook
|skill=Magic
|level_req=1
|xp=
|element=air
|base_max_hit=2
|source=SankoQuest game data
|verification_status=Needs gameplay verification
|input1=Air Shard
|input1_qty=1
|input2=Spirit Shard
|input2_qty=1
}}</pre>
(<code>source</code> and <code>verification_status</code> are consumed by Template:Recipe's Cargo rows, not by this module.)

== Notes and sharp edges ==
* When <code>recipe_kind</code> is exactly <code>Spell</code> (case-sensitive), the output is rendered as text in <code>div.sanko-spell-output</code> instead of an item slot, with a small <code>xN</code> suffix when <code>output_qty</code> is not <code>1</code> — useful for outputs that are not inventory items.
* Only six input slots exist; <code>input7</code> and beyond are ignored.
* The arrow (<code>→</code>) and the output area render even when inputs or output are empty, so a bare invocation still produces a (mostly empty) box.
* Input/output item names must match keys in [[Module:Sprite/Item]] or their slots show the missing-sprite <code>?</code> placeholder.

Module:Recipe/doc - Revision history

GrizzledAlchemistb40f9cb5: module documentation