WoW:API PickupSpell - Revision history

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

2023-08-15T04:47:03Z

Move page script moved page API PickupSpell to API PickupSpell without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

WoWWiki>Zarunoi: using spellId currently seems to be the only method that actually works.

2018-09-10T11:08:28Z

using spellId currently seems to be the only method that actually works.

← Older revision		Revision as of 11:08, 10 September 2018
Line 1:		Line 1:
	{{protectedcombatapi\|2.0}} {{wowapi}}		{{protectedcombatapi\|2.0}}
			{{wowapi}}
	Puts the specified spell onto the mouse cursor.		Puts the specified spell onto the mouse cursor.
	PickupSpell("spellName" \| spellId, bookType)		PickupSpell("spellName" \| spellId, bookType)

	== Arguments ==		== Arguments ==
	;spellName: String - the name of the spell.		;spellName
			: String - the name of the spell.
	or		or
	;spellId : Numeric - the offset (position) of spell in spellbook. SpellId can change when you learn new spells.		;spellId
	;bookType : String - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet").		: 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 ==		== Notes ==
Line 16:		Line 20:
	This example shows, how to put the most powerful version of a spell on cursor.		This example shows, how to put the most powerful version of a spell on cursor.
	PickupSpell("Moonfire")		PickupSpell("Moonfire")

			Or using the global spell id.
			_, spellId = GetSpellBookItemInfo("Moonfire")
			PickupSpell(spellId);

	or		or
Line 26:		Line 34:
	if (not name) then break; end		if (not name) then break; end
	for s = offset + 1, offset + numSpells do		for s = offset + 1, offset + numSpells do
	local spell, rank = ~~GetSpellName~~(s, bookType);		local spell, rank = GetSpellBookItemName(s, bookType);
	if (spell == spellName) then found = true; end		if (spell == spellName) then found = true; end
	if (found and spell ~=spellName) then return s-1; end		if (found and spell ~=spellName) then return s-1; end

WoWWiki>Starlightblunder at 10:10, 22 February 2010

2010-02-22T10:10:51Z

← Older revision		Revision as of 10:10, 22 February 2010
Line 1:		Line 1:
			{{protectedcombatapi\|2.0}} {{wowapi}}
			Puts the specified spell onto the mouse cursor.
	PickupSpell("spellName" \| spellId, bookType)		PickupSpell("spellName" \| spellId, bookType)

	~~Puts a~~ spell ~~with~~ spellId ~~on mouse cursor~~.		== 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 ==
	~~;''Arguments''~~		* 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.
	~~:;spellName: String - the name of the spell.~~

	~~:;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").~~

	~~----~~
	~~;''Returns''~~

	~~<!-- List each return value, together with its type -->~~
	~~:Nothing.~~

	~~----~~
	~~;''Details''~~

	: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''~~

			== Example ==
	This example shows, how to put the most powerful version of a spell on cursor.		This example shows, how to put the most powerful version of a spell on cursor.
			PickupSpell("Moonfire")
	PickupSpell(~~spellName~~)

	or		or
Line 51:		Line 38:
	local id = findSpell(spellName, bookType);		local id = findSpell(spellName, bookType);
	PickupSpell(id, bookType);		PickupSpell(id, bookType);
	~~----~~
	see also [[API PickupAction \| PickupAction()]], [[API PickupPetAction \| PickupPetAction()]], [[API PickupBagFromSlot \| PickupBagFromSlot()]], [[API PickupContainerItem \| PickupContainerItem()]], [[API PickupInventoryItem \| PickupInventoryItem()]], [[API PickupItem \| PickupItem()]], [[API PickupMacro \| PickupMacro()]], [[API PickupMerchantItem \| PickupMerchantItem()]],[[API PickupPetAction \| PickupPetAction()]], [[API PickupPlayerMoney \| PickupPlayerMoney()]], [[API PickupStablePet \| PickupStablePet()]], [[API PickupTradeMoney \| PickupTradeMoney()]], [[API ClearCursor \| ClearCursor()]]

	~~----~~		== See Also ==
	{{~~wowapi~~}}		* {{api\|PickupAction}}, {{api\|PickupPetAction}}, {{api\|PickupBagFromSlot}}, {{api\|PickupContainerItem}}, {{api\|PickupInventoryItem}}, {{api\|PickupItem}}, {{api\|PickupMacro}}, {{api\|PickupMerchantItem}}, {{api\|PickupPlayerMoney}}, {{api\|PickupStablePet}}, {{api\|PickupTradeMoney}}
			* {{api\|ClearCursor}}

WoWWiki>Toadkiller at 20:01, 11 November 2008

2008-11-11T20:01:01Z

← Older revision		Revision as of 20:01, 11 November 2008
Line 1:		Line 1:
	PickupSpell(spellId, bookType)		PickupSpell("spellName" \| spellId, bookType)

	Puts a spell with spellId on mouse cursor.		Puts a spell with spellId on mouse cursor.
Line 5:		Line 5:
	----		----
	;''Arguments''		;''Arguments''

			:;spellName: String - the name of the spell.

	:;spellId : Numeric - the offset (position) of spell in spellbook. SpellId can change when you learn new spells.		:;spellId : Numeric - the offset (position) of spell in spellbook. SpellId can change when you learn new spells.
Line 25:		Line 27:

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

			PickupSpell(spellName)

			or

	function findSpell(spellName, bookType)		function findSpell(spellName, bookType)

WoWWiki>Puliver: Page created

2008-03-15T00:29:33Z

Page created

New page

PickupSpell(spellId, bookType)

Puts a spell with spellId on mouse cursor.

----
;''Arguments''

:;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").

----
;''Returns''


:Nothing.

----
;''Details''

: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.

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 = GetSpellName(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 [[API PickupAction | PickupAction()]], [[API PickupPetAction | PickupPetAction()]], [[API PickupBagFromSlot | PickupBagFromSlot()]], [[API PickupContainerItem | PickupContainerItem()]], [[API PickupInventoryItem | PickupInventoryItem()]], [[API PickupItem | PickupItem()]], [[API PickupMacro | PickupMacro()]], [[API PickupMerchantItem | PickupMerchantItem()]],[[API PickupPetAction | PickupPetAction()]], [[API PickupPlayerMoney | PickupPlayerMoney()]], [[API PickupStablePet | PickupStablePet()]], [[API PickupTradeMoney | PickupTradeMoney()]], [[API ClearCursor | ClearCursor()]]

----
{{wowapi}}