Module:HeroData/doc: Difference between revisions

Sur (talk | contribs)
m write_stat_boxes > write_stat_infoboxes
Sur (talk | contribs)
m sig_figs example; spacing
Line 22: Line 22:


Which outputs
Which outputs
{{#invoke:HeroData|write_infobox|Abrams}}
{{#invoke:HeroData|write_infobox|Abrams}}


Line 36: Line 35:


Which outputs
Which outputs
{{#invoke:HeroData|write_stat_infoboxes|Abrams}}
=== 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]]
* '''sig_figs''' - OPTIONAL, # of sig figs to round to if retrieving a float
====Examples====
From wikitext<br>:
<pre>{{#invoke:HeroData|get_hero_var|Abrams|MaxHealth}}</pre>
{{#invoke:HeroData|get_hero_var|Abrams|MaxHealth}}
<pre>{{#invoke:HeroData|get_hero_var|Abrams|FalloffStartRange}}</pre>
{{#invoke:HeroData|get_hero_var|Abrams|FalloffStartRange}}


{{#invoke:HeroData|write_stat_infoboxes|Abrams}}
<pre>{{#invoke:HeroData|get_hero_var|Abrams|FalloffStartRange|2}}</pre>
{{#invoke:HeroData|get_hero_var|Abrams|FalloffStartRange|2}}
 
 
====Notes====
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.


=== get_localized_var ===
=== get_localized_var ===
Line 48: Line 73:
====Examples====
====Examples====
From wikitext:<br>
From wikitext:<br>
<pre>{{#invoke:HeroData|get_localized_var|Abrams|WeaponName}}</pre><br>
<pre>{{#invoke:HeroData|get_localized_var|Abrams|WeaponName}}</pre>
{{#invoke:HeroData|get_localized_var|Abrams|WeaponName}}
{{#invoke:HeroData|get_localized_var|Abrams|WeaponName}}


<pre>{{#invoke:HeroData|get_localized_var|Abrams|Role}}</pre><br>
 
<pre>{{#invoke:HeroData|get_localized_var|Abrams|Role}}</pre>
{{#invoke:HeroData|get_localized_var|Abrams|Role}}
{{#invoke:HeroData|get_localized_var|Abrams|Role}}


====Notes====
====Notes====
Line 64: Line 91:
* WeaponName
* WeaponName
* TODO each value in WeaponTypes
* 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<br>:
<pre>{{#invoke:HeroData|get_hero_var|Abrams|MaxHealth}}</pre><br>
{{#invoke:HeroData|get_hero_var|Abrams|MaxHealth}}
<pre>{{#invoke:HeroData|get_hero_var|Abrams|Stamina}}</pre><br>
{{#invoke:HeroData|get_hero_var|Abrams|Stamina}}
====Notes====
Only usable on variables that are integers, strings, or floats (meaning not dictionaries/hashes or arrays/lists).