Changes: API GetSpellTexture

Revision as of 21:12, 26 September 2006

Returns the texture path of the specified spellbook spell

texture = GetSpellTexture(spellID, bookType)

Parameters

Arguments

(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

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

Details

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

@@ Line 1: / Line 1: @@
+{{wowapi}} __NOTOC__
-Retrieves the spell texture for a spell in the player's spellbook. 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.
- ''spellTexture'' = GetSpellTexture( ''spellId'', ''bookType'' );
+<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
-----
+Returns the texture path of the specified spellbook spell
-;''Arguments''
+<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
-:;spellId : Integer - Spell ID. Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.
+ texture = GetSpellTexture(spellID, bookType)
-:;bookType : String - Either '''BOOKTYPE_SPELL''' ("spell") or '''BOOKTYPE_PET''' ("pet").
+== Parameters ==
-----
+=== Arguments ===
-;''Returns''
+<!-- List each argument, together with its type -->
+:(spellID, bookType)
-:;spellTexture : String - Texture path of the spell as it appears in the spellbook
+:;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.
-{{Template:WoW API}}
+=== 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]]