Template:SpellRankDef: Difference between revisions

From Heroes of Might and Magic: Olden Era Official Wiki
obelisk-bot: uploading initial Cargo templates
obelisk-bot: uploading initial Cargo templates
Line 1: Line 1:
<noinclude>
<noinclude>
This template defines and stores rows for the '''SpellRank''' Cargo table. Per-mastery-level data for a [[Template:SpellDef|Spell]]. Always 4 rows per spell — levels 1=no skill, 2=basic, 3=advanced, 4=expert. Each row is self-contained: it carries the English defaults, the mechanical fields, ''and'' the 15 non-English translations of every translatable field. The old <code>SpellRankTranslationDef</code> sibling table was folded back into this one — the three-translatable-field shape (name + description + bonus_description) didn't fit [[Template:EntryDef|Entry]]'s generic name+description-only schema, so spell ranks get their own expanded shape.
This template defines and stores rows for the '''SpellRank''' Cargo table. Per-mastery-level data for a [[Template:SpellDef|Spell]]. Always 4 rows per spell — levels 1=no skill, 2=basic, 3=advanced, 4=expert. Each row is self-contained: it carries English defaults, mechanical fields, and 15 non-English translations of name + description + bonus_description.


The bot emits these inline on the parent <code>Data:Spell/<id></code> page. There are no individual <code>Data:SpellRank/…</code> pages.
The bot emits these inline on the parent <code>Data:Spell/<id></code> page.


== Schema ==
== Schema ==
Line 61: Line 61:
| zh_tw_bonus_description = Wikitext
| zh_tw_bonus_description = Wikitext
}}
}}
<pre><nowiki>
{{SpellRankDef
| spell_id = String                <!-- joins SpellDef.id -->
| level = Integer                  <!-- 1..4 -->
| name_sid = String                <!-- spell name SID (shared across ranks; duplicated per row for clean queries) -->
| description_sid = String
| description = Wikitext            <!-- resolved English -->
<!-- Level-up bonus + upgrade cost. Null on level 1; populated on levels 2/3/4. -->
| bonus_description_sid = String
| bonus_description = Wikitext      <!-- resolved English -->
| mana_cost = Integer
| upgrade_cost = Integer
<!-- Per-language triples for every supported non-English locale.
    Each language gets a name + description + bonus_description column. -->
| pt_br_name = String
| pt_br_description = Wikitext
| pt_br_bonus_description = Wikitext
| cs_name = String
| cs_description = Wikitext
| cs_bonus_description = Wikitext
| fr_name = String
| fr_description = Wikitext
| fr_bonus_description = Wikitext
| de_name = String
| de_description = Wikitext
| de_bonus_description = Wikitext
| hu_name = String
| hu_description = Wikitext
| hu_bonus_description = Wikitext
| it_name = String
| it_description = Wikitext
| it_bonus_description = Wikitext
| ja_name = String
| ja_description = Wikitext
| ja_bonus_description = Wikitext
| ko_name = String
| ko_description = Wikitext
| ko_bonus_description = Wikitext
| pl_name = String
| pl_description = Wikitext
| pl_bonus_description = Wikitext
| ru_name = String
| ru_description = Wikitext
| ru_bonus_description = Wikitext
| es_name = String
| es_description = Wikitext
| es_bonus_description = Wikitext
| tr_name = String
| tr_description = Wikitext
| tr_bonus_description = Wikitext
| uk_name = String
| uk_description = Wikitext
| uk_bonus_description = Wikitext
| zh_cn_name = String
| zh_cn_description = Wikitext
| zh_cn_bonus_description = Wikitext
| zh_tw_name = String
| zh_tw_description = Wikitext
| zh_tw_bonus_description = Wikitext
}}
</nowiki></pre>


== Field notes ==
== Field notes ==
* '''Primary key is <code>(spell_id, level)</code>.'''
* Primary key is <code>(spell_id, level)</code>.
* '''<code>name_sid</code>''' carries the spell's name SID — same value across all four ranks for a given spell. Duplicated per-row so a query against <code>SpellRank</code> alone can render a labeled per-rank table without joining back to <code>Spell</code>.
* <code>name_sid</code> carries the spell's name SID — same across all four ranks; duplicated per-row for clean labelled per-rank queries.
* '''<code>description_sid</code>''' points at the source <code>description[level-1]</code> SID. Levels 1 and 2 often share the same SID (the "no mastery" text and the "basic" text are typically identical).
* <code>description</code> carries resolved English text. Hero-dependent placeholders (<code>{N}</code> for spell-power-scaled values) stay unsubstituted.
* '''<code>description</code>''' carries the resolved English text. Static spell-config placeholders are pre-substituted (the bot threads the spell's JSON through the resolver). '''Hero-dependent placeholders (<code>{N}</code> for spell-power-scaled values) intentionally stay unsubstituted''' — the actual numbers depend on the casting hero, so the wiki display layer surfaces them generically. See D-030.
* <code>bonus_description</code> is the unlock blurb at this level. Null at level 1.
* '''<code>bonus_description_sid</code> / <code>bonus_description</code>''' are the unlock-bonus message shown when reaching this level (e.g. "Affects all friendly creatures."). Null for level 1 (the starting rank).
* Per-language columns are sparse — only emitted when the corresponding SID exists.
* '''<code>upgrade_cost</code>''' is the resource cost paid to upgrade ''to'' this level (in the spell's primary upgrade resource — usually a small number like 25). Null for level 1. For length-1 source <code>upgradeCost</code> arrays (mostly world-map utility spells), only level 2 gets a value.
* '''<code><lang>_*</code> columns''' are sparse — a row only carries the translations for which the corresponding SID exists. If a spell has no <code>bonus_description_sid</code> at a given level, all 15 <code><lang>_bonus_description</code> columns are simply absent from the emitted invocation.
* '''Resolver context''' for the non-English lookups uses the same per-rank <code>magic_json = {"raw": spell.raw_json, "level": <level>}</code> context the English lookup uses, so per-mastery-level magicDealer values substitute identically across all 16 languages.


== Related tables ==
== Related tables ==
Line 198: Line 128:
| zh_tw_description = {{{zh_tw_description|}}}
| zh_tw_description = {{{zh_tw_description|}}}
| zh_tw_bonus_description = {{{zh_tw_bonus_description|}}}
| zh_tw_bonus_description = {{{zh_tw_bonus_description|}}}
}}</includeonly>
}}
Created <code>SpellRank</code> entry: <code>{{{spell_id|}}} (level {{{level|}}})</code></includeonly>

Revision as of 01:12, 13 May 2026

This template defines and stores rows for the SpellRank Cargo table. Per-mastery-level data for a Spell. Always 4 rows per spell — levels 1=no skill, 2=basic, 3=advanced, 4=expert. Each row is self-contained: it carries English defaults, mechanical fields, and 15 non-English translations of name + description + bonus_description.

The bot emits these inline on the parent Data:Spell/<id> page.

Schema

This template defines the table "SpellRank". View table.

Field notes

  • Primary key is (spell_id, level).
  • name_sid carries the spell's name SID — same across all four ranks; duplicated per-row for clean labelled per-rank queries.
  • description carries resolved English text. Hero-dependent placeholders ({N} for spell-power-scaled values) stay unsubstituted.
  • bonus_description is the unlock blurb at this level. Null at level 1.
  • Per-language columns are sparse — only emitted when the corresponding SID exists.

Related tables

  • Spell — joined on SpellRank.spell_id = Spell.id (N:1).