WoW:API GetSpellTexture: Difference between revisions
Jump to navigation
Jump to search
m (removed Category:Boilerplates (doesn't make any sense)) |
m (Move page script moved page API GetSpellTexture to API GetSpellTexture without leaving a redirect) |
||
| (6 intermediate revisions by 6 users not shown) | |||
| Line 6: | Line 6: | ||
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | <!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | ||
texture = GetSpellTexture(spellID, bookType) | texture = GetSpellTexture(spellName | spellID, bookType) | ||
| Line 12: | Line 12: | ||
=== Arguments === | === Arguments === | ||
<!-- List each argument, together with its type --> | <!-- List each argument, together with its type --> | ||
:(spellID, bookType) | :(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. | :;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. | :;bookType : String - Either BOOKTYPE_SPELL or BOOKTYPE_PET. | ||
| Line 20: | Line 21: | ||
<!-- List each return value, together with its type --> | <!-- List each return value, together with its type --> | ||
:;texture : String - | :;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== | ||
| Line 28: | Line 48: | ||
: 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. | : 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. | |||
Latest revision as of 04:46, 15 August 2023
Returns the texture path of the specified spellbook spell
texture = GetSpellTexture(spellName | spellID, bookType)
Parameters
Arguments
- (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
- 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
- If you're trying to read the spell book at login, register for the PLAYER_LOGIN event.
- This function won't grab textures for spells the character does not have.