m
Move page script moved page API IsUsableSpell to WoW:API IsUsableSpell without leaving a redirect
m (Correction for function input.) |
m (Move page script moved page API IsUsableSpell to WoW:API IsUsableSpell without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} | {{wowapi}} | ||
Determines whether a spell can be used by the player character. | |||
usable, nomana = IsUsableSpell("spellName" or spellID or spellIndex[, "bookType"]); | |||
; | |||
:;'' | ==Arguments== | ||
;spellName : String: name of the spell to check. | |||
;spellIndex : Number: index of a spell in the player's (or pet's) spellbook. | |||
;spellID : Number: SpellID of a spell to check. | |||
;bookType: String: does the spellIndex refer to the player's spellbook (BOOKTYPE_SPELL constant, default), or the pet's spellbook (BOOKTYPE_PET constant). | |||
==Returns== | |||
;usable :Boolean : 1 (true) if the spell is usable, nil otherwise. A spell is not usable if any of the following conditions apply: | |||
;usable | :* The player hasn't learned the spell | ||
: | :* The player lacks required mana or reagents. | ||
;nomana | :* Reactive conditions haven't been met. | ||
: | ;nomana : Boolean : 1 (true) if the spell can not be cast due to low mana, nil otherwise. | ||
==Example== | |||
usable, nomana = IsUsableSpell("Curse of Elements"); | |||
usable, nomana = IsUsableSpell("Curse of Elements") | |||
if (not usable) then | if (not usable) then | ||
if (not nomana) then | if (not nomana) then | ||
message("The spell | message("The spell cannot be cast"); | ||
else | else | ||
message("You do not have enough mana to cast the spell"); | message("You do not have enough mana to cast the spell"); | ||
| Line 28: | Line 30: | ||
end | end | ||
usable, nomana = IsUsableSpell(20, BOOKTYPE_SPELL); | |||
; | print(GetSpellName(20, BOOKTYPE_SPELL) .. " is " .. (usable and "" or "not ") .. " usable."); | ||