Module:HeroData/doc
This is the documentation page for Module:HeroData
Overview edit
This module provides functions to create hero infoboxes, statboxes, or retrieve hero information using the data uploaded to Data:HeroData.json.
Both will automatically be translated depending on the language selected. If called on
See Template:Lang for more
Functions edit
write_infobox edit
Writes a Template:Infobox_hero template call for a given hero
Parameters edit
- hero_name – Name of the hero, in english
Example edit
From wikitext:
{{#invoke:HeroData|write_infobox|HERO_NAME}}
Which outputs
“Charges into close combat
Abrams has the bulk and sustain to lead from the front, often running into the middle of his foes and watching them scatter. If his enemies waste their fire on him, his backline teammates can lay out damage with impunity.
write_stat_infoboxes edit
Writes all 3 Template:StatBox template calls (Weapon, Vitality, Spirit) for a given hero
Parameters edit
- hero_name – Name of the hero, in english
Example edit
From wikitext:
{{#invoke:HeroData|write_stat_infoboxes|HERO_NAME}}
Which outputs
get_hero_var edit
Retrieve a hero variable's value, such as Abram's MaxHealth
Parameters edit
- hero_name - Name of the hero, in english
- 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.
Examples edit
From wikitext:
{{#invoke:HeroData|get_hero_var|Abrams|MaxHealth}}
600
{{#invoke:HeroData|get_hero_var|Abrams|FalloffStartRange}}
21.9964
{{#invoke:HeroData|get_hero_var|Abrams|FalloffStartRange|2}}
22
{{#invoke:HeroData|get_hero_var|Abrams|Role|true}}
Charges into close combat
{{#invoke:HeroData|get_hero_var|Abrams|WeaponName|true}}
Case Closed
Notes edit
Only usable on variables that are integers, strings, or floats (meaning not dictionaries/hashes or arrays/lists).
If using sig_figs parameter, ensure the value is a float.
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).
get_list_elem edit
Retrieve a specified element from a list
Parameters edit
- hero_name - Name of the hero, in english
- 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.
- localize - OPTIONAL - "true" if its a string that should be localized. See Localizable values section.
Example edit
From wikitext:
{{#invoke:HeroData|get_list_elem|Abrams|WeaponTypes|2}}
Attribute_EWeaponAttribute_CloseRange
{{#invoke:HeroData|get_list_elem|Abrams|WeaponTypes|2|true}}
Close Range
Localizable values edit
Localizable values as of writing this:
- Lore
- Playstyle
- Role
- WeaponDescription
- WeaponName
- elements in WeaponTypes