C_SpellBook.
functionimplementedavailable in: camelot
Returns the cooldown info of a spell.
function C_SpellBook.GetSpellBookItemCooldown( spellBookItemSlotIndex: number, spellBookItemSpellBank: SpellBookSpellBank): SpellCooldownInfo?Parameters
| name | type | description |
|---|---|---|
spellBookItemSlotIndex | number | Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages |
spellBookItemSpellBank | SpellBookSpellBank |
Returns
spellCooldownInfo · SpellCooldownInfo? · Returns nil if item doesn't exist or if this kind of item doesn't display cooldowns (ex: future or offspec spells)
| field | type | description |
|---|---|---|
startTime | number | If cooldown is active, time started; 0 if no cooldown; Current time if isEnabled is false |
duration | number | Cooldown duration in seconds if active; 0 if cooldown is inactive |
isEnabled | boolean | False if cooldown is on hold (ex: some cooldowns only start after an active spell is cancelled); True otherwise |
isActive | boolean | False if cooldown is not active (ex: not enabled, or startTime or duration are 0); True otherwise |
modRate | number | Rate at which cooldown UI should update |
activeCategory | number? | Indicates which category is responsible for determining the duration. A nil value indicates the duration was determined through some other logic, e.g. the spell is on hold. |
timeUntilEndOfStartRecovery | number? | When this is set it indicates that the spell is in recovery and this is how long it will be until that recovery period is finished |
isOnGCD | boolean? | Whether or not this spell is considered to be on the global cooldown, do not trust this field unless responding to a SPELL_UPDATE_COOLDOWN event |
Blizzard's documentation says it may return nothing.
In wowlua's emulated client
implementedwowlua models the system behind it. what the statuses mean
Restrictions
sources
Signature and flags: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (SpellBook system, camelot 1.60.1). Description: warcraft.wiki.gg's API pages ↗, by its contributors, CC BY-SA 4.0 ↗.