Navigation menu

WoW:API PickupContainerItem: Difference between revisions

Jump to navigation Jump to search

WoW:API PickupContainerItem (source)

Revision as of 04:47, 15 August 2023

2,505 bytes added ,  15 August 2023
m
Move page script moved page API PickupContainerItem to WoW:API PickupContainerItem without leaving a redirect
No edit summary
m (Move page script moved page API PickupContainerItem to WoW:API PickupContainerItem without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<center>'''PickupContainerItem''' ''-Documentation by [[user:Xenoveritas|Xenoveritas]]-''</center>
{{wowapi}}
 
Wildcard function usually called when a player left clicks on a slot in their bags. Functionality includes picking up the item from a specific bag slot, putting the item into a specific bag slot, and applying enchants (including poisons and sharpening stones) to the item in a specific bag slot, except if one of the Modifier Keys is pressed.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->


  PickupContainerItem(bagID, slot);
  PickupContainerItem(bagID, slot);
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
"Picks up" an item in one of the backpacks.  This appears to be a kind of catch-all "pick up/activate" function.


----
----
;''Arguments''
;''Arguments''


<!-- List each argument, together with its type -->
:(bagID, slot)
:(bagID, slot)
:;[[API TYPE bagID|bagID]]: Integer - the integer ID bag the item is being taken from
:;[[API TYPE bagID|bagID]]: Integer - id of the bag the slot is located in.
:;slot : Integer - the slot number (1-based) of the item
:;slot : Integer - slot inside the bag (top left slot is 1, slot to the right of it is 2).


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


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


Line 26: Line 19:
;''Details''
;''Details''


<!-- Details not appropriate for the main description can go here -->
: The function behaves differently depending on what is currently on the cursor:
: "Picks up" an item in one of the backpacks.  This appears to be a kind of catch-all "pick up/activate" function.
:* If the cursor currently has nothing, calling this will pick up an item from your backpack.
 
:* If the cursor currently contains an item (check with [[API_CursorHasItem|CursorHasItem()]]), calling this will place the item currently on the cursor into the specified bag slot. If there is already an item in that bag slot, the two items will be exchanged.
:If you have nothing else active, calling this will "pick up" the item, causing the cursor to change to the item's icon.  Once this has happened, calling this a second time will swap the two items. Likewise, calling this when an ability that targets an item is active (for example, enchanting), then this function will "cast" that ability on the targetted item.
:* If the cursor is set to a spell (typically enchanting and poisons, check with [[API_SpellIsTargeting|SpellIsTargeting()]]), calling this specifies that you want to cast the spell on the item in that bag slot.
 
: Trying to pickup the same item twice in the same "time tick" does not work (client seems to flag the item as "locked" and waits for the server to sync).  This is only a problem if you might move a single item multiple times (i.e., if you are changing your character's equipped armor, you are not likely to move a single piece of armor more than once).  If you might move an object multiple times in rapid succession, you can check the item's 'locked' flag by calling [[API GetContainerItemInfo|GetContainerItemInfo]].  If you want to do this, you should leverage OnUpdate to help you.  Avoid constantly checking the lock status inside a tight loop.  If you do, you risk getting into a race condition.  Once the repeat loop starts running, the client will not get any communication from the server until it finishes.  However, it will not finish until the server tells it that the item is unlocked.  Here is some sample code that illustrates the problem.
The following code will not work
 
PickupContainerItem(0,1)
PickupContainerItem(0,2)
PickupContainerItem(0,2)
PickupContainerItem(0,3)
 
but


this one will work
function DangerousSwapItems(bag1, slot1, bag2, slot2)
    ClearCursor()
    repeat
        _, _, locked1 = [[API GetContainerItemInfo|GetContainerItemInfo]](bag1, slot1)
        _, _, locked2 = [[API GetContainerItemInfo|GetContainerItemInfo]](bag2, slot2)
        --[[ DANGER! At this point, locked1 and locked2 will not change.  They will not change
              until the server tells us that the items in question have become unlocked, and that
              will not happen until we finish this call stack (i.e. return from this function,
              then his caller, then his caller, all the way up our lua code). ]]
    until not locked1 and not locked2
    '''PickupContainerItem'''(bag1, slot1)
    '''PickupContainerItem'''(bag2, slot2)
end
DangerousSwapItems(1, 1, 1, 2)
DangerousSwapItems(1, 2, 1, 3)  --DANGER!  Item in (1, 2) is likely still locked, and this function will never return!


PickupContainerItem(0,1)
: A potentially better way to do this is to use coroutines:
PickupContainerItem(0,2)
PickupContainerItem(0,3)
PickupContainerItem(0,4)


Trying to pickup the same item twice in the same "time tick" does not work. To get around the problem, you need to use an _OnUpdate function, check that at least .1 time has elapsed since the last time before picking up the same item.
function SaferSwapItems(bag1, slot1, bag2, slot2)
    ClearCursor()
    while true do                    -- This is not really an infinite loop, as you will see in a few lines
        local _, _, locked1 = [[API GetContainerItemInfo|GetContainerItemInfo]](bag1, slot1)
        local _, _, locked2 = [[API GetContainerItemInfo|GetContainerItemInfo]](bag2, slot2)
        if locked1 or locked2 then    -- During each iteration of the loop, we will either...
            coroutine.yield()        --    yield, thus returning from SaferSwapItems
        else                          --  or
            break                    --    break, thus returning from SaferSwapItems
        end
    end
    '''PickupContainerItem'''(bag1, slot1)
    '''PickupContainerItem'''(bag2, slot2)
end
co = coroutine.create(SaferSwapItems)
function OnUpdate()
    coroutine.resume(co)    -- We should actually look at the return value from resume, because
                            -- it will be false when the coroutine is actually finished
end


----
You can also use the event "ITEM_LOCK_CHANGED" instead of OnUpdate.
{{WoW API}}
Anonymous user
Retrieved from "https://addonstudio.org/wiki/Special:MobileDiff/11158...11164"