WoW:API PickupInventoryItem: Difference between revisions

WoW:API PickupInventoryItem (source)

Revision as of 14:29, 18 November 2005

1,816 bytes added , 18 November 2005

no edit summary

Anonymous user

WoWWiki>Gello

@@ Line 1: / Line 1: @@
-PickupInventoryItem(index)<br>
+ PickupInventoryItem(slotId)
-Where index is a number refering to a slot in the character's equipment<br>
-<br>
+"Picks up" an item from the player's worn inventory.  This appears to be a kind of catch-all "pick up/activate" function.
-= ammo<br>
-= head<br>
+----
-= neck<br>
+;''Arguments''
-= shoulder<br>
-= shirt<br>
+:slotId
-= chest<br>
+:;slotId : Numeric - the [[API TYPE InventorySlotID|slot ID]] of the worn inventory slot.
-= belt<br>
-= legs<br>
+----
-= feet<br>
+;''Returns''
-= wrist<br>
-= gloves<br>
+<!-- List each return value, together with its type -->
-= finger 1<br>
+:Nothing.
-= finger 2<br>
-= trinket 1<br>
+----
-= trinket 2<br>
+;''Details''
-= back<br>
-= main hand<br>
+:If the cursor is empty, then it will attempt to pick up the item in the slotId.
-= off hand<br>
+:If the cursor has an item, then it will attempt to equip the item to the slotId and place the previous slotId item (if any) where the item on cursor orginated.
-= ranged<br>
+:If the cursor is in repair or spell-casting mode, it will attempt the action on the slotId.
-= tabard<br>
+:You can use [[API GetInventorySlotInfo|GetInventorySlotInfo]] to get the slotId:
+<table cellpadding="1" align="center">
+<tr><td>GetInventorySlotInfo()</td><td>slotId</td></tr>
+<tr><td>AmmoSlot</td><td>0</td></tr>
+<tr><td>HeadSlot</td><td>1</td></tr>
+<tr><td>NeckSlot</td><td>2</td></tr>
+<tr><td>ShoulderSlot</td><td>3</td></tr>
+<tr><td>ShirtSlot</td><td>4</td></tr>
+<tr><td>ChestSlot</td><td>5</td></tr>
+<tr><td>WaistSlot</td><td>6</td></tr>
+<tr><td>LegsSlot</td><td>7</td></tr>
+<tr><td>FeetSlot</td><td>8</td></tr>
+<tr><td>WristSlot</td><td>9</td></tr>
+<tr><td>HandsSlot</td><td>10</td></tr>
+<tr><td>Finger0Slot</td><td>11</td></tr>
+<tr><td>Finger1Slot</td><td>12</td></tr>
+<tr><td>Trinket0Slot</td><td>13</td></tr>
+<tr><td>Trinket1Slot</td><td>14</td></tr>
+<tr><td>BackSlot</td><td>15</td></tr>
+<tr><td>MainHandSlot</td><td>16</td></tr>
+<tr><td>SecondaryHandSlot</td><td>17</td></tr>
+<tr><td>RangedSlot</td><td>18</td></tr>
+<tr><td>TabardSlot</td><td>19</td></tr>
+<tr><td>Bag0Slot</td><td>20</td></tr>
+<tr><td>Bag1Slot</td><td>21</td></tr>
+<tr><td>Bag2Slot</td><td>22</td></tr>
+<tr><td>Bag3Slot</td><td>23</td></tr>
+</table>
+----
+;''Example''
+ /script PickupInventoryItem(GetInventorySlotInfo("MainHandSlot"))
+ /script PickupInventoryItem(GetInventorySlotInfo("SecondaryHandSlot"))
+The above attempts a main-offhand weapon swap.  It will pick up the weapon from main hand and then pick up the weapon from offhand, attempting to equip the main-hand weapon to off-hand and sending the off-hand to main-hand if possible.
 [[Category:API Functions|PickupInventoryItem]]
 [[Category:API Cursor Functions|PickupInventoryItem]]
 [[Category:API Inventory Functions|PickupInventoryItem]]