Module:HeroData/doc - Revision history

Vergir: Document resolve_key, has_tags and the shared Lua helpers; drop removed get_similar_items; mark get_hero_scaling_data deprecated (with help from vergir-bot LLM)

2026-08-11T13:36:32Z

Document resolve_key, has_tags and the shared Lua helpers; drop removed get_similar_items; mark get_hero_scaling_data deprecated (with help from vergir-bot LLM)

@@ Line 128: / Line 128: @@
 === hero_has_stat ===
 Checks if a hero possesses a specific stat in their Base data, Level Scaling (Boons), or Spirit Scaling. Used primarily for conditionally hiding rows in infoboxes.
 ====Parameters====
@@ Line 138: / Line 140: @@
 === get_hero_key ===
-Returns the key of the specified hero's english name
+Returns the key of the specified hero's english name. A hero key may also be passed, in which case it is returned unchanged. Matching is case-insensitive. Returns "Hero not found." when the input matches no hero.
 ====Parameters====
-* '''hero_name''' - Name of the hero in english
+* '''hero_name''' - Name of the hero in english, or a hero key
 ====Example====
 <pre>{{#invoke:HeroData|get_hero_key|Abrams}}</pre>
 === get_ability_key ===
@@ Line 165: / Line 177: @@
 ====Example====
 <pre>{{#invoke:HeroData|get_hero_tag|Abrams|1}}</pre>
 === write_role_playstyle_quote ===
@@ Line 208: / Line 230: @@
 == Internal Utility Functions ==
-The following functions are primarily for internal use but may be useful for advanced users:
+The following functions are called directly from Lua by other modules, not from wikitext:
 === get_json_item ===
@@ Line 216: / Line 238: @@
 * '''name''' - Name of the hero in english
-=== get_similar_items ===
+=== get_stat ===
-Returns an array of hero tables that have a specified property
+Returns the value of a stat, checking the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block. Returns nil when the hero has no such stat. This is the shared lookup behind get_hero_var, get_list_elem and hero_has_stat.
 ====Parameters====
-* '''property''' - Property key to search for
+* '''hero_data''' - Hero table
 == Scaling System ==

Gammaton32: /* get_hero_scalar */

2026-06-08T07:29:58Z

get_hero_scalar

← Older revision		Revision as of 07:29, 8 June 2026
Line 109:		Line 109:
	* '''hero_var''' - Key of the hero's variable that is inside either "Spirit Scaling" or "Level Scaling", see [[Data:HeroData.json]]		* '''hero_var''' - Key of the hero's variable that is inside either "Spirit Scaling" or "Level Scaling", see [[Data:HeroData.json]]
	* '''sig_figs_or_localize''' - OPTIONAL, # of sig figs to round to.		* '''sig_figs_or_localize''' - OPTIONAL, # of sig figs to round to.
			* '''no_template''' - OPTIONAL, return numerical value instead of scaling template. Has to be defined as "true"

	====Examples====		====Examples====
Line 117:		Line 118:
	<pre>{{#invoke:HeroData\|get_hero_scalar\|hero_atlas\|Level\|BulletDamage\|2}}</pre>		<pre>{{#invoke:HeroData\|get_hero_scalar\|hero_atlas\|Level\|BulletDamage\|2}}</pre>
	{{#invoke:HeroData\|get_hero_scalar\|hero_atlas\|Level\|BulletDamage\|2}}		{{#invoke:HeroData\|get_hero_scalar\|hero_atlas\|Level\|BulletDamage\|2}}

			No template
			<pre>{{#invoke:HeroData\|get_hero_scalar\|hero_atlas\|Level\|BulletDamage\|2\|no_template=true}}</pre>
			{{#invoke:HeroData\|get_hero_scalar\|hero_atlas\|Level\|BulletDamage\|2\|no_template=true}}

	====Notes====		====Notes====

Gammaton32: /* Functions */ removed hero comparison table

2026-05-14T21:41:27Z

Functions: removed hero comparison table

@@ Line 160: / Line 160: @@
 ====Example====
 <pre>{{#invoke:HeroData|get_hero_tag|Abrams|1}}</pre>
 === write_role_playstyle_quote ===

Gammaton32: /* get_alt_fire_var */

2026-04-22T01:48:38Z

get_alt_fire_var

← Older revision		Revision as of 01:48, 22 April 2026
Line 69:		Line 69:

	=== get_alt_fire_var ===		=== get_alt_fire_var ===
	Retrieve a hero's variable's from "AltFire" table. Works the same as get_hero_var		Retrieve a hero's variable's value from "AltFire" table. Works the same as get_hero_var

	====Examples====		====Examples====

Gammaton32: get_alt_fire_var

2026-04-22T01:45:46Z

get_alt_fire_var

← Older revision		Revision as of 01:45, 22 April 2026
Line 67:		Line 67:

	This function will automatically search for the variable in the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block.		This function will automatically search for the variable in the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block.

			=== get_alt_fire_var ===
			Retrieve a hero's variable's from "AltFire" table. Works the same as get_hero_var

			====Examples====

			<pre>{{#invoke:HeroData\|get_alt_fire_var\|Viscous\|BulletDamage}}</pre>
			{{#invoke:HeroData\|get_alt_fire_var\|Viscous\|BulletDamage}}

	=== get_list_elem ===		=== get_list_elem ===

LVL: Removed documentation for deleted functions write_infobox and write_stat_infoboxes

2026-04-10T16:36:15Z

Removed documentation for deleted functions write_infobox and write_stat_infoboxes

@@ Line 152: / Line 152: @@
 ====Example====
 <pre>{{#invoke:HeroData|get_hero_tag|Abrams|1}}</pre>
 === write_hero_comparison_table ===

Gammaton32: removed HeroData/Name

2026-03-11T16:12:10Z

removed HeroData/Name

← Older revision		Revision as of 16:12, 11 March 2026
Line 2:		Line 2:
	* [[Module:HeroData/nav]] - For nav box purposes		* [[Module:HeroData/nav]] - For nav box purposes
	* [[Module:HeroData/release]] - For determining the release status of a hero		* [[Module:HeroData/release]] - For determining the release status of a hero
	* [[Module:HeroData/name]] - For determining translation key using hero name
	* [[Module:HeroDataArrays]] - For tables in stat pages		* [[Module:HeroDataArrays]] - For tables in stat pages

LVL: Updated doc

2026-01-30T23:31:47Z

Updated doc

@@ Line 66: / Line 66: @@
 If using localize parameter, ensure the value is a string. 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).
 === get_list_elem ===
@@ Line 108: / Line 110: @@
 <pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}</pre>
 {{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}
 === get_hero_key ===

Monster Domosed: added write_ground_dash_buckets docs

2026-01-21T22:30:14Z

added write_ground_dash_buckets docs

← Older revision		Revision as of 22:30, 21 January 2026
Line 198:		Line 198:
	====Example====		====Example====
	<pre>{{#invoke:HeroData\|write_default_items\|hero_atlas}}</pre>		<pre>{{#invoke:HeroData\|write_default_items\|hero_atlas}}</pre>

			=== write_ground_dash_buckets ===
			Outputs a wikitable of heroes grouped by their GroundDashDuration using [[Template:HeroIcon]]

			====Example====

			<pre>{{#invoke:HeroData\|write_ground_dash_buckets}}</pre>

			{{#invoke:HeroData\|write_ground_dash_buckets}}

	== Localizable values ==		== Localizable values ==

LVL: Added missing functions and expanded localizable values

2025-10-13T14:32:11Z

Added missing functions and expanded localizable values

@@ Line 108: / Line 108: @@
 <pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}</pre>
 {{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}
 === write_infobox ===
@@ Line 152: / Line 181: @@
 {{#invoke:HeroData|write_hero_comparison_table|11|200}}
-=== get_hero_tag ===
+=== write_role_playstyle_quote ===
-Retrieve a hero's description tags with [[Module:Lang]], to be used in [[Template:HeroRosterCard]] and [[Template:Infobox hero]]
+Writes a formatted role and playstyle quotation for a hero
 ====Parameters====
-* '''name''' - Name of the hero in english. This is normally referenced from the template parameters
+* '''hero_key''' - Key of the hero (unlocalized)
-* '''number''' - Which tag to call (1, 2 or 3)
 == Localizable values ==
 Localizable values as of writing this:
 * Lore
 * Playstyle
@@ Line 168: / Line 209: @@
 * elements in WeaponTypes
 * elements in RecommendedItems