WoW:API GetSpellTexture: Difference between revisions

Revision as of 21:12, 26 September 2006

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns the texture path of the specified spellbook spell

texture = GetSpellTexture(spellID, bookType)

(spellID, bookType)

spellID: Integer - Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.
bookType: String - Either BOOKTYPE_SPELL or BOOKTYPE_PET.

texture: String - path of the texture used for displaying the spell in the spellbook

If you're trying to read the spell book at login, register for the PLAYER_LOGIN event.

@@ Line 1: / Line 1: @@
-Same as IsSpellPassive
+{{wowapi}} __NOTOC__
-But instead of returning 1 or nil, returns texture:
-:: See UnitBuff -Documentation by Sarf-
+<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
+Returns the texture path of the specified spellbook spell
--Myrrion
+<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+ texture = GetSpellTexture(spellID, bookType)
-{{Template:WoW API}}
+== Parameters ==
+=== Arguments ===
+<!-- List each argument, together with its type -->
+:(spellID, bookType)
+:;spellID : Integer - Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.
+:;bookType : String - Either BOOKTYPE_SPELL or BOOKTYPE_PET.
+=== Returns ===
+<!-- List each return value, together with its type -->
+:;texture : String - path of the texture used for displaying the spell in the spellbook
+==Details==
+<!-- Details not appropriate for the main description can go here.
+     REMOVE the section if you're just going to restate the intro line! -->
+: If you're trying to read the spell book at login, register for the [[Events P (Party, Petition, Pet, PlayerBank, Player)#PLAYER_LOGIN|PLAYER_LOGIN]] event.
+[[Category:Boilerplates]]