Editing Module:Abilities/docGive feedback

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

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

== Examples ==
=== get_ability_name ===
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>
Returns:
<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 ===
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>

=== 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>

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