| Latest revision |
Your text |
| Line 1: |
Line 1: |
| Also see:
| |
| * [[Module:HeroData/nav]] - For nav box purposes
| |
| * [[Module:HeroData/release]] - For determining the release status of a hero
| |
| * [[Module:HeroDataArrays]] - For tables in stat pages
| |
|
| |
| == Overview == | | == Overview == |
|
| |
|
| Line 20: |
Line 15: |
|
| |
|
| ====Parameters==== | | ====Parameters==== |
| * '''hero_name''' - Name of the hero in english, or key of the hero. Preferred and recommended to use hero key, as its much more efficient. Search for the key in [[Data:HeroData.json]] | | * '''hero_name''' - Name of the hero in english, or key of the hero |
| * '''hero_var''' - Key of the hero's variable, see [[Data:HeroData.json]] | | * '''hero_var''' - Key of the hero's variable, see [[Data:HeroData.json]] |
| * '''sig_figs_or_localize''' - OPTIONAL, # of sig figs to round to if retrieving a float, or "true" if its a string that should be localized. See Localizable values section. | | * '''sig_figs_or_localize''' - OPTIONAL, # of sig figs to round to if retrieving a float, or "true" if its a string that should be localized. See Localizable values section. |
|
| |
|
| Note: Recommended to use hero key where possible, i.e. hero_atlas as its O(1) time complexity instead of hero name (Abrams) which is O(N). | | Note: Recommended to use hero key where possible, i.e. hero_atlas as its O(1) instead of hero name (Abrams) which is O(N). |
|
| |
|
| ====Examples==== | | ====Examples==== |
| Line 65: |
Line 60: |
|
| |
|
| If using localize parameter, ensure the value is a string. See [[Data:HeroData.json]], you will notice that hero_astro's "Lore" variable has the value "hero_astro_lore". This key is then sent to [[Module:Lang]] which checks for it in [[Data:Lang_en.json]] (or a different language). | | If using localize parameter, ensure the value is a string. See [[Data:HeroData.json]], you will notice that hero_astro's "Lore" variable has the value "hero_astro_lore". This key is then sent to [[Module:Lang]] which checks for it in [[Data:Lang_en.json]] (or a different language). |
|
| |
| This function will automatically search for the variable in the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block.
| |
|
| |
| === get_alt_fire_var ===
| |
| Retrieve a hero's variable's value from "AltFire" table. Works the same as get_hero_var
| |
|
| |
| ====Examples====
| |
|
| |
| <pre>{{#invoke:HeroData|get_alt_fire_var|Viscous|BulletDamage}}</pre>
| |
| {{#invoke:HeroData|get_alt_fire_var|Viscous|BulletDamage}}
| |
|
| |
|
| === get_list_elem === | | === get_list_elem === |
| Line 80: |
Line 65: |
|
| |
|
| ==== Parameters ==== | | ==== Parameters ==== |
| * '''hero_name''' - Name of the hero in english, or hero key. Preferred and recommended to use hero key, as its much more efficient. Search for the key in [[Data:HeroData.json]] | | * '''hero_name''' - Name of the hero, in english |
| * '''hero_var''' - Key of the hero's variable, see [[Data:HeroData.json]] | | * '''hero_var''' - Key of the hero's variable, see [[Data:HeroData.json]] |
| * '''number''' - Index to retrieve from the list. 1 for 1st element, 2 for 2nd element, etc. | | * '''number''' - Index to retrieve from the list. 1 for 1st element, 2 for 2nd element, etc. |
| Line 87: |
Line 72: |
| ==== Example ==== | | ==== Example ==== |
| From wikitext:<br> | | From wikitext:<br> |
| Using hero name in english
| |
| <pre>{{#invoke:HeroData|get_list_elem|Abrams|WeaponTypes|2}}</pre> | | <pre>{{#invoke:HeroData|get_list_elem|Abrams|WeaponTypes|2}}</pre> |
| {{#invoke:HeroData|get_list_elem|Abrams|WeaponTypes|2}} | | {{#invoke:HeroData|get_list_elem|Abrams|WeaponTypes|2}} |
|
| |
|
| |
| Using hero key
| |
| <pre>{{#invoke:HeroData|get_list_elem|hero_atlas|WeaponTypes|2}}</pre>
| |
| {{#invoke:HeroData|get_list_elem|hero_atlas|WeaponTypes|2}}
| |
|
| |
|
|
| |
|
| Line 100: |
Line 79: |
| {{#invoke:HeroData|get_list_elem|Abrams|WeaponTypes|2|true}} | | {{#invoke:HeroData|get_list_elem|Abrams|WeaponTypes|2|true}} |
|
| |
|
| | | === write_infobox === |
| === get_hero_scalar ===
| | Writes a [[Template:Infobox_hero]] template call for a given hero |
| Retrieve a hero variable's scalar value that is inside either "Spirit Scaling" or "Level Scaling", such as Abram's BulletDamage (scaling).
| |
| | |
| ====Parameters====
| |
| * '''hero_key''' - Key of the hero. Search for the key of a given hero in [[Data:HeroData.json]]
| |
| * '''scaling_type''' - "Spirit" or "Level"
| |
| * '''hero_var''' - Key of the hero's variable that is inside either "Spirit Scaling" or "Level Scaling", see [[Data:HeroData.json]]
| |
| * '''sig_figs_or_localize''' - OPTIONAL, # of sig figs to round to.
| |
| * '''no_template''' - OPTIONAL, return numerical value instead of scaling template. Has to be defined as "true"
| |
| | |
| ====Examples====
| |
| <pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage}}</pre>
| |
| {{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage}}
| |
| | |
| Round to 2 sig figs
| |
| <pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}</pre>
| |
| {{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}
| |
| | |
| No template
| |
| <pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2|no_template=true}}</pre>
| |
| {{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2|no_template=true}}
| |
| | |
| ====Notes====
| |
| If the scaling type or the stat key is not found in the hero's data, this function returns an empty string instead of an error message.
| |
| | |
| === hero_has_stat ===
| |
| Checks if a hero possesses a specific stat in their Base data, Level Scaling (Boons), or Spirit Scaling. Used primarily for conditionally hiding rows in infoboxes.
| |
| | |
| The base value is looked up in the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block, the same as get_hero_var. A stat counts as present when its base value is non-zero, or when it has any non-zero scaling.
| |
|
| |
|
| ====Parameters==== | | ====Parameters==== |
| * '''hero_key''' - Key of the hero. | | * '''hero_name''' – Name of the hero, in english |
| * '''stat_key''' - Key of the stat to check (e.g., BulletResist, TechResist).
| |
|
| |
|
| ====Example==== | | ====Example==== |
| <pre>{{#invoke:HeroData|hero_has_stat|hero_kelvin|TechResist}}</pre> | | From wikitext:<br> |
| {{#invoke:HeroData|hero_has_stat|hero_kelvin|TechResist}}
| | <pre>{{#invoke:HeroData|write_infobox|HERO_NAME}}</pre> |
| | |
| === get_hero_key ===
| |
| Returns the key of the specified hero's english name. A hero key may also be passed, in which case it is returned unchanged. Matching is case-insensitive. Returns "Hero not found." when the input matches no hero.
| |
| | |
| ====Parameters====
| |
| * '''hero_name''' - Name of the hero in english, or a hero key
| |
|
| |
|
| ====Example====
| | Which outputs |
| <pre>{{#invoke:HeroData|get_hero_key|Abrams}}</pre>
| | {{#invoke:HeroData|write_infobox|Abrams}} |
|
| |
|
| === resolve_key === | | === write_stat_infoboxes === |
| The same lookup as get_hero_key, but returns an empty string instead of "Hero not found." when the input matches no hero. Intended for templates that need to branch on whether the input names a hero at all.
| | Writes all 3 [[Template:Infobox_stat]] template calls (Weapon, Vitality, Spirit) for a given hero |
|
| |
|
| ====Parameters==== | | ====Parameters==== |
| * '''hero_name_or_key''' - Name of the hero in english, or a hero key | | * '''hero_name''' – Name of the hero, in english |
|
| |
|
| ====Example==== | | ====Example==== |
| <pre>{{#invoke:HeroData|resolve_key|Abrams}}</pre> | | From wikitext:<br> |
| {{#invoke:HeroData|resolve_key|Abrams}}
| | <pre>{{#invoke:HeroData|write_stat_infoboxes|HERO_NAME}}</pre> |
| | |
| === get_ability_key ===
| |
| Gets the ability key from a hero's bound ability slot
| |
| | |
| ====Parameters====
| |
| * '''hero_key''' - Key of the hero
| |
| * '''slot_number''' - Slot number (1-based index)
| |
|
| |
|
| ====Example====
| | Which outputs |
| <pre>{{#invoke:HeroData|get_ability_key|hero_atlas|1}}</pre>
| | {{#invoke:HeroData|write_stat_infoboxes|Abrams}} |
|
| |
|
| === get_hero_tag === | | === write_hero_comparison_table === |
| Retrieve a hero's description tags with [[Module:Lang]], to be used in [[Template:HeroRosterCard]] and [[Template:Infobox hero]]
| | Writes the [[Hero Comparison]] table for a specific Level and Spirit Power |
|
| |
|
| ====Parameters==== | | ====Parameters==== |
| * '''name''' - Name of the hero in english. This is normally referenced from the template parameters | | * '''level''' - Number of [[Level]]s / Power Increases |
| * '''number''' - Which tag to call (1, 2 or 3) | | * '''spirit_power''' - Amount of Spirit power |
| | |
| ====Example====
| |
| <pre>{{#invoke:HeroData|get_hero_tag|Abrams|1}}</pre>
| |
| | |
| === has_tags ===
| |
| Returns "true" when the hero has description tags, or an empty string otherwise. Intended for templates that need to hide a tag block entirely for heroes without tags.
| |
|
| |
|
| ====Parameters====
| | Both parameters are optional, as if both are 0 or not provided, the outputted table will be at base and will also include the level/SS scaling in each cell along with the base value, rather than the scaled value. |
| * '''name''' - Name of the hero in english
| |
|
| |
|
| ====Example==== | | ====Example==== |
| <pre>{{#invoke:HeroData|has_tags|Abrams}}</pre> | | From wikitext:<br> |
| {{#invoke:HeroData|has_tags|Abrams}}
| | <pre>{{#invoke:HeroData|write_hero_comparison_table|LEVEL|SPIRITPOWER}}</pre> |
|
| |
|
| === write_role_playstyle_quote ===
| | Which outputs |
| Writes a formatted role and playstyle quotation for a hero
| | {{#invoke:HeroData|write_hero_comparison_table|11|200}} |
| | |
| ====Parameters====
| |
| * '''hero_key''' - Key of the hero
| |
| | |
| ====Example====
| |
| <pre>{{#invoke:HeroData|write_role_playstyle_quote|hero_atlas}}</pre>
| |
| | |
| === write_default_items ===
| |
| Writes the recommended items list for a hero
| |
| | |
| ====Parameters====
| |
| * '''hero_key''' - Key of the hero (unlocalized)
| |
| | |
| ====Example====
| |
| <pre>{{#invoke:HeroData|write_default_items|hero_atlas}}</pre>
| |
| | |
| === write_ground_dash_buckets ===
| |
| Outputs a wikitable of heroes grouped by their GroundDashDuration using [[Template:HeroIcon]]
| |
| | |
| ====Example====
| |
| | |
| <pre>{{#invoke:HeroData|write_ground_dash_buckets}}</pre>
| |
| | |
| {{#invoke:HeroData|write_ground_dash_buckets}}
| |
|
| |
|
| == Localizable values == | | == Localizable values == |
| Localizable values as of writing this: | | Localizable values as of writing this: |
| * Hero names (via hero keys)
| |
| * Lore | | * Lore |
| * Playstyle | | * Playstyle |
| Line 225: |
Line 130: |
| * elements in WeaponTypes | | * elements in WeaponTypes |
| * elements in RecommendedItems | | * elements in RecommendedItems |
| * All stat labels and postfixes
| |
| * Ability descriptions and names
| |
| * Hero tags (1, 2, 3)
| |
|
| |
| == 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
| |
|
| |
| == Scaling System ==
| |
| The module supports two types of scaling:
| |
| * '''Spirit Scaling''' - Affects stats based on Spirit Power
| |
| * '''Level Scaling''' - Affects stats based on Power Increases/Levels/Boons
| |
