WoW:API GetInboxItem: Difference between revisions
mNo edit summary |
m (Move page script moved page API GetInboxItem to API GetInboxItem without leaving a redirect) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
Retrieve details about an item from a mail. | Retrieve details about an item from a mail. | ||
name, itemTexture, count, quality, canUse = GetInboxItem(index) | name, itemTexture, count, quality, canUse = GetInboxItem(index, itemIndex) | ||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
:(index) | :(index, itemIndex) | ||
:;index : Integer - The index of the message to get information from. | :;index : Integer - The index of the message to get information from. | ||
:;itemIndex : Integer - The index of the item (1-ATTACHMENTS_MAX_RECEIVE(16)) | |||
=== Returns === | === Returns === | ||
:name, itemTexture, count, quality, canUse | :name, itemTexture, count, quality, canUse | ||
| Line 26: | Line 29: | ||
inbox_text = GetInboxText(inbox_item_index); | inbox_text = GetInboxText(inbox_item_index); | ||
-- Get the Attachment Description Text | -- Get the Attachment Description Text | ||
inbox_item = GetInboxItem(inbox_item_index); | inbox_item = GetInboxItem(inbox_item_index, 1); | ||
if (inbox_text ~= nil) then | if (inbox_text ~= nil) then | ||
-- Print the message text | -- Print the message text | ||
| Line 35: | Line 38: | ||
-- Print the attachment description | -- Print the attachment description | ||
DEFAULT_CHAT_FRAME:AddMessage("Inbox Item: " | DEFAULT_CHAT_FRAME:AddMessage("Inbox Item: " | ||
.. GetInboxItem(inbox_item_index), 1, 1, 1); | .. GetInboxItem(inbox_item_index, 1), 1, 1, 1); | ||
end | end | ||
end | end | ||
end | end | ||
<!-- end code --> | <!-- end code --> | ||
- | |||
==Details== | |||
: As of 2.3.3 this function is bugged and the quality is always set to -1. | |||
__NOTOC__ | __NOTOC__ | ||
Latest revision as of 04:45, 15 August 2023
← WoW API < GetInboxItem
Retrieve details about an item from a mail.
name, itemTexture, count, quality, canUse = GetInboxItem(index, itemIndex)
Parameters
Arguments
- (index, itemIndex)
- index
- Integer - The index of the message to get information from.
- itemIndex
- Integer - The index of the item (1-ATTACHMENTS_MAX_RECEIVE(16))
Returns
- name, itemTexture, count, quality, canUse
- name
- String - The display name/label for the item.
- itemTexture
- String - The path for the texture to display for the item.
- count
- Integer - How many of the item are available in the mail (I believe 0 means that the item has been retrieved)
- quality
- Integer - Item quality index.
- canUse
- Flag - Indicates if the player can use the item, 1 if they can use it, or nil if not.
Example
- Sample code from Inglais.
inbox_items = GetInboxNumItems();
if (inbox_items > 0) then
for inbox_item_index = 1, inbox_items do
-- Get the Message Text
inbox_text = GetInboxText(inbox_item_index);
-- Get the Attachment Description Text
inbox_item = GetInboxItem(inbox_item_index, 1);
if (inbox_text ~= nil) then
-- Print the message text
DEFAULT_CHAT_FRAME:AddMessage("Inbox Text: "
.. GetInboxText(inbox_item_index), 1, 1, 1);
end
if (inbox_item ~= nil) then
-- Print the attachment description
DEFAULT_CHAT_FRAME:AddMessage("Inbox Item: "
.. GetInboxItem(inbox_item_index, 1), 1, 1, 1);
end
end
end
Details
- As of 2.3.3 this function is bugged and the quality is always set to -1.