Editing Module:HeroData/doc (section)Give feedback

== Internal Utility Functions ==
The following functions are called directly from Lua by other modules, not from wikitext:

=== get_json_item ===
Returns the table of a specific hero by name

====Parameters====
* '''name''' - Name of the hero in english

=== get_stat ===
Returns the value of a stat, checking the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block. Returns nil when the hero has no such stat. This is the shared lookup behind get_hero_var, get_list_elem and hero_has_stat.

====Parameters====
* '''hero_data''' - Hero table, such as the one returned by get_json_item
* '''stat''' - Key of the stat

=== get_scalings ===
Returns an ordered list of a hero's scalings for a stat, Level first then Spirit:

<pre>{ { type = "Level", value = 1.5 }, { type = "Spirit", value = 0.04 } }</pre>

Absent and zero scalings are omitted, so an empty list means the stat does not scale.

====Parameters====
* '''hero_data''' - Hero table
* '''stat''' - Key of the stat
* '''include_zero''' - OPTIONAL, keep scalings whose value is 0. Only get_hero_scaling_data needs this.

=== has_stat ===
Returns true when a hero has a non-zero base value for a stat, or any scaling for it. Backs hero_has_stat.

====Parameters====
* '''hero_data''' - Hero table
* '''stat''' - Key of the stat

=== find_hero_key ===
Resolves a hero key or an english hero name to a hero key, case-insensitively. Returns nil when the input matches no hero. Backs get_hero_key and resolve_key.

====Parameters====
* '''input''' - Hero key or english hero name

=== hero_tag ===
Returns a hero's Nth description tag, or an empty string when there is no such tag. Backs get_hero_tag and has_tags.

====Parameters====
* '''hero_en''' - Name of the hero in english
* '''index''' - Which tag to return (1, 2 or 3)

=== write_scalar_str ===
Returns the expanded <code>Ss</code> or <code>PI</code> template for a scaling value, or an empty string when the value is 0.

====Parameters====
* '''scaling_value''' - The scaling amount
* '''scaling_type''' - "Spirit" or "Level"
* '''compact''' - OPTIONAL, render the compact form with the value shown

=== get_hero_scaling_data ===
'''Deprecated''', use get_scalings instead. Returns a table keyed by scaling value, so an entry is silently dropped when Level and Spirit scale by the same amount, and zero scalings are kept. Retained only for [[Module:HeroComparisonTable]].

====Parameters====
* '''hero_data''' - Hero table
* '''stat''' - Key of the stat