ChampionSpell class
The representation of a champion's spell (ability).
Signature:
export declare class ChampionSpell
Constructor
new ChampionSpell (client: Client, champ: Champion, data: SpellData, damage: SpellDamageData)
Constructs a new instance of the ChampionSpell
class.
Parameters:
Parameter | Type | Description |
---|---|---|
client | Client | The client creating this instance. |
champ | Champion | The champion this spell belongs to. |
data | SpellData | The raw spell data from data dragon. |
damage | SpellDamageData | The raw spell data from community dragon. |
Properties
cooldown
The cooldown of this ability (in seconds).
If the cooldown scales with rank of the ability, will be of the format - r1/r2/r3...
Where r1
is the cooldown at rank 1, r2
is the cooldown at rank 2, and so on.
Type: String
cooldownByLevel
Numerical representation of the spell's cooldown. The array contains the cooldown sorted by ranks.
To get the cooldown at rank 3, you can use spell.cooldownByLevel[2]
.
Type: Number
cost
The cost of using this spell (contains the resource used/generated).
Type: String
costByLevel
The numerical representation of the spell's costs. The array contains the cost sorted by ranks.
To get the cost at rank 3, you can use spell.costByLevel[2]
.
Type: Number
costType
The resource needed to use the ability.
Type: String
description
A short textual description of the ability.
Type: String
icon
The URL to the icon of this ability.
Type: String
id
The ID of the spell.
Type: String
maxAmmo
The number of times this ability can be used. -1 indicates it has no ammo system.
Type: Number
maxRank
The max number of skill points (gained by leveling up the champion) that can be put into this spell.
Type: Number
name
The displayed name of the ability.
Type: String
rawTooltip
The raw tooltip of the champion spell. This is a more detailed description and contains the numbers of any effects and damage the spell applies.
The raw tooltip also contains some HTML-like tags such as <scaleAP>
to help style it better if you are making a website that needs to use this.
Type: String
tooltip
The tooltip of the champion spell. This is a more detailed description and contains the numbers of any effects and damage the spell applies.
The tooltip is cleaned off of any HTML-like tags to display text in a nicer format.
Type: String