Module:HeroData/doc: Difference between revisions
m overview updated |
m write_stat_boxes > write_stat_infoboxes |
||
| Line 25: | Line 25: | ||
{{#invoke:HeroData|write_infobox|Abrams}} | {{#invoke:HeroData|write_infobox|Abrams}} | ||
=== | === write_stat_infoboxes === | ||
Writes all 3 [[Template:StatBox]] template calls (Weapon, Vitality, Spirit) for a given hero | Writes all 3 [[Template:StatBox]] template calls (Weapon, Vitality, Spirit) for a given hero | ||
| Line 33: | Line 33: | ||
====Example==== | ====Example==== | ||
From wikitext:<br> | From wikitext:<br> | ||
<pre>{{#invoke:HeroData| | <pre>{{#invoke:HeroData|write_stat_infoboxes|HERO_NAME}}</pre> | ||
Which outputs | Which outputs | ||
{{#invoke:HeroData| | {{#invoke:HeroData|write_stat_infoboxes|Abrams}} | ||
=== get_localized_var === | === get_localized_var === | ||
Revision as of 02:05, 22 September 2024
Overview
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
write_infobox
Writes a Template:Infobox_hero template call for a given hero
Parameters
- hero_name – Name of the hero, in english
Example
From wikitext:
{{#invoke:HeroData|write_infobox|HERO_NAME}}
Which outputs
Hero Abrams Not Found
write_stat_infoboxes
Writes all 3 Template:StatBox template calls (Weapon, Vitality, Spirit) for a given hero
Parameters
- hero_name – Name of the hero, in english
Example
From wikitext:
{{#invoke:HeroData|write_stat_infoboxes|HERO_NAME}}
Which outputs
Hero Not Found
get_localized_var
Get a hero's stat, then localize it
Parameters
- hero_name - Name of the hero, in english
- hero_var - Key of the hero's variable, see Data:HeroData.json
Examples
From wikitext:
{{#invoke:HeroData|get_localized_var|Abrams|WeaponName}}
Script error: The function "get_localized_var" does not exist.
{{#invoke:HeroData|get_localized_var|Abrams|Role}}
Script error: The function "get_localized_var" does not exist.
Notes
Only usable on variables that can be localized. 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).
As of writing this (not exhaustive), localizable variables include:
- Lore
- Playstyle
- Role
- WeaponDescription
- WeaponName
- TODO each value in WeaponTypes
get_hero_var
Retrieve a hero variable's value, such as Abram's MaxHealth
Parameters
- hero_name - Name of the hero, in english
- hero_var - Key of the hero's variable, see Data:HeroData.json
Examples
From wikitext
:
{{#invoke:HeroData|get_hero_var|Abrams|MaxHealth}}
570
{{#invoke:HeroData|get_hero_var|Abrams|Stamina}}
3
Notes
Only usable on variables that are integers, strings, or floats (meaning not dictionaries/hashes or arrays/lists).