Template:SpellRankDef: Difference between revisions

From Heroes of Might and Magic: Olden Era Official Wiki
obelisk-bot: uploading initial Cargo templates
obelisk-bot: Pushing translation table rework
 
(2 intermediate revisions by the same user not shown)
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 structural data for a [[Template:SpellDef|Spell]]. Always 4 rows per spell — levels 1=no skill, 2=basic, 3=advanced, 4=expert.


The bot emits these inline on the parent <code>Data:Spell/<id></code> page. There are no individual <code>Data:SpellRank/</code> pages.
SpellRank carries only the '''mechanical, language-independent''' fields. The rank's localizable text — its description and bonus unlock blurb, in every language including English — lives in the shared [[Template:TranslationDef|Translation]] table, keyed by <code>type=spell_rank</code>, <code>target_id=<spell_id></code>, <code>variant=<level></code>. The spell's '''name''' is '''not''' a per-rank value — it is static across all four ranks — so it is stored once, in [[Template:SpellDef|Spell]]'s <code>type=spell</code> Translation rows, and never duplicated here.
 
The bot emits these inline on the parent <code>Data:Spell/<id></code> page, each <code><nowiki>{{SpellRankDef}}</nowiki></code> row followed by its per-language <code><nowiki>{{TranslationDef}}</nowiki></code> rows.


== Schema ==
== Schema ==
Line 8: Line 10:
| spell_id = String
| spell_id = String
| level = Integer
| level = Integer
| name_sid = String
| description_sid = String
| description_sid = String
| description = Wikitext
| bonus_description_sid = String
| bonus_description_sid = String
| bonus_description = Wikitext
| mana_cost = Integer
| mana_cost = Integer
| upgrade_cost = Integer
| upgrade_cost = Integer
| 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
}}
}}


<pre><nowiki>
<pre><nowiki>
{{SpellRankDef
{{SpellRankDef
| spell_id = String                 <!-- joins SpellDef.id -->
| spell_id = String
| level = Integer                   <!-- 1..4 -->
| level = Integer                 <!-- 1=no skill, 2=basic, 3=advanced, 4=expert -->
 
| name_sid = String                <!-- spell name SID (shared across ranks; duplicated per row for clean queries) -->
 
| description_sid = String
| description_sid = String
| description = Wikitext            <!-- resolved English -->
| bonus_description_sid = String    <!-- null at level 1 -->
 
<!-- 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
| mana_cost = Integer
| upgrade_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>
</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>.
* '''No <code>name_sid</code> here.''' The spell's name is static across all four ranks — it is not a per-rank value. It lives on [[Template:SpellDef|Spell]] (<code>name_sid</code>) and its resolved text in the Translation table under <code>type='spell'</code>. There is no "rank name" concept in the source data.
* '''<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_sid</code> / <code>bonus_description_sid</code> point at the L10n entries the rank's text was sourced from. <code>bonus_description_sid</code> is null at level 1. Traceability only; not the translation join path.
* '''<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.
* Resolved text for every language (including English) lives in [[Template:TranslationDef|Translation]]: the <code>description</code> and <code>bonus_description</code> columns, <code>WHERE type='spell_rank' AND target_id=<spell_id> AND variant=<level></code>. The <code>name</code> column on those rows is left empty — see the note above. Hero-dependent placeholders (<code>{N}</code> for spell-power-scaled values) stay unsubstituted in the stored text.
* '''<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).
* <code>mana_cost</code> / <code>upgrade_cost</code> are the per-rank mechanical costs.
* '''<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 ==
* [[Template:SpellDef|Spell]] — joined on <code>SpellRank.spell_id = Spell.id</code> (N:1).
* [[Template:SpellDef|Spell]] — joined on <code>SpellRank.spell_id = Spell.id</code> (N:1).
* [[Template:TranslationDef|Translation]] — joined on <code>SpellRank.spell_id = Translation.target_id AND SpellRank.level = Translation.variant</code>, <code>WHERE Translation.type='spell_rank'</code> (1:N, one row per language).


[[Category:Cargo Definitions]]
[[Category:Cargo Definitions]]
Line 146: Line 42:
| spell_id = {{{spell_id|}}}
| spell_id = {{{spell_id|}}}
| level = {{{level|}}}
| level = {{{level|}}}
| name_sid = {{{name_sid|}}}
| description_sid = {{{description_sid|}}}
| description_sid = {{{description_sid|}}}
| description = {{{description|}}}
| bonus_description_sid = {{{bonus_description_sid|}}}
| bonus_description_sid = {{{bonus_description_sid|}}}
| bonus_description = {{{bonus_description|}}}
| mana_cost = {{{mana_cost|}}}
| mana_cost = {{{mana_cost|}}}
| upgrade_cost = {{{upgrade_cost|}}}
| upgrade_cost = {{{upgrade_cost|}}}
| pt_br_name = {{{pt_br_name|}}}
}}
| pt_br_description = {{{pt_br_description|}}}
Created <code>SpellRank</code> entry: <code>{{{spell_id|}}} (level {{{level|}}})</code></includeonly>
| pt_br_bonus_description = {{{pt_br_bonus_description|}}}
| cs_name = {{{cs_name|}}}
| cs_description = {{{cs_description|}}}
| cs_bonus_description = {{{cs_bonus_description|}}}
| fr_name = {{{fr_name|}}}
| fr_description = {{{fr_description|}}}
| fr_bonus_description = {{{fr_bonus_description|}}}
| de_name = {{{de_name|}}}
| de_description = {{{de_description|}}}
| de_bonus_description = {{{de_bonus_description|}}}
| hu_name = {{{hu_name|}}}
| hu_description = {{{hu_description|}}}
| hu_bonus_description = {{{hu_bonus_description|}}}
| it_name = {{{it_name|}}}
| it_description = {{{it_description|}}}
| it_bonus_description = {{{it_bonus_description|}}}
| ja_name = {{{ja_name|}}}
| ja_description = {{{ja_description|}}}
| ja_bonus_description = {{{ja_bonus_description|}}}
| ko_name = {{{ko_name|}}}
| ko_description = {{{ko_description|}}}
| ko_bonus_description = {{{ko_bonus_description|}}}
| pl_name = {{{pl_name|}}}
| pl_description = {{{pl_description|}}}
| pl_bonus_description = {{{pl_bonus_description|}}}
| ru_name = {{{ru_name|}}}
| ru_description = {{{ru_description|}}}
| ru_bonus_description = {{{ru_bonus_description|}}}
| es_name = {{{es_name|}}}
| es_description = {{{es_description|}}}
| es_bonus_description = {{{es_bonus_description|}}}
| tr_name = {{{tr_name|}}}
| tr_description = {{{tr_description|}}}
| tr_bonus_description = {{{tr_bonus_description|}}}
| uk_name = {{{uk_name|}}}
| uk_description = {{{uk_description|}}}
| uk_bonus_description = {{{uk_bonus_description|}}}
| zh_cn_name = {{{zh_cn_name|}}}
| zh_cn_description = {{{zh_cn_description|}}}
| zh_cn_bonus_description = {{{zh_cn_bonus_description|}}}
| zh_tw_name = {{{zh_tw_name|}}}
| zh_tw_description = {{{zh_tw_description|}}}
| zh_tw_bonus_description = {{{zh_tw_bonus_description|}}}
}}</includeonly>

Latest revision as of 00:34, 15 May 2026

This template defines and stores rows for the SpellRank Cargo table. Per-mastery-level structural data for a Spell. Always 4 rows per spell — levels 1=no skill, 2=basic, 3=advanced, 4=expert.

SpellRank carries only the mechanical, language-independent fields. The rank's localizable text — its description and bonus unlock blurb, in every language including English — lives in the shared Translation table, keyed by type=spell_rank, target_id=<spell_id>, variant=<level>. The spell's name is not a per-rank value — it is static across all four ranks — so it is stored once, in Spell's type=spell Translation rows, and never duplicated here.

The bot emits these inline on the parent Data:Spell/<id> page, each {{SpellRankDef}} row followed by its per-language {{TranslationDef}} rows.

Schema

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

{{SpellRankDef
| spell_id = String
| level = Integer                  <!-- 1=no skill, 2=basic, 3=advanced, 4=expert -->
| description_sid = String
| bonus_description_sid = String    <!-- null at level 1 -->
| mana_cost = Integer
| upgrade_cost = Integer
}}

Field notes

  • Primary key is (spell_id, level).
  • No name_sid here. The spell's name is static across all four ranks — it is not a per-rank value. It lives on Spell (name_sid) and its resolved text in the Translation table under type='spell'. There is no "rank name" concept in the source data.
  • description_sid / bonus_description_sid point at the L10n entries the rank's text was sourced from. bonus_description_sid is null at level 1. Traceability only; not the translation join path.
  • Resolved text for every language (including English) lives in Translation: the description and bonus_description columns, WHERE type='spell_rank' AND target_id=<spell_id> AND variant=<level>. The name column on those rows is left empty — see the note above. Hero-dependent placeholders ({N} for spell-power-scaled values) stay unsubstituted in the stored text.
  • mana_cost / upgrade_cost are the per-rank mechanical costs.

Related tables

  • Spell — joined on SpellRank.spell_id = Spell.id (N:1).
  • Translation — joined on SpellRank.spell_id = Translation.target_id AND SpellRank.level = Translation.variant, WHERE Translation.type='spell_rank' (1:N, one row per language).