WoW:API CastSpell: Difference between revisions

WoW:API CastSpell (source)

Revision as of 11:19, 16 December 2006

357 bytes removed , 16 December 2006

no edit summary

Anonymous user

WoWWiki>Starlightblunder

@@ Line 1: / Line 1: @@
-Casts spell under spellbookType with ID spellID.
+{{wowapi}}
+{{protectedapi|2.0.1|For alternatives, try [[API_SecureTemplates|Secure Templates]] or the new [[Conditional slash commands#/cast|/cast]].}}
+Casts a specificed spell
-  CastSpell({spellID}, {spellbookType});
+  CastSpell(spellID, spellbookType);
-----
+==Arguments==
-;''Arguments''
-:( spellID )
 :;spellID : Integer - Spell ID.
+:;spellbookType : String - Spellbook type. Valid values are "spell" (BOOKTYPE_SPELL) and "pet" (BOOKTYPE_PET). All players use "spell". Hunters and Warlocks may have additional tabs on the bottom when pets are summoned. Warlocks have Demon, which corresponnds to "pet" spellbook type.
-:( spellbookType )
+==Example==
+  CastSpell(1, "spell");
-:;spellbookType : String - Spellbook type. Valid values are "spell" and "pet". All players use "spell". Hunters and Warlocks may have additional tabs on the bottom when pets are summoned. Warlocks have Demon, which corresponnds to "pet" spellbook type.
-----
-;''Returns''
-:;nil
-----
-;''Example''
-  CastSpell( 1, "spell");
 ;''Result''
 :;Casts the first spell listed in the spellbook (usually Alchemy or Attack).
-----
-;''Example''
- CastSpell( 1, "pet");
-;''Result''
-:;Casts the first pet spell listed in the spellbook (usually Blood Pact if you control an Imp).
-----
-;''Description''
-: Cast specified spell.
-----
-;''Note''
-: Use "spell" or SpellBookFrame.booktype as the spellbookType for any non-pet spell. The id is counted from 1 through all spell types (tabs on the right side of SpellBookFrame). Pet spells also start from 1. (See example above). The CastSpell function can only be used in OnClick functions or in bindings.xml. [Obsolete: Another way is to use it in a Slash command and then the user makes a macro out of it and clicks on it. (seems WoW only allows this when a mouseclick / key input has initiated it)]
+==Note==
-----
+Use "spell" or SpellBookFrame.booktype as the spellbookType for any non-pet spell. The id is counted from 1 through all spell types (tabs on the right side of SpellBookFrame). Pet spells also start from 1. (See example above). The CastSpell function can not be used outside Blizzard-signed code.
-{{Template:WoW API}}