Module:Abilities/doc: Difference between revisions

Jump to navigation Jump to search
Browse history interactively
← Older editNewer edit →

LVL (talk | contribs)

3 user groups
4,834 edits
undo
VisualWikitext
No edit summary
LVL (talk | contribs)
Contributors, Interface administrators, Moderators
4,834 edits
Updated doc
Line 1: Line 1:
== Overview ==
== 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 ==
== 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>
<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>


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:
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}}
{{Module:Abilities/doc/submodules}}
Retrieved from "https://deadlock.wiki/Module:Abilities/doc"