WoW:API EquipCursorItem: Difference between revisions

Latest revision as of 04:45, 15 August 2023

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

Equips the currently picked up item to a specific inventory slot.

EquipCursorItem(slot);

slot: Numric - The slot ID to place the item into. Use GetInventorySlotInfo(slotname) to resolve an inventory slot name to its ID.

EquipCursorItem(GetInventorySlotInfo("HEADSLOT"));

Attempts to equip the currently picked up item to the head slot.

@@ Line 1: / Line 1: @@
-'''Function'''<br>
+{{wowapi}}
-EquipCursorItem( <number> );
+Equips the currently picked up item to a specific inventory slot.
+ EquipCursorItem(slot);
-'''Parameters'''<br>
+== Parameters ==
-<number> : Slot to be equipped in (see notes).<br>
+=== Arguments ===
-<br>
+:;slot : Numric - The [[API_TYPE_InventorySlotID|slot ID]] to place the item into. Use [[API_GetInventorySlotInfo|GetInventorySlotInfo(slotname)]] to resolve an [[API_TYPE_InventorySlotName|inventory slot name]] to its ID.
-'''Return'''<br>
-''Unknown''<br>
-<br>
-'''Notes'''<br>
-This function will equip the item that has been 'picked up' and is held by the cursor. The <number> parameter seems to be similar to [[API PickupInventoryItem|PickupInventoryItem(index)]], but seems to be one off from it:
-<br>
-= head, 1 = neck, 2 = shoulder, 3 = shirt, 4 = chest, 5 = belt, 6 = legs, 7 = feet, 8 = wrist, 9 = gloves, 10 = finger 1, 11 = finger 2, 12 = trinket 1, 13 = trinket 2, 14 = back, 15 = main hand, 16 = off hand, 17 = ranged<br>
-<br>
-'''Furthermore:'''<br>
-- 22 = UNKNOWN<br>
-= Backpack slot 1<br>
-...<br>
-= Backpack slot 16<br>
-= Bank slot 1<br>
-...<br>
-<br>
-''Last edited 8/31/05 by Popoi''
-{{template:WoW API}}
+==Example==
+ EquipCursorItem(GetInventorySlotInfo("HEADSLOT"));
+===Result===
+Attempts to equip the currently picked up item to the head slot.