View source for Module:GameSummons/doc

== Module:GameSummons ==

'''Module:GameSummons''' renders summon data from [[Data:summons.json]] into a reusable infobox-style table.

It is intended to be used via a template (for example [[Template:Summon]]) so that summons can be embedded on any page without creating individual pages for each summon.

This module:

* Loads data via [[Module:GameData]] → <code>GameData.loadSummons()</code>.
* Looks up summons primarily by display <code>"Name"</code> (what editors use), with <code>"Internal Name"</code> as an optional fallback.
* Builds a table with only the fields that actually exist for that summon.

----

== Data source ==

Summon data comes from [[Data:summons.json]], which is a JSON page with this top-level structure (see [[Module:GameData/doc]] for full details):

 {
   "version": "SpiritVale-0.9.3",
   "schema_version": 1,
   "generated_at": "2025-12-12T17:24:05.818161+00:00",
   "records": [
     {
       "Name": "Angel Mage",
       "Internal Name": "Angel Mage",
       "Skill Name": "Summon Angel",
       "Skill Internal Name": "SummonAngel",
       "Attributes": [ ... ],
       "Skills": [ ... ],
       "Stages": [ ... ]
     }
   ]
 }

Each record is a single summon. Important keys:

* <code>"Name"</code> – the display name (what players and editors will usually see and use).
* <code>"Internal Name"</code> – the stable ID used internally and available as an optional parameter for power users and tooling.
* <code>"Skill Name"</code> – the name of the summoning skill.
* <code>"Skill Internal Name"</code> – the internal ID of the summoning skill.
* <code>"Attributes"</code> – a list of attribute blocks (Strength, Agility, etc., with Base and Per Level values where present).
* <code>"Skills"</code> – a list of active skills the summon can use.
* <code>"Stages"</code> – evolution stages, with Unlock Level and monster names.

----

== Output ==

For a given summon, the module renders a table with the CSS class <code>spiritvale-summon-infobox</code>.

Depending on what exists in the JSON record, the table may include:

* Header row with summon name.
* Internal name (for debugging / internal reference).
* Summon skill:
** Display skill name, and internal ID if present.
* Attributes:
** One line per attribute from <code>"Attributes"</code>, usually in the form:
*** <code>Strength – Base 5.0, 0.3 / Lv</code>
*** <code>Health Points – Base 100.0</code>
* Skills:
** One line per entry from <code>"Skills"</code>, including:
*** Skill name
*** Level
*** Cooldown
*** Cast Time (where present)
*** Target Health (where present)
* Stages:
** One line per entry from <code>"Stages"</code>, usually in the form:
*** <code>Stage 1: Angel (Unlock Lv.1)</code>
*** <code>Stage 2: Archangel (Unlock Lv.25)</code>
*** <code>Stage 3: Angel Mage (Unlock Lv.50)</code>

Rows are only shown if the underlying field exists in the JSON for that summon.

----

== Public interface ==

The module exposes a single entry point for templates:

=== <code>GameSummons.infobox(frame)</code> ===

This is usually called via <code>#invoke</code> from a template, not directly from pages.

It accepts the following parameters (either passed directly or via a wrapper template):

* <code>1</code> – unnamed parameter; treated as the summon <code>"Name"</code>.
* <code>name</code> – explicit display <code>"Name"</code> of the summon (equivalent to <code>1</code>).
* <code>id</code> – <code>"Internal Name"</code> of the summon (optional fallback / power use).

Lookup order:

# If <code>name</code> or the first unnamed parameter is provided and matches a record’s <code>"Name"</code>, that record is used.
# Otherwise, if <code>id</code> is provided and matches an <code>"Internal Name"</code>, that record is used.
# If nothing is found, a small error message is returned and the page is categorized for tracking.

Example direct usage (not recommended; normally use a template):

 {{#invoke:GameSummons|infobox|name=Angel Mage}}

or:

 {{#invoke:GameSummons|infobox|id=Angel Mage}}

----

== Template:Summon ==

The recommended way to use this module is via a small wrapper template, for example:

 Template:Summon

  {{#invoke:GameSummons|infobox
   | 1={{{1|}}}
   | name={{{name|}}}
   | id={{{id|}}}
  }}

Typical usage on any page:

 {{Summon|Angel Mage}}

or, explicitly:

 {{Summon|name=Angel Mage}}

Internal IDs can still be used when needed:

 {{Summon|id=Angel Mage}}

This keeps page wikitext simple while centralizing all JSON loading and formatting logic inside Lua.