WoW:API GetSpellTexture: Difference between revisions

← Older edit

WoW:API GetSpellTexture (source)

Revision as of 04:46, 15 August 2023

1,638 bytes added , 15 August 2023

m

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

Anonymous user

Move page script

@@ 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(spellName | spellID, bookType)
-[[Category:API Functions|GetSpellTexture]]
-[[Category:API Spell Functions|GetSpellTexture]]
+== Parameters ==
+=== Arguments ===
+<!-- List each argument, together with its type -->
+:(spellName | spellID, bookType)
+:;spellName : String - The name of the spell, as it would be seen in the player's 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.
+=== Returns ===
+<!-- List each return value, together with its type -->
+:;texture : String - Path of the texture used for displaying the spell in the spellbook.
+----
+;''Example''
+Displays the name of every texture in your spellbook
+ for tabIndex = 1, MAX_SKILLLINE_TABS do
+ 	local tabName, tabTexture, tabSpellOffset, tabNumSpells = GetSpellTabInfo(tabIndex)
+ 	if not tabName then
+ 		break
+ 	end
+ 	for spellIndex = tabSpellOffset + 1, tabSpellOffset + tabNumSpells do
+ 		local spellName, spellRank = GetSpellName(spellIndex, BOOKTYPE_SPELL)
+ 		local spellTexture = GetSpellTexture(spellIndex)
+ 		DEFAULT_CHAT_FRAME:AddMessage("Spell "..spellName.." uses texture "..spellTexture)
+ 	end
+ end
+==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.
+: This function won't grab textures for spells the character does not have.