Editing Template:HeroData/doc (section)Give feedback

== 📖 Template Functions ==
The template has different modes depending on what information you need.

=== Getting Stats (Default) ===
This is the most common use case. Retrieves a hero's base stat value. The module automatically checks the hero's top-level stats, then Weapon stats, then AltFire stats.

'''Syntax:'''
<code><nowiki>{{HeroData|HERO_NAME|STAT_NAME|sig_figs_or_localize}}</nowiki></code>

'''Parameters:'''
* '''HERO_NAME''' - The hero's name (e.g., <code>Abrams</code>, <code>Bebop</code>) or internal key (e.g., <code>hero_atlas</code>)
* '''STAT_NAME''' - The stat to retrieve (e.g., <code>MaxHealth</code>, <code>BulletResist</code>)
* '''sig_figs_or_localize''' (optional) - Either a number for rounding (significant figures) or <code>true</code> to localize the value

'''Examples:'''
* <code><nowiki>{{HeroData|Abrams|MaxHealth}}</nowiki></code> → {{HeroData|Abrams|MaxHealth}}
* <code><nowiki>{{HeroData|Bebop|BulletResist}}</nowiki></code> → {{HeroData|Bebop|BulletResist}}
* <code><nowiki>{{HeroData|Abrams|MaxHealth|2}}</nowiki></code> → {{HeroData|Abrams|MaxHealth|2}} ''(rounded to 2 sig figs)''
* <code><nowiki>{{HeroData|Bebop|DPS|3}}</nowiki></code> → {{HeroData|Bebop|DPS|3}}

=== Getting Alt Fire Stats ===
Retrieves stats specifically from a hero's alternate fire mode.

'''Syntax:'''
<code><nowiki>{{HeroData|altfire|HERO_NAME|STAT_NAME|sig_figs_or_localize}}</nowiki></code>

'''Example:'''
* <code><nowiki>{{HeroData|altfire|Shiv|BulletDamage}}</nowiki></code> → {{HeroData|altfire|Shiv|BulletDamage}}

=== Getting List Elements ===
Retrieves a specific element from a list/array property. Primarily used for weapon types.

'''Syntax:'''
<code><nowiki>{{HeroData|list|HERO_NAME|LIST_NAME|INDEX|localize}}</nowiki></code>

'''Parameters:'''
* '''LIST_NAME''' - The name of the list property (usually <code>WeaponTypes</code>)
* '''INDEX''' - Which element to get (1 for first, 2 for second, etc.)
* '''localize''' (optional) - Defaults to <code>true</code> for readable names. Set to <code>false</code> for raw internal keys.

'''Examples:'''
* <code><nowiki>{{HeroData|list|Abrams|WeaponTypes|1}}</nowiki></code> → {{HeroData|list|Abrams|WeaponTypes|1}} ''(returns "Spreadshot")''
* <code><nowiki>{{HeroData|list|Abrams|WeaponTypes|2}}</nowiki></code> → {{HeroData|list|Abrams|WeaponTypes|2}} ''(returns "Close Range")''
* <code><nowiki>{{HeroData|list|Abrams|WeaponTypes|1|false}}</nowiki></code> → {{HeroData|list|Abrams|WeaponTypes|1|false}} ''(returns raw "Attribute_EWeaponAttribute_Spreadshot")''

'''Note:''' By default, list elements are localized to give readable names like "Spreadshot" instead of "Attribute_EWeaponAttribute_Spreadshot".

=== Getting Scaling Values ===
Retrieves the scaling value for a stat and returns it formatted with the appropriate scaling template ({{tl|Ss}} for Spirit or {{tl|PI}} for Power Increases).

'''Syntax:'''
<code><nowiki>{{HeroData|scalar|HERO_NAME|SCALING_TYPE|STAT_NAME|sig_figs_or_localize}}</nowiki></code>

'''Parameters:'''
* '''SCALING_TYPE''' - Either <code>Spirit</code> or <code>Level</code> (for Power Increases)
* '''STAT_NAME''' - The stat to check scaling for
* '''sig_figs_or_localize''' (optional) - Rounding or localization

'''Examples:'''
* <code><nowiki>{{HeroData|scalar|Sinclair|Spirit|MaxMoveSpeed}}</nowiki></code> → {{HeroData|scalar|Sinclair|Spirit|MaxMoveSpeed}}
* <code><nowiki>{{HeroData|scalar|Bebop|Level|BulletResist}}</nowiki></code> → {{HeroData|scalar|Bebop|Level|BulletResist}}

'''Note:''' Returns an empty string if the hero doesn't have scaling for that stat.

=== Getting Hero Tags ===
Retrieves one of a hero's three descriptive tags.

'''Syntax:'''
<code><nowiki>{{HeroData|tag|HERO_NAME|TAG_NUMBER}}</nowiki></code>

'''Parameters:'''
* '''HERO_NAME''' - The hero's display name (e.g., <code>Abrams</code>, <code>Lady Geist</code>)
* '''TAG_NUMBER''' - 1, 2, or 3 (for the first, second, or third tag)

'''Examples:'''
* <code><nowiki>{{HeroData|tag|Abrams|1}}</nowiki></code> → {{HeroData|tag|Abrams|1}}
* <code><nowiki>{{HeroData|tag|Lady Geist|2}}</nowiki></code> → {{HeroData|tag|Lady Geist|2}}