Module:HeroData/doc: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This module allows for the dynamic extraction of all hero data parameters, asset references, and translated profiles stored within the wiki's Cargo database (specifically from the <code>Hero</code> and <code>Translation</code> tables). It automatically handles localized fallback to English if a translation in the requested language is missing. | This module allows for the dynamic extraction of all hero data parameters, asset references, and translated profiles stored within the wiki's Cargo database (specifically from the <code>Hero</code> and <code>Translation</code> tables). It automatically handles localized fallback to English if a translation in the requested language is missing. | ||
Revision as of 20:19, 25 May 2026
This module allows for the dynamic extraction of all hero data parameters, asset references, and translated profiles stored within the wiki's Cargo database (specifically from the Hero and Translation tables). It automatically handles localized fallback to English if a translation in the requested language is missing.
Basic Syntax
To fetch a data field, use the following syntax:
{{#invoke:HeroData|get|HERO_ID|VARIABLE|LANGUAGE_CODE}}
HERO_ID: The technical identifier of the hero (e.g.,dungeon_hero_3).VARIABLE: The keyword for the specific data field you want to display (see the full index below).LANGUAGE_CODE: (Optional) The localization code (e.g.,en,fr,pl). Defaults to English (en).
---
Technical Reference Index
📝 Text & Translations (Language-Dependent)
These fields query the Translation table. They dynamically adapt to the requested language code and fallback to English seamlessly if missing.
| Variable | Description | Database Filter Relation |
|---|---|---|
name |
The localized name of the hero. | type="hero"
|
description |
The localized official biography or lore text of the hero. | type="hero"
|
motto |
The hero's localized specific quote or battle motto. | type="hero_motto"
|
⚔️ Split Starting Skills (Virtual Fields)
Instead of returning a raw comma-separated string from the database, the module automatically slices the data array into distinct outputs for clean wiki markup nesting:
| Variable | Description | Fallback Behavior |
|---|---|---|
start_skill_1 |
Returns the technical ID of the hero's primary starting skill. | Always returns the first value found. |
start_skill_2 |
Returns the technical ID of the hero's secondary starting skill. | Returns an empty string ("") if the hero only has one starting skill.
|
⚙️ Core Technical Properties
Standard database values extracted directly from the primary Hero table records.
| Variable | Description | Example Value |
|---|---|---|
class_id |
Technical ID linking to the hero's mechanical class archetype. | might_dungeon
|
faction |
The alignment group or city archetype the hero is drafted under. | dungeon
|
class_type |
Archetype category profiling orientation. | might or magic
|
icon |
The filename token assigned to the hero portrait graphic asset. | hero_dungeon_3_Stinger
|
specialization_id |
Points to the unique combat skill perk assigned to this specific hero unit. | dungeon_hero_3_specialization
|
source_path |
The file path location of the original repository data dump JSON. | DB/heroes/dungeon/d
|


