Module:Abilities/doc: Difference between revisionsGive feedback
Updated doc |
No edit summary |
||
| Line 7: | Line 7: | ||
== Examples == | == Examples == | ||
=== get_ability_name === | === get_ability_name === | ||
To get the display name of a hero's ability (numbered 1 to 4): | To get the localized display name of a hero's ability (numbered 1 to 4): | ||
<pre>{{#invoke:Abilities|get_ability_name|hero_atlas|1}}</pre> | <pre>{{#invoke:Abilities|get_ability_name|hero_atlas|1}}</pre> | ||
Returns: | Returns: | ||
<code>{{#invoke:Abilities|get_ability_name|hero_atlas|1}}</code> | <code>{{#invoke:Abilities|get_ability_name|hero_atlas|1}}</code> | ||
Function can be passed with <code>lang</code> parameter to override the current language to a specific language code. | |||
<pre>{{#invoke:Abilities|get_ability_name|hero_atlas|1|lang=ru}}</pre> | |||
Returns: | |||
<code>{{#invoke:Abilities|get_ability_name|hero_atlas|1|lang=ru}}</code> | |||
=== get_ability_prop === | === get_ability_prop === | ||
Revision as of 14:31, 6 March 2026
Overview
The Abilities module provides functions for retrieving data about hero abilities and their upgrades.
- The function
get_ability_namereferences Data:AbilityCards.json to link a hero and ability slot to an ability's display name. - The functions
get_ability_propandget_ability_upgrade_propreference Data:AbilityData.json to get specific stats from an ability's base data or its upgrades.
Examples
get_ability_name
To get the localized display name of a hero's ability (numbered 1 to 4):
{{#invoke:Abilities|get_ability_name|hero_atlas|1}}
Returns:
Siphon Life
Function can be passed with lang parameter to override the current language to a specific language code.
{{#invoke:Abilities|get_ability_name|hero_atlas|1|lang=ru}}
Returns:
Переливание жизни
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