WoW:API UseContainerItem: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API UseContainerItem to API UseContainerItem without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 23: Line 23:
==Details==
==Details==
:Slots in the bags are listed from left to right, top to bottom.  
:Slots in the bags are listed from left to right, top to bottom.  
:A 16 slot bag have the following slot numbers:
:A 16 slot bag has the following slot numbers:
::{| ! style="width: 150px; text-align: right; border: 1px solid white"
::{| ! style="width: 150px; text-align: right; border: 1px solid white"
|-
|-
Line 36: Line 36:




:An 18 slot bag have the following slot numbers:
:An 18 slot bag has the following slot numbers:
::{| ! style="width: 150px; text-align: right; border: 1px solid white"
::{| ! style="width: 150px; text-align: right; border: 1px solid white"
|-
|-
Line 50: Line 50:
|}
|}


==Other Notes==
==Protection Notes==
The function is not completely protected and can in fact be called from unsecured script. This is at least true for vendoring items.
This function is protected except for the following:
* When the (Guild) Bank is open: Move the item to/from the (Guild) Bank.
* When the Merchant frame is open: Sell the item.
* When the Mail frame is open and on the "Send Mail" tab: Add the item to the attachments.
* When the item is equippable: Equip the item.
* When the slot is empty: Do nothing.
* When the item is a locked Lockbox: Show an error message that says it's locked.
* When the item is a container (Clam Shell, Unlocked Lockbox, etc.): Open the Loot frame and show the contents.
* When the item is a book: Open the book's Gossip frame for reading.
* When the item is not a usable item: Do nothing.
* When the item starts a quest: Open the quest Gossip frame for reading.
* When the Trade frame is open: Add the item to the list of items to be traded. (I have not confirmed this)
* When the Auctions tab is open: Add item for auction pricing and submission.

Latest revision as of 04:47, 15 August 2023

WoW API < UseContainerItem

Use an item from a container. If Merchant window is open, this will sell the item. Triggered when an item is Right Clicked.

UseContainerItem(bagId, slot [, onSelf])

Parameters[edit]

Arguments[edit]

(bagId, slot [, onSelf])
bagId
Integer - The bag id, where the item to use is located
slot
Integer - The slot in the bag, where the item to use is located
onSelf
Boolean - Optional parameter, if the item should be used on yourself (default: false).

Example[edit]

UseContainerItem(1, 16, 1)

Result[edit]

Uses the item located in the 16th slot in your 1st bag (not backpack) on yourself.
For instance if it's a bandage, this will bandage yourself.

Details[edit]

Slots in the bags are listed from left to right, top to bottom.
A 16 slot bag has the following slot numbers:
1 2 3 4
5 6 7 8
9 10 11 12
13 14 15 16


An 18 slot bag has the following slot numbers:
1 2
3 4 5 6
7 8 9 10
11 12 13 14
15 16 17 18

Protection Notes[edit]

This function is protected except for the following:

  • When the (Guild) Bank is open: Move the item to/from the (Guild) Bank.
  • When the Merchant frame is open: Sell the item.
  • When the Mail frame is open and on the "Send Mail" tab: Add the item to the attachments.
  • When the item is equippable: Equip the item.
  • When the slot is empty: Do nothing.
  • When the item is a locked Lockbox: Show an error message that says it's locked.
  • When the item is a container (Clam Shell, Unlocked Lockbox, etc.): Open the Loot frame and show the contents.
  • When the item is a book: Open the book's Gossip frame for reading.
  • When the item is not a usable item: Do nothing.
  • When the item starts a quest: Open the quest Gossip frame for reading.
  • When the Trade frame is open: Add the item to the list of items to be traded. (I have not confirmed this)
  • When the Auctions tab is open: Add item for auction pricing and submission.