View source for Module:HeroSubClassData/doc

{{Documentation}}
This module provides standardized methods to query mechanical data configurations, activation skill prerequisites, and localized texts mapped to specific hero mastery subclasses directly from the Cargo database tables (specifically <code>HeroSubClass</code> and <code>Translation</code>).

== Basic Syntax ==

To extract any structural variable node or translation block from a hero subclass registry page:
<pre>{{#invoke:HeroSubClassData|get|SUBCLASS_ID|VARIABLE|LANGUAGE_CODE}}</pre>

* '''<code>SUBCLASS_ID</code>''' : The technical internal database key identifier assigned to the targeted hero subclass row (e.g., <code>sub_class_human_might_1</code>).
* '''<code>VARIABLE</code>''' : The specific data field node target identifier to look up (see reference matrix below).
* '''<code>LANGUAGE_CODE</code>''' : ''(Optional)'' Sets the localization system language. Defaults to French (<code>fr</code>) if omitted, with automated fallbacks.

---

== Technical Reference Index ==

=== 📝 Localized Text Blocks (Language-Aware) ===
Queries localized dictionary assets that translate dynamically based on the language parameter input.
{| class="wikitable" style="width:100%;"
! Variable Keyword !! Description !! Sample Expected Output
|-
| <code>name</code> || The localized public name of the specialty subclass. || Bretteur
|-
| <code>description</code> || Mechanical lore synopses detailing passive thresholds or stats adjustments. || Coup héroïque inflige +60 point(s)...
|}

=== ⚙️ Structural & Mechanical Properties ===
Static code variables returning gameplay rows directly mapped parameters tied into the core game database.
{| class="wikitable" style="width:100%;"
! Variable Keyword !! Description !! Sample Output
|-
| <code>faction</code> || The alignment technical name faction group linked to the subclass. || <code>human</code>
|-
| <code>class_type</code> || Archetypal class methodology branch style. || <code>might</code>
|-
| <code>icon</code> || Graphical asset emblem visual token key identifier. || <code>sub_class_human_might_1_icon</code>
|-
| <code>source_path</code> || Server file system dump localization repository tree tracker. || <code>DB/heroes_sub_classes/sub_classes_human.json</code>
|}

=== ⚔️ Required Activation Skills ===
Prerequisites requirements parameters checking skills conditions to validate the subclass unlock state.
{| class="wikitable" style="width:100%;"
! Variable Keyword !! Description !! Variable Keyword !! Description
|-
| <code>activation_skill_1_sid</code> || Internal ID of required Skill 1 || <code>activation_skill_1_level</code> || Required level threshold for Skill 1
|-
| <code>activation_skill_2_sid</code> || Internal ID of required Skill 2 || <code>activation_skill_2_level</code> || Required level threshold for Skill 2
|-
| <code>activation_skill_3_sid</code> || Internal ID of required Skill 3 || <code>activation_skill_3_level</code> || Required level threshold for Skill 3
|-
| <code>activation_skill_4_sid</code> || Internal ID of required Skill 4 || <code>activation_skill_4_level</code> || Required level threshold for Skill 4
|-
| <code>activation_skill_5_sid</code> || Internal ID of required Skill 5 || <code>activation_skill_5_level</code> || Required level threshold for Skill 5
|}

---

== Practical Implementation Examples ==

=== Example 1: Creating a Prerequisites Checklist ===
Pull structural required requirements to display dynamic conditional lists on wiki pages:
<pre>
To become a {{#invoke:HeroSubClassData|get|sub_class_human_might_1|name|en}}, you need:
* {{#invoke:HeroSubClassData|get|sub_class_human_might_1|activation_skill_1_sid}} at Level {{#invoke:HeroSubClassData|get|sub_class_human_might_1|activation_skill_1_level}}
* {{#invoke:HeroSubClassData|get|sub_class_human_might_1|activation_skill_2_sid}} at Level {{#invoke:HeroSubClassData|get|sub_class_human_might_1|activation_skill_2_level}}
</pre>

[[Category:Module Documentation]]