WoW:API GetContainerItemLink - Revision history

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

2023-08-15T04:45:50Z

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

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>Belleboom at 18:09, 28 March 2008

2008-03-28T18:09:44Z

@@ Line 38: / Line 38: @@
 ====Result====
 Searches through your bags and uses the first item found that contains the provided string in its name.
 ====Info====

WoWWiki>NefariousN: Cleanup

2008-03-22T00:50:08Z

Cleanup

← Older revision		Revision as of 00:50, 22 March 2008
Line 25:		Line 25:
	== Example ==		== Example ==
	<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->		<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
	function UseContainerItemByName(~~SearchString~~)		function UseContainerItemByName(search)
	for bag=0,4 do		for bag = 0,4 do
	for slot=1,GetContainerNumSlots(bag) do		for slot = 1,GetContainerNumSlots(bag) do
	~~if (~~GetContainerItemLink(bag,slot)~~) then~~		local item = GetContainerItemLink(bag,slot)
	if ~~(string.~~find(~~GetContainerItemLink(bag,slot), SearchString)~~) then		if item and item:find(search) then
	UseContainerItem(bag,slot)		UseContainerItem(bag,slot)
	~~end~~
	end		end
	end		end

WoWWiki>WoWWiki-Snowfox: Corrected valid range of the parameter bagID.

2007-11-25T05:11:34Z

Corrected valid range of the parameter bagID.

← Older revision		Revision as of 05:11, 25 November 2007
Line 14:		Line 14:
	:bagID, slotID		:bagID, slotID

	:;[[bagID]] : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.		:;[[bagID]] : Numeric - The number of the bag. Valid bags are -2 - 11. 0 is the backpack.
	:;slotID : Numeric - The slot of the specified bag. Valid slotID's are 1 through BagSize. 1 is the left slot in the top row.		:;slotID : Numeric - The slot of the specified bag. Valid slotID's are 1 through BagSize. 1 is the left slot in the top row.

WoWWiki>Mikk: /* UseContainerItem(bagID,slotID) */

2007-05-26T06:20:23Z

UseContainerItem(bagID,slotID)

← Older revision		Revision as of 06:20, 26 May 2007
Line 52:		Line 52:

	:[[API UseContainerItem\|UseContainerItem(bagID,slot)]] - Uses an item located in [[bagID]] and slotID.		:[[API UseContainerItem\|UseContainerItem(bagID,slot)]] - Uses an item located in [[bagID]] and slotID.
			:''Bad example. UseContainerItem() is protected these days. --[[User:Mikk\|<span style="border-bottom: 1px dotted; cursor: help;" title="Mikk is a WoWWiki Admin">Mikk</span>]] <small>([[User talk:Mikk\|T]])</small> 06:20, 26 May 2007 (UTC)''

	===== string.find(string,pattern{,init{,plain}}) =====		===== string.find(string,pattern{,init{,plain}}) =====

WoWWiki>VoidvectorBot: Robot: Automated text replacement (-\[\[\s(\w[^]|]\w)\s\|\s\1\s*]] +\1)

2007-01-22T18:35:22Z

Robot: Automated text replacement (-\[\[\s*(\w[^]|]*\w)\s*\|\s*\1\s*]] +1)

← Older revision		Revision as of 18:35, 22 January 2007
Line 14:		Line 14:
	:bagID, slotID		:bagID, slotID

	:;[[~~bagID\|~~bagID]] : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.		:;[[bagID]] : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.
	:;slotID : Numeric - The slot of the specified bag. Valid slotID's are 1 through BagSize. 1 is the left slot in the top row.		:;slotID : Numeric - The slot of the specified bag. Valid slotID's are 1 through BagSize. 1 is the left slot in the top row.

Line 21:		Line 21:
	:ItemLink		:ItemLink

	:;[[~~ItemLink\|~~ItemLink]] : Returns the [[ItemLink]] (The item link is the link when you shift-click an item while the chat edit box is visible). Returns nil if the slot of the specified bag is empty. Example link returned: '''\|Hitem:6948:0:0:0:0:0:0:0\|h[Hearthstone]\|h''' . To use this link in other functions that require an [[ItemLink]], you have to strip out the extra chat link information. Ex: '''item:6948:0:0:0:0:0:0:0'''		:;[[ItemLink]] : Returns the [[ItemLink]] (The item link is the link when you shift-click an item while the chat edit box is visible). Returns nil if the slot of the specified bag is empty. Example link returned: '''\|Hitem:6948:0:0:0:0:0:0:0\|h[Hearthstone]\|h''' . To use this link in other functions that require an [[ItemLink]], you have to strip out the extra chat link information. Ex: '''item:6948:0:0:0:0:0:0:0'''

	== Example ==		== Example ==

WoWWiki>Siz: Homogenized variable names and added links for ItemLink and BagID

2007-01-06T10:46:48Z

Homogenized variable names and added links for ItemLink and BagID

← Older revision		Revision as of 10:46, 6 January 2007
Line 3:		Line 3:

	<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->		<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
	Returns the ~~item link~~ of the item located in ~~bag#~~ and ~~slot#~~.		Returns the [[ItemLink]] of the item located in [[bagID]] and slotID.

	<!-- 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 -->
	ItemLink = GetContainerItemLink(~~bag~~, ~~slot~~)		ItemLink = GetContainerItemLink(bagID, slotID)


Line 12:		Line 12:
	=== Arguments ===		=== Arguments ===
	<!-- List each argument, together with its type -->		<!-- List each argument, together with its type -->
	:bagID, ~~slot~~		:bagID, slotID

	:;[[~~API TYPE~~ bagID\|bagID]] : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.		:;[[bagID\|bagID]] : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.
	:;~~slot~~ : Numeric - The slot of the specified bag. Valid ~~slots~~ are 1 through BagSize. 1 is the left slot in the top row.		:;slotID : Numeric - The slot of the specified bag. Valid slotID's are 1 through BagSize. 1 is the left slot in the top row.

	=== Returns ===		=== Returns ===
Line 21:		Line 21:
	:ItemLink		:ItemLink

	:;ItemLink : Returns the ItemLink (The item link is the link when you shift-click an item while the chat edit box is visible). Returns nil if the slot of the specified bag is empty. Example link returned: '''\|Hitem:6948:0:0:0:0:0:0\|h[Hearthstone]\|h''' . To use this link in other functions that require an ~~"itemlink"~~, you have to strip out the extra chat link information. Ex: '''item:6948:0:0:0:0:0:0'''		:;[[ItemLink\|ItemLink]] : Returns the [[ItemLink]] (The item link is the link when you shift-click an item while the chat edit box is visible). Returns nil if the slot of the specified bag is empty. Example link returned: '''\|Hitem:6948:0:0:0:0:0:0:0\|h[Hearthstone]\|h''' . To use this link in other functions that require an [[ItemLink]], you have to strip out the extra chat link information. Ex: '''item:6948:0:0:0:0:0:0:0'''

	== Example ==		== Example ==
Line 49:		Line 49:
	:[[API GetContainerNumSlots\|GetContainerNumSlots(bagID)]] - Gives you the number of slots available in the bag specified by the index.		:[[API GetContainerNumSlots\|GetContainerNumSlots(bagID)]] - Gives you the number of slots available in the bag specified by the index.

	===== UseContainerItem(bagID,~~slot~~) =====		===== UseContainerItem(bagID,slotID) =====

	:[[API UseContainerItem\|UseContainerItem(bagID,slot)]] - Uses an item located in ~~bag#~~ and ~~slot#~~.		:[[API UseContainerItem\|UseContainerItem(bagID,slot)]] - Uses an item located in [[bagID]] and slotID.

	===== string.find(string,pattern{,init{,plain}}) =====		===== string.find(string,pattern{,init{,plain}}) =====

WoWWiki>VelvetPaw: /* Returns */

2006-12-22T19:10:52Z

Returns

← Older revision		Revision as of 19:10, 22 December 2006
Line 21:		Line 21:
	:ItemLink		:ItemLink

	:;ItemLink : Returns the ItemLink (The item link is the link when you shift-click an item while the chat edit box is visible). Returns nil if the slot of the specified bag is empty. Example link returned: '''\|Hitem:6948:0:0:0\|H[Hearthstone]\|H''' . To use this link in other functions that require an "itemlink", you have to strip out the extra chat link information. Ex: '''item:6948:0:0:0'''		:;ItemLink : Returns the ItemLink (The item link is the link when you shift-click an item while the chat edit box is visible). Returns nil if the slot of the specified bag is empty. Example link returned: '''\|Hitem:6948:0:0:0:0:0:0\|h[Hearthstone]\|h''' . To use this link in other functions that require an "itemlink", you have to strip out the extra chat link information. Ex: '''item:6948:0:0:0:0:0:0'''

	== Example ==		== Example ==

WoWWiki>Esselte at 19:46, 9 September 2006

2006-09-09T19:46:59Z

← Older revision		Revision as of 19:46, 9 September 2006
Line 1:		Line 1:
	~~<center>'''GetContainerItemLink''' - ''Documentation by VelvetPaw''</center>~~		{{wowapi}} __NOTOC__


			<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
	Returns the item link of the item located in bag# and slot#.		Returns the item link of the item located in bag# and slot#.

	ItemLink = GetContainerItemLink(bag,slot)		<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
			ItemLink = GetContainerItemLink(bag, slot)


	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
			<!-- List each argument, together with its type -->
	:bagID, slot		:bagID, slot

	:;[[API TYPE bagID\|bagID]] : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.		:;[[API TYPE bagID\|bagID]] : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.

	:;slot : Numeric - The slot of the specified bag. Valid slots are 1 through BagSize. 1 is the left slot in the top row.		:;slot : Numeric - The slot of the specified bag. Valid slots are 1 through BagSize. 1 is the left slot in the top row.

	=== Returns ===		=== Returns ===
			<!-- List each return value, together with its type -->
	:ItemLink		:ItemLink

	:;ItemLink : Returns the ItemLink (The item link is the link when you shift-click an item while the chat edit box is visible). Returns nil if the slot of the specified bag is empty. Example link returned: '''\|Hitem:6948:0:0:0\|H[Hearthstone]\|H''' . To use this link in other functions that require an "itemlink", you have to strip out the extra chat link information. Ex: '''item:6948:0:0:0'''		:;ItemLink : Returns the ItemLink (The item link is the link when you shift-click an item while the chat edit box is visible). Returns nil if the slot of the specified bag is empty. Example link returned: '''\|Hitem:6948:0:0:0\|H[Hearthstone]\|H''' . To use this link in other functions that require an "itemlink", you have to strip out the extra chat link information. Ex: '''item:6948:0:0:0'''

	=== Example ===		== Example ==
			<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
	function UseContainerItemByName(SearchString)		function UseContainerItemByName(SearchString)
	for bag=0,4 do		for bag=0,4 do
Line 33:		Line 37:
	end		end

			====Result====
			Searches through your bags and uses the first item found that contains the provided string in its name.

	== Info ==		====Info====
	=== for .. do ===		===== for .. do =====

	:Look for the 'for .. do' block at the [http://www.lua.org/manual/5.0/ Reference Manual].		:Look for the 'for .. do' block at the [http://www.lua.org/manual/5.0/ Reference Manual].

	=== GetContainerNumSlots(bagID) ===		===== GetContainerNumSlots(bagID) =====

	:[[API GetContainerNumSlots\|GetContainerNumSlots(bagID)]] - Gives you the number of slots available in the bag specified by the index.		:[[API GetContainerNumSlots\|GetContainerNumSlots(bagID)]] - Gives you the number of slots available in the bag specified by the index.

	=== UseContainerItem(bagID,slot) ===		===== UseContainerItem(bagID,slot) =====

	:[[API UseContainerItem\|UseContainerItem(bagID,slot)]] - Uses an item located in bag# and slot#.		:[[API UseContainerItem\|UseContainerItem(bagID,slot)]] - Uses an item located in bag# and slot#.

	=== string.find(string,pattern{,init{,plain}}) ===		===== string.find(string,pattern{,init{,plain}}) =====

	:[[API strfind\|strfind(string,pattern{,init{,plain}})]] - Look for match of pattern in string, optionally from specific location or using plain substring.		:[[API strfind\|strfind(string,pattern{,init{,plain}})]] - Look for match of pattern in string, optionally from specific location or using plain substring.

	~~----~~		[[Category:World of Warcraft API]]
	~~{{WoW~~ API}}

WoWWiki>Ebnusn: /* UseContainerItem(bag,slot) */

2006-03-15T00:02:38Z

UseContainerItem(bag,slot)

← Older revision		Revision as of 00:02, 15 March 2006
Line 7:		Line 7:
	=== Arguments ===		=== Arguments ===

	:~~bag~~, slot		:bagID, slot

	:;~~bag~~ : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.		:;[[API TYPE bagID\|bagID]] : Numeric - The number of the bag. Valid bags are 0-4. 0 is the backpack.

	:;slot : Numeric - The slot of the specified bag. Valid slots are 1 through BagSize. 1 is the left slot in the top row.		:;slot : Numeric - The slot of the specified bag. Valid slots are 1 through BagSize. 1 is the left slot in the top row.
Line 39:		Line 39:
	:Look for the 'for .. do' block at the [http://www.lua.org/manual/5.0/ Reference Manual].		:Look for the 'for .. do' block at the [http://www.lua.org/manual/5.0/ Reference Manual].

	=== GetContainerNumSlots(~~bag~~) ===		=== GetContainerNumSlots(bagID) ===

	:[[API GetContainerNumSlots\|GetContainerNumSlots(~~index~~)]] - Gives you the number of slots available in the bag specified by the index.		:[[API GetContainerNumSlots\|GetContainerNumSlots(bagID)]] - Gives you the number of slots available in the bag specified by the index.

	=== UseContainerItem(~~bag~~,slot) ===		=== UseContainerItem(bagID,slot) ===

	:[[API UseContainerItem\|UseContainerItem(~~bag~~,slot)]] - Uses an item located in bag# and slot#.		:[[API UseContainerItem\|UseContainerItem(bagID,slot)]] - Uses an item located in bag# and slot#.

	=== string.find(string,pattern{,init{,plain}}) ===		=== string.find(string,pattern{,init{,plain}}) ===