Module:HeroData/doc

From Deadlock Wiki
Revision as of 22:51, 21 September 2024 by Sur (talk | contribs) (initial)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is the documentation page for Module:HeroData

Overview

This module provides functions to create hero infoboxes or statboxes (and more miscellaneous items).

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
  • write_stat_boxes – Writes all 3 Template:StatBox template calls (Weapon, Vitality, Spirit) for a given hero

Parameters

Both functions use one parameter.

  • hero_name – Name of the hero, in english

Examples

To use this module from wikitext, use

{{#invoke:HeroData|write_stat_boxes|HERO_NAME}}

Which outputs

Hero Abrams Not Found
























or

{{#invoke:HeroData|write_infobox|HERO_NAME}}

Which outputs

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