WoW:API PickupSpell

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

→ WoW API

← WoW API < PickupSpell

Puts the specified spell onto the mouse cursor.

PickupSpell("spellName" | spellId, bookType)

Arguments

spellName

String - the name of the spell.

or

spellId

Numeric - the offset (position) of spell in spellbook. SpellId can change when you learn new spells.

bookType

String - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet").

Notes

• This function will put a spell on mouse cursor. The spell is defined by spellbook and it's position in the spellbook.
• The cursor needs to be clear in order to use this function.

Example

This example shows, how to put the most powerful version of a spell on cursor.

PickupSpell("Moonfire")

Or using the global spell id.

_, spellId = GetSpellBookItemInfo("Moonfire")
PickupSpell(spellId);

or

 function findSpell(spellName, bookType)
   local i, s;
   local found = false;
   for i = 1, MAX_SKILLLINE_TABS do
     local name, texture, offset, numSpells = GetSpellTabInfo(i);
     if (not name) then break; end
     for s = offset + 1, offset + numSpells do
       local	spell, rank = GetSpellBookItemName(s, bookType);
       if (spell == spellName) then found = true; end
       if (found and spell ~=spellName) then return s-1; end
     end
   end
   if (found) then return s; end
   return nil;
 end

 local bookType = BOOKTYPE_SPELL;
 local id = findSpell(spellName, bookType);
 PickupSpell(id, bookType);

See Also

• PickupAction, PickupPetAction, PickupBagFromSlot, PickupContainerItem, PickupInventoryItem, PickupItem, PickupMacro, PickupMerchantItem, PickupPlayerMoney, PickupStablePet, PickupTradeMoney
• ClearCursor