Module:HeroData/doc: Difference between revisions

From Deadlock Wiki
Jump to navigation Jump to search
Sur (talk | contribs)
m documentation expanded greatly
Sur (talk | contribs)
m overview updated
Line 1: Line 1:
== Overview ==
== Overview ==


This module provides functions to create hero infoboxes or statboxes (and more miscellaneous items) using the data uploaded to [[Data:HeroData.json]].
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
Both will automatically be translated depending on the language selected. If called on

Revision as of 01:45, 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

  • Page - translates to english
  • Page/en - translates to english
  • Page/es - translates to spanish

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_boxes

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_boxes|HERO_NAME}}

Which outputs

Script error: The function "write_stat_boxes" does not exist.

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).