Module:Abilities/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
m use subpage to share submodules doc
No edit summary
Line 1: Line 1:
== Overview ==
== Overview ==
'''Abilities''' module handles any simple functions that don't require a submodule
'''Abilities''' module handles any simple functions that don't require a submodule.
 
The function <code>get_ability_name</code> and most of the submodules reference [[Data:AbilityCards.json]].
 
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):
 
<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):
 
<pre>{{#invoke:Abilities|get_ability_prop|Siphon Life|AbilityCooldown}}</pre>
 
Returns:
 
<code>{{#invoke:Abilities|get_ability_prop|Siphon Life|AbilityCooldown}}</code>
 
{{Module:Abilities/doc/submodules}}
{{Module:Abilities/doc/submodules}}

Revision as of 18:40, 30 April 2025

Overview

Abilities module handles any simple functions that don't require a submodule.

The function get_ability_name and most of the submodules reference Data:AbilityCards.json.

The function get_ability_prop references Data:AbilityData.json.

Examples

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

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

Returns:

Siphon Life

To get a property of an ability (WIP):

{{#invoke:Abilities|get_ability_prop|Siphon Life|AbilityCooldown}}

Returns:

42

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