Module:Abilities/doc - Revision history

LVL: Updated doc

2026-04-03T20:24:23Z

Updated doc

← Older revision		Revision as of 20:24, 3 April 2026
Line 23:		Line 23:
	Returns:		Returns:
	<code>{{#invoke:Abilities\|get_ability_prop\|Afterburn\|BurnDuration}}</code>		<code>{{#invoke:Abilities\|get_ability_prop\|Afterburn\|BurnDuration}}</code>

			You can also retrieve nested properties by using dot notation to drill down into the data structure. For example, to get a value nested inside a <code>Scale</code> table:
			<pre>{{#invoke:Abilities\|get_ability_prop\|Lycan Curse\|MaxRage.Scale.Value}}</pre>
			Returns:
			<code>{{#invoke:Abilities\|get_ability_prop\|Lycan Curse\|MaxRage.Scale.Value}}</code>

	=== get_ability_upgrade_prop ===		=== get_ability_upgrade_prop ===

Monster Domosed at 14:31, 6 March 2026

2026-03-06T14:31:04Z

← Older revision		Revision as of 14:31, 6 March 2026
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 ===

LVL: Updated doc

2025-11-13T18:56:07Z

Updated doc

← Older revision		Revision as of 18:56, 13 November 2025
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}}

Gammaton32 at 18:40, 30 April 2025

2025-04-30T18:40:00Z

@@ Line 1: / Line 1: @@
 == 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.
 {{Module:Abilities/doc/submodules}}

Saag: use subpage to share submodules doc

2024-10-26T17:47:00Z

use subpage to share submodules doc

@@ Line 1: / Line 1: @@
 == Overview ==
 '''Abilities''' module handles any simple functions that don't require a submodule
+{{Module:Abilities/doc/submodules}}

Saag: /* Overview */

2024-10-26T17:43:23Z

Overview

← Older revision		Revision as of 17:43, 26 October 2024
Line 5:		Line 5:
	[[Module:Abilities\|'''Abilities''']] - Simple functions. Eg. getting ability name		[[Module:Abilities\|'''Abilities''']] - Simple functions. Eg. getting ability name

	[[Module:Abilities/utils\|'''Abilities/utils''']] - Common internal functions that are shared amongst any Abilities/ modules		[[Module:Abilities/utils\|'''Abilities/utils''']] - Common internal functions that are shared amongst any '''Abilities/''' modules

	[[Module:Abilities/card\|'''Abilities/card''']] - Generates hero ability cards		[[Module:Abilities/card\|'''Abilities/card''']] - Generates hero ability cards

Saag: /* Overview */

2024-10-26T17:28:12Z

Overview

← Older revision		Revision as of 17:28, 26 October 2024
Line 1:		Line 1:
	== Overview ==		== Overview ==
	Abilities module ~~will cover~~ any ~~scripting~~ that ~~relates to hero abilities.~~		'''Abilities''' module handles any simple functions that don't require a submodule

	=== Submodules ===		=== Submodules ===

Saag at 17:23, 26 October 2024

2024-10-26T17:23:48Z

← Older revision		Revision as of 17:23, 26 October 2024
Line 3:		Line 3:

	=== Submodules ===		=== Submodules ===
			[[Module:Abilities\|'''Abilities''']] - Simple functions. Eg. getting ability name

	[[Module:Abilities/utils\|'''Abilities/utils''']] - Common internal functions that are shared amongst any Abilities/ modules		[[Module:Abilities/utils\|'''Abilities/utils''']] - Common internal functions that are shared amongst any Abilities/ modules

Saag at 17:22, 26 October 2024

2024-10-26T17:22:45Z

← Older revision		Revision as of 17:22, 26 October 2024
Line 1:		Line 1:
	== Overview ==		== Overview ==
	Abilities module will cover any scripting that relates to hero abilities.		Abilities module will cover any scripting that relates to hero abilities.


	=== Submodules ===		=== Submodules ===

Saag: Simplified directory

2024-10-26T17:22:37Z

Simplified directory

← Older revision		Revision as of 17:22, 26 October 2024
Line 3:		Line 3:


	== ~~Modules~~ ==		=== Submodules ===
	=== [[Module:Abilities/utils\|Abilities/utils]] ~~===~~		[[Module:Abilities/utils\|'''Abilities/utils''']] - Common internal functions that are shared amongst any Abilities/ modules
	Common functions that are shared amongst any Abilities/ modules

			[[Module:Abilities/card\|'''Abilities/card''']] - Generates hero ability cards

	~~===~~ [[Module:Abilities/~~card~~\|Abilities/~~card~~]] ~~===~~		[[Module:Abilities/icon\|'''Abilities/icon''']] - Searches for an icon based on the (English) name of the ability
	~~Generates hero~~ ability ~~cards~~
	~~==== Usage ====~~
	~~[[Template:Ability card v2]]~~

			[[Module:Abilities/details_table\|'''Abilities/details table''']] (WIP) - Generates details table to show raw ability data
	~~=== [[Module:Abilities/icon\|Abilities/icon]] ===~~
	~~Searches for an icon based on the (English) name of the ability~~
	~~==== Usage ====~~
	~~[[Template:AbilityIcon]]~~


	~~===~~ [[Module:Abilities/details_table\|Abilities/details table]] (WIP) ~~===~~
	Generates details table to show raw ability data
	~~==== Usage ====~~
	~~[[Template:Ability card v2/Details]]~~

← Older revision		Revision as of 17:43, 26 October 2024
Line 5:		Line 5:
	[[Module:Abilities\|'''Abilities''']] - Simple functions. Eg. getting ability name		[[Module:Abilities\|'''Abilities''']] - Simple functions. Eg. getting ability name

	[[Module:Abilities/utils\|'''Abilities/utils''']] - Common internal functions that are shared amongst any Abilities/ modules		[[Module:Abilities/utils\|'''Abilities/utils''']] - Common internal functions that are shared amongst any '''Abilities/''' modules

	[[Module:Abilities/card\|'''Abilities/card''']] - Generates hero ability cards		[[Module:Abilities/card\|'''Abilities/card''']] - Generates hero ability cards