WoW:API PickupContainerItem - Revision history

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

2023-08-15T04:47:01Z

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

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

WoWWiki>Roffel at 11:09, 30 December 2007

2007-12-30T11:09:17Z

← Older revision		Revision as of 11:09, 30 December 2007
Line 73:		Line 73:
	-- it will be false when the coroutine is actually finished		-- it will be false when the coroutine is actually finished
	end		end

			You can also use the event "ITEM_LOCK_CHANGED" instead of OnUpdate.

WoWWiki>Speeddymon: added information stating that this does not work if one of the modifier keys is pressed, and that this even fires when a player _left_ clicks, not right clicks.

2007-07-19T07:40:01Z

added information stating that this does not work if one of the modifier keys is pressed, and that this even fires when a player _left_ clicks, not right clicks.

← Older revision		Revision as of 07:40, 19 July 2007
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	Wildcard function usually called when a player 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.		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.

	PickupContainerItem(bagID, slot);		PickupContainerItem(bagID, slot);

WoWWiki>VoidvectorBot: Robot: Removing selflinks

2007-01-23T21:51:38Z

Robot: Removing selflinks

← Older revision		Revision as of 21:51, 23 January 2007
Line 39:		Line 39:
	until not locked1 and not locked2		until not locked1 and not locked2

	~~[[API~~ PickupContainerItem~~\|PickupContainerItem]]~~(bag1, slot1)		'''PickupContainerItem'''(bag1, slot1)
	~~[[API PickupContainerItem\|~~PickupContainerItem]](bag2, slot2)		'''PickupContainerItem'''(bag2, slot2)
	end		end

Line 63:		Line 63:
	end		end

	~~[[API~~ PickupContainerItem~~\|PickupContainerItem]]~~(bag1, slot1)		'''PickupContainerItem'''(bag1, slot1)
	~~[[API PickupContainerItem\|~~PickupContainerItem]](bag2, slot2)		'''PickupContainerItem'''(bag2, slot2)
	end		end

WoWWiki>Bytecrafter: found flaw in swap items example; marked it as dangerous; added example that is actually safe

2007-01-08T05:24:40Z

found flaw in swap items example; marked it as dangerous; added example that is actually safe

@@ Line 23: / Line 23: @@
 :* 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 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 "modified" and waits for the server to sync). 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.
+: 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.

WoWWiki>Starlightblunder: Details + {{wowapi}}

2006-07-04T13:42:45Z

Details + {{wowapi}}

← Older revision		Revision as of 13:42, 4 July 2006
Line 1:		Line 1:
	~~<center>'''PickupContainerItem''' ''-Documentation by [[user:Xenoveritas\|Xenoveritas]]-''</center>~~		{{wowapi}}
			Wildcard function usually called when a player 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.
	~~<!-- 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 "modified" and waits for the server to sync). 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.
	~~The following code will not work~~

	~~PickupContainerItem(0,1)~~
	~~PickupContainerItem(0,2)~~
	~~PickupContainerItem(0,2)~~
	~~PickupContainerItem(0,3)~~

	~~but~~

	~~this one will work~~

	~~PickupContainerItem(0,1)~~
	~~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.

	~~----~~
	~~{{WoW API}}~~

WoWWiki>Ebnusn at 00:08, 15 March 2006

2006-03-15T00:08:58Z

← Older revision		Revision as of 00:08, 15 March 2006
Line 3:		Line 3:
	<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->		<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->

	PickupContainerItem(~~bag~~, slot);		PickupContainerItem(bagID, slot);

	<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->		<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
Line 13:		Line 13:

	<!-- List each argument, together with its type -->		<!-- List each argument, together with its type -->
	:(~~bag~~, slot)		:(bagID, slot)
	:;~~bag~~ : Integer - the integer ID bag the item is being taken from		:;[[API TYPE bagID\|bagID]]: Integer - the integer ID bag the item is being taken from
	:;slot : Integer - the slot number (1-based) of the item		:;slot : Integer - the slot number (1-based) of the item

WoWWiki>JevonsPx at 01:55, 7 January 2006

2006-01-07T01:55:07Z

@@ Line 31: / Line 31: @@
 :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.
 ----
 {{WoW API}}

WoWWiki>Muert at 04:58, 4 January 2006

2006-01-04T04:58:23Z

← Older revision		Revision as of 04:58, 4 January 2006
Line 30:		Line 30:

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


	----		----
	{{~~Template:~~WoW API}} :		{{WoW API}}
	<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
	~~[[World of Warcraft API#Inventory_Functions\|Inventory Functions]]~~
	~~[[Category:API Functions\|PickupContainerItem]]~~
	~~[[Category:API Cursor Functions\|PickupContainerItem]]~~
	~~[[Category:API Container Functions\|PickupContainerItem]]~~
	~~[[Category:API Inventory Functions\|PickupContainerItem]]~~

WoWWiki>Inglais at 17:55, 29 August 2005

2005-08-29T17:55:50Z

← Older revision		Revision as of 17:55, 29 August 2005
Line 35:		Line 35:
	<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->		<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
	[[World of Warcraft API#Inventory_Functions\|Inventory Functions]]		[[World of Warcraft API#Inventory_Functions\|Inventory Functions]]
			[[Category:API Functions\|PickupContainerItem]]
			[[Category:API Cursor Functions\|PickupContainerItem]]
			[[Category:API Container Functions\|PickupContainerItem]]
	[[Category:API Inventory Functions\|PickupContainerItem]]		[[Category:API Inventory Functions\|PickupContainerItem]]

← Older revision		Revision as of 17:55, 29 August 2005
Line 35:		Line 35:
	<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->		<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
	[[World of Warcraft API#Inventory_Functions\|Inventory Functions]]		[[World of Warcraft API#Inventory_Functions\|Inventory Functions]]
			[[Category:API Functions\|PickupContainerItem]]
			[[Category:API Cursor Functions\|PickupContainerItem]]
			[[Category:API Container Functions\|PickupContainerItem]]
	[[Category:API Inventory Functions\|PickupContainerItem]]		[[Category:API Inventory Functions\|PickupContainerItem]]