Module:HeroData/doc: Difference between revisions

Jump to navigation Jump to search
Browse history interactively
Newer edit →

Sur (talk | contribs)

1 user group
2,147 edits
undo
VisualWikitext
Sur (talk | contribs)
Moderators
2,147 edits
initial
 
Sur (talk | contribs)
Moderators
2,147 edits
m documentation expanded greatly
Line 1: Line 1:
== Overview ==
== Overview ==


This module provides functions to create hero infoboxes or statboxes (and more miscellaneous items).
This module provides functions to create hero infoboxes or statboxes (and more miscellaneous items) using the data uploaded to [[Data:HeroData.json]].


Both will automatically be translated depending on the language selected. If called on
Both will automatically be translated depending on the language selected. If called on
Line 9: Line 9:
See [[Template:Lang]] for more
See [[Template:Lang]] for more


=== Functions ===
== Functions ==


* '''write_infobox''' – Writes a [[Template:Infobox_hero]] template call for a given hero
=== write_infobox ===
* '''write_stat_boxes''' – Writes all 3 [[Template:StatBox]] template calls (Weapon, Vitality, Spirit) for a given hero
Writes a [[Template:Infobox_hero]] template call for a given hero


=== Parameters ===
====Parameters====
Both functions use one parameter.
* '''hero_name''' – Name of the hero, in english
* '''hero_name''' – Name of the hero, in english


=== Examples ===
====Example====
From wikitext:<br>
<pre>{{#invoke:HeroData|write_infobox|HERO_NAME}}</pre>
 
Which outputs
 
{{#invoke:HeroData|write_infobox|Abrams}}
 
=== write_stat_boxes ===
Writes all 3 [[Template:StatBox]] template calls (Weapon, Vitality, Spirit) for a given hero


To use this module from wikitext, use
====Parameters====
* '''hero_name''' – Name of the hero, in english


====Example====
From wikitext:<br>
<pre>{{#invoke:HeroData|write_stat_boxes|HERO_NAME}}</pre>
<pre>{{#invoke:HeroData|write_stat_boxes|HERO_NAME}}</pre>


Which outputs
Which outputs


{{#invoke:HeroData|write_infobox|Abrams}}
{{#invoke:HeroData|write_stat_boxes|Abrams}}
 
=== 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:<br>
<pre>{{#invoke:HeroData|get_localized_var|Abrams|WeaponName}}</pre><br>
{{#invoke:HeroData|get_localized_var|Abrams|WeaponName}}
 
<pre>{{#invoke:HeroData|get_localized_var|Abrams|Role}}</pre><br>
{{#invoke:HeroData|get_localized_var|Abrams|Role}}
 
====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


<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
====Parameters====
or
* '''hero_name''' - Name of the hero, in english
* '''hero_var''' - Key of the hero's variable, see [[Data:HeroData.json]]


<pre>{{#invoke:HeroData|write_infobox|HERO_NAME}}</pre>
====Examples====
From wikitext<br>:
<pre>{{#invoke:HeroData|get_hero_var|Abrams|MaxHealth}}</pre><br>
{{#invoke:HeroData|get_hero_var|Abrams|MaxHealth}}


Which outputs
<pre>{{#invoke:HeroData|get_hero_var|Abrams|Stamina}}</pre><br>
{{#invoke:HeroData|get_hero_var|Abrams|Stamina}}


{{#invoke:HeroData|write_stat_boxes|Abrams}}
====Notes====
Only usable on variables that are integers, strings, or floats (meaning not dictionaries/hashes or arrays/lists).
Retrieved from "https://deadlock.wiki/Module:HeroData/doc"