WoW:API GetContainerItemLink: Difference between revisions
Jump to navigation
Jump to search
GetContainerItemLink - Documentation by VelvetPaw
No edit summary |
|||
| Line 7: | Line 7: | ||
=== Arguments === | === Arguments === | ||
: | :bagID, slot | ||
:; | :;[[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( | === GetContainerNumSlots(bagID) === | ||
:[[API GetContainerNumSlots|GetContainerNumSlots( | :[[API GetContainerNumSlots|GetContainerNumSlots(bagID)]] - Gives you the number of slots available in the bag specified by the index. | ||
=== UseContainerItem( | === UseContainerItem(bagID,slot) === | ||
:[[API UseContainerItem|UseContainerItem( | :[[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}}) === | ||
Revision as of 00:02, 15 March 2006
Returns the item link of the item located in bag# and slot#.
ItemLink = GetContainerItemLink(bag,slot)
Parameters
Arguments
- bagID, slot
- 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.
Returns
- 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
Example
function UseContainerItemByName(SearchString)
for bag=0,4 do
for slot=1,GetContainerNumSlots(bag) do
if (GetContainerItemLink(bag,slot)) then
if (string.find(GetContainerItemLink(bag,slot), SearchString)) then
UseContainerItem(bag,slot)
end
end
end
end
end
Info
for .. do
- Look for the 'for .. do' block at the Reference Manual.
GetContainerNumSlots(bagID)
- GetContainerNumSlots(bagID) - Gives you the number of slots available in the bag specified by the index.
UseContainerItem(bagID,slot)
- UseContainerItem(bagID,slot) - Uses an item located in bag# and slot#.
string.find(string,pattern{,init{,plain}})
- strfind(string,pattern{,init{,plain}}) - Look for match of pattern in string, optionally from specific location or using plain substring.