WoW:API GetInboxItem - Revision history

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

2023-08-15T04:45:59Z

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

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>WoWWiki-Shefki: Updated with new information

2008-03-22T07:38:23Z

Updated with new information

← Older revision		Revision as of 07:38, 22 March 2008
Line 43:		Line 43:
	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__

WoWWiki>Baudzilla at 03:16, 17 November 2007

2007-11-17T03:16:06Z

← Older revision		Revision as of 03:16, 17 November 2007
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

WoWWiki>Pcj at 18:09, 2 November 2007

2007-11-02T18:09:39Z

← Older revision		Revision as of 18:09, 2 November 2007
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	~~<center>'''GetInboxItem''' - ''Documentation by [[User:Flickering\|Flickering]]''</center>~~

	Retrieve details about an item from a mail.		Retrieve details about an item from a mail.

WoWWiki>Hobinbot: upgraded deprecated template

2007-01-06T18:08:32Z

upgraded deprecated template

← Older revision		Revision as of 18:08, 6 January 2007
Line 1:		Line 1:
			{{wowapi}}
	<center>'''GetInboxItem''' - ''Documentation by [[User:Flickering\|Flickering]]''</center>		<center>'''GetInboxItem''' - ''Documentation by [[User:Flickering\|Flickering]]''</center>

Line 42:		Line 43:
	----		----
	__NOTOC__		__NOTOC__
	~~{{Template:WoW API}}~~

WoWWiki>Anticrash at 14:48, 4 January 2006

2006-01-04T14:48:58Z

← Older revision		Revision as of 14:48, 4 January 2006
Line 43:		Line 43:
	__NOTOC__		__NOTOC__
	{{Template:WoW API}}		{{Template:WoW API}}
	~~[[Category:API Mail Functions\|GetInboxItem]]~~

WoWWiki>Flickering: Added old example back in.

2005-09-12T17:30:50Z

Added old example back in.

← Older revision		Revision as of 17:30, 12 September 2005
Line 1:		Line 1:
	GetInboxItem~~(index)~~		<center>'''GetInboxItem''' - ''Documentation by [[User:Flickering\|Flickering]]''</center>

	~~Where index is the index of the message you want to get the attached item information~~ about.		Retrieve details about an item from a mail.
	~~Index starts at 1, unlike~~ an ~~array subscript~~.

	~~Returns a text description of the item.~~		name, itemTexture, count, quality, canUse = GetInboxItem(index)
			== Parameters ==
			=== Arguments ===
			:(index)

	~~Example Lua Script~~:		:;index : Integer - The index of the message to get information from.
			=== Returns ===
			:name, itemTexture, count, quality, canUse

	<~~pre~~>		:;name : String - The display name/label for the item.
	inbox_items = GetInboxNumItems();		:;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)
	if (inbox_items > 0) then		:;quality : Integer - Item quality index.
	for inbox_item_index = 1, inbox_items do		:;canUse : Flag - Indicates if the player can use the item, 1 if they can use it, or nil if not.
	-- Get the Message Text		== Example ==
	inbox_text = GetInboxText(inbox_item_index);		:Sample code from [[User:Inglais\|Inglais]].
	-- Get the Attachment Description Text		<!-- begin code -->
	inbox_item = GetInboxItem(inbox_item_index);		inbox_items = GetInboxNumItems();
	if (inbox_text ~= nil) then		if (inbox_items > 0) then
	DEFAULT_CHAT_FRAME:AddMessage("Inbox Text: "..GetInboxText(inbox_item_index), 1, 1, 1); ~~-- Print the message text~~		for inbox_item_index = 1, inbox_items do
	end		-- Get the Message Text
			inbox_text = GetInboxText(inbox_item_index);
	if (inbox_item ~= nil) then		-- Get the Attachment Description Text
	DEFAULT_CHAT_FRAME:AddMessage("Inbox Item: "..GetInboxItem(inbox_item_index), 1, 1, 1); ~~-- Print the attachment description~~		inbox_item = GetInboxItem(inbox_item_index);
	end		if (inbox_text ~= nil) then
	end		-- Print the message text
	end		DEFAULT_CHAT_FRAME:AddMessage("Inbox Text: "
	</code~~></pre~~>		.. GetInboxText(inbox_item_index), 1, 1, 1);
			end
			if (inbox_item ~= nil) then
	~~[[Category~~:API ~~Functions\|GetInboxItem]]~~		-- Print the attachment description
			DEFAULT_CHAT_FRAME:AddMessage("Inbox Item: "
			.. GetInboxItem(inbox_item_index), 1, 1, 1);
			end
			end
			end
			<!-- end code -->
			----
			__NOTOC__
			{{Template:WoW API}}
	[[Category:API Mail Functions\|GetInboxItem]]		[[Category:API Mail Functions\|GetInboxItem]]

WoWWiki>Inglais at 18:57, 29 August 2005

2005-08-29T18:57:39Z

← Older revision		Revision as of 18:57, 29 August 2005
Line 27:		Line 27:
	end		end
	</code></pre>		</code></pre>


			[[Category:API Functions\|GetInboxItem]]
			[[Category:API Mail Functions\|GetInboxItem]]

WoWWiki>WoWWiki-Mosen: GetInboxItem(index) - Gets a text description of the item attached to inbox message at [index]

2005-03-27T02:23:49Z

GetInboxItem(index) - Gets a text description of the item attached to inbox message at [index]

New page

GetInboxItem(index)

Where index is the index of the message you want to get the attached item information about.
Index starts at 1, unlike an array subscript.

Returns a text description of the item.

Example Lua Script:

<pre>
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);
if (inbox_text ~= nil) then
DEFAULT_CHAT_FRAME:AddMessage("Inbox Text: "..GetInboxText(inbox_item_index), 1, 1, 1); -- Print the message text
end

if (inbox_item ~= nil) then
DEFAULT_CHAT_FRAME:AddMessage("Inbox Item: "..GetInboxItem(inbox_item_index), 1, 1, 1); -- Print the attachment description
end
end
end
</code></pre>