Module:Abilities/doc: Difference between revisionsGive feedback

Browse history interactively

← Older edit Newer edit →

VisualWikitext

Revision as of 18:56, 13 November 2025

Overview

The Abilities module provides functions for retrieving data about hero abilities and their upgrades.

The function get_ability_name references Data:AbilityCards.json to link a hero and ability slot to an ability's display name.
The functions get_ability_prop and get_ability_upgrade_prop reference Data:AbilityData.json to get specific stats from an ability's base data or its upgrades.

Examples

get_ability_name

To get the display name of a hero's ability (numbered 1 to 4):

{{#invoke:Abilities|get_ability_name|hero_atlas|1}}

Returns: Siphon Life

get_ability_prop

To get a property from the base stats of an ability. You can use the ability's key (e.g., "ability_afterburn") or its proper name (e.g., "Afterburn").

{{#invoke:Abilities|get_ability_prop|Afterburn|BurnDuration}}

Returns: 3

get_ability_upgrade_prop

To get a property from a specific upgrade of an ability.

{{#invoke:Abilities|get_ability_upgrade_prop|Afterburn|3|DPS}}

This example gets the DPS value from the 3rd upgrade for the ability "Afterburn".

Returns:

Another example, getting the `DamageAmplificationPerStack` from the 2nd upgrade of "Marksman":

{{#invoke:Abilities|get_ability_upgrade_prop|Marksman|2|DamageAmplificationPerStack}}

Returns: Ability Not Found

Submodules

Abilities - Simple functions. Eg. getting ability name

Abilities/utils - Common internal functions that are shared amongst any Abilities/ modules

Abilities/card - Generates hero ability cards

Abilities/icon - Functions for retrieving ability and attribute icon data

Abilities/details table (WIP) - Generates details table to show raw ability data

@@ Line 1: / Line 1: @@
 == Overview ==
-'''Abilities''' module handles any simple functions that don't require a submodule.
+The '''Abilities''' module provides functions for retrieving data about hero abilities and their upgrades.
-The function <code>get_ability_name</code> and most of the submodules reference [[Data:AbilityCards.json]].
+* The function <code>get_ability_name</code> references [[Data:AbilityCards.json]] to link a hero and ability slot to an ability's display name.
+* The functions <code>get_ability_prop</code> and <code>get_ability_upgrade_prop</code> reference [[Data:AbilityData.json]] to get specific stats from an ability's base data or its upgrades.
-The function <code>get_ability_prop</code> references [[Data:AbilityData.json]].
 == Examples ==
-To get the name of a hero's ability (numbered 1 to 4):
+=== get_ability_name ===
+To get the display name of a hero's ability (numbered 1 to 4):
 <pre>{{#invoke:Abilities|get_ability_name|hero_atlas|1}}</pre>
 Returns:
 <code>{{#invoke:Abilities|get_ability_name|hero_atlas|1}}</code>
-To get a property of an ability (WIP):
+=== get_ability_prop ===
+To get a property from the base stats of an ability. You can use the ability's key (e.g., "ability_afterburn") or its proper name (e.g., "Afterburn").
+<pre>{{#invoke:Abilities|get_ability_prop|Afterburn|BurnDuration}}</pre>
+Returns:
+<code>{{#invoke:Abilities|get_ability_prop|Afterburn|BurnDuration}}</code>
-<pre>{{#invoke:Abilities|get_ability_prop|Siphon Life|AbilityCooldown}}</pre>
+=== get_ability_upgrade_prop ===
+To get a property from a specific ''upgrade'' of an ability.
+<pre>{{#invoke:Abilities|get_ability_upgrade_prop|Afterburn|3|DPS}}</pre>
+This example gets the <code>DPS</code> value from the 3rd upgrade for the ability "Afterburn".
 Returns:
+<code>{{#invoke:Abilities|get_ability_upgrade_prop|Afterburn|3|DPS}}</code>
-<code>{{#invoke:Abilities|get_ability_prop|Siphon Life|AbilityCooldown}}</code>
+Another example, getting the `DamageAmplificationPerStack` from the 2nd upgrade of "Marksman":
+<pre>{{#invoke:Abilities|get_ability_upgrade_prop|Marksman|2|DamageAmplificationPerStack}}</pre>
+Returns:
+<code>{{#invoke:Abilities|get_ability_upgrade_prop|Marksman|2|DamageAmplificationPerStack}}</code>
 {{Module:Abilities/doc/submodules}}