WoW:API IsUsableSpell - Revision history

Move page script: Move page script moved page API IsUsableSpell to WoW:API IsUsableSpell without leaving a redirect

2023-08-15T04:46:47Z

Move page script moved page API IsUsableSpell to API IsUsableSpell without leaving a redirect

← Older revision	Revision as of 04:46, 15 August 2023
(No difference)

WoWWiki>Ning7112000 at 02:19, 14 October 2010

2010-10-14T02:19:51Z

← Older revision		Revision as of 02:19, 14 October 2010
Line 3:		Line 3:
	Determines whether a spell can be used by the player character.		Determines whether a spell can be used by the player character.

	usable, nomana = IsUsableSpell("spellName" or spellIndex[, "bookType"]);		usable, nomana = IsUsableSpell("spellName" or spellID or spellIndex[, "bookType"]);

	==Arguments==		==Arguments==
	;spellName : String: name of the spell to check.		;spellName : String: name of the spell to check.
	;spellIndex : Number: index of a spell in the player's (or pet's) spellbook.		;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).		;bookType: String: does the spellIndex refer to the player's spellbook (BOOKTYPE_SPELL constant, default), or the pet's spellbook (BOOKTYPE_PET constant).

WoWWiki>Harkathmaker: /* Example */

2010-01-17T09:43:15Z

Example

← Older revision		Revision as of 09:43, 17 January 2010
Line 21:		Line 21:
	if (not usable) then		if (not usable) then
	if (not nomana) then		if (not nomana) then
	message("The spell ~~can not~~ be cast");		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");

WoWWiki>Starlightblunder: /* Returns */ language

2009-02-08T18:44:43Z

Returns: language

← Older revision		Revision as of 18:44, 8 February 2009
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}

	~~usable, nomana = IsUsableSpell(SPELL);~~		Determines whether a spell can be used by the player character.

	~~----~~		usable, nomana = IsUsableSpell("spellName" or spellIndex[, "bookType"]);
	;~~''Arguments''~~

	:;''~~SPELL~~'' ~~: A spell name. Don't try to use a spellID~~.		==Arguments==
			;spellName : String: name of the spell to check.
			;spellIndex : Number: index of a spell in the player's (or pet's) spellbook.
			;bookType: String: does the spellIndex refer to the player's spellbook (BOOKTYPE_SPELL constant, default), or the pet's spellbook (BOOKTYPE_PET constant).

	~~----~~		==Returns==
	~~;''~~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
	:;Boolean : 1 (true) if the spell is usable, nil otherwise.		:* The player lacks required mana or reagents.
	;nomana		:* Reactive conditions haven't been met.
	:;Boolean : 1 (true) if the spell can not be cast due to low mana, nil otherwise.		;nomana : Boolean : 1 (true) if the spell can not be cast due to low mana, nil otherwise.

	~~----~~		==Example==
	~~;''~~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
Line 28:		Line 29:
	end		end

	~~----~~		usable, nomana = IsUsableSpell(20, BOOKTYPE_SPELL);
	;~~''Conditions for Failure''~~		print(GetSpellName(20, BOOKTYPE_SPELL) .. " is " .. (usable and "" or "not ") .. " usable.");
	* Spell is not ~~in spellbook~~
	* Not enough mana to cast spell
	* Reagents required for spell do not exist in bags
	* Reactive skill conditions have not been met

WoWWiki>Xelepart: Correction for function input.

2007-02-20T22:44:43Z

Correction for function input.

← Older revision		Revision as of 22:44, 20 February 2007
Line 6:		Line 6:
	;''Arguments''		;''Arguments''

	:;''SPELL'' : A spell name ~~or SpellID~~		:;''SPELL'' : A spell name. Don't try to use a spellID.

	----		----

WoWWiki>Malakar: Added failure condition

2007-01-06T13:27:08Z

Added failure condition

← Older revision		Revision as of 13:27, 6 January 2007
Line 33:		Line 33:
	* Not enough mana to cast spell		* Not enough mana to cast spell
	* Reagents required for spell do not exist in bags		* Reagents required for spell do not exist in bags
			* Reactive skill conditions have not been met

WoWWiki>Alshain at 21:55, 30 December 2006

2006-12-30T21:55:35Z

New page

{{wowapi}}

usable, nomana = IsUsableSpell(SPELL);

----
;''Arguments''

:;''SPELL'' : A spell name or SpellID

----
;''Returns''
;usable
:;Boolean : 1 (true) if the spell is usable, nil otherwise.
;nomana
:;Boolean : 1 (true) if the spell can not be cast due to low mana, nil otherwise.

----
;''Example''
usable, nomana = IsUsableSpell("Curse of Elements")
if (not usable) then
if (not nomana) then
message("The spell can not be cast");
else
message("You do not have enough mana to cast the spell");
end
else
message("The spell may be cast");
end

----
;''Conditions for Failure''
* Spell is not in spellbook
* Not enough mana to cast spell
* Reagents required for spell do not exist in bags