WoW:API GetInboxHeaderInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
({{wowapi}}, format)
Line 1: Line 1:
<center>'''GetInboxHeaderInfo(index)''' ''-Documentation by [[user:BaHaMuTNeO]], [[user:Flickering|Flickering]] -''</center>
{{wowapi}} __NOTOC__
Returns information about an item in the mailbox.
packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);


packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);
==Parameters==
 
===Arguments===
Returns information about a mailbox item.
 
----
;''Arguments''
 
:(index)
:;index : Number - the index of the message (1 is the first message)
:;index : Number - the index of the message (1 is the first message)
 
===Returns===
----
;''Returns''
 
 
packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply
:;packageIcon : String - texture path for package icon if it contains a package (nil otherwise)
:;packageIcon : String - texture path for package icon if it contains a package (nil otherwise)
:;stationeryIcon : String - texture path for mail message icon.
:;stationeryIcon : String - texture path for mail message icon.
Line 29: Line 20:
:;canReply : Flag - 1 if this letter can be replied to, nil otherwise
:;canReply : Flag - 1 if this letter can be replied to, nil otherwise


----
==Example==
;''Example''
 
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
  local packageTexture = GetInboxHeaderInfo(1);
  local packageTexture = GetInboxHeaderInfo(1);
 
===Result===
;''Result''
 
packageTexture is "Interface\Icons\INV_Scroll_03.blp"
packageTexture is "Interface\Icons\INV_Scroll_03.blp"


----
==Notes==
;''Details''
 
This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox|CheckInbox()]] was called.
This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox|CheckInbox()]] was called.
----
{{Template:WoW API}}

Revision as of 23:05, 23 December 2006

← WoW API < GetInboxHeaderInfo

Returns information about an item in the mailbox. 

packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);

Parameters

Arguments

index
Number - the index of the message (1 is the first message)

Returns

packageIcon
String - texture path for package icon if it contains a package (nil otherwise)
stationeryIcon
String - texture path for mail message icon.
sender
String - name of the player who sent the message.
subject
String - the message subject
money
Number - The amount of money attached
CODAmount
Number - The amount of COD payment required to receive the package
daysLeft
Number - The number of days (fractional) before the message expires
hasItem
Flag - 1 if the mail still has an item in it, nil otherwise
wasRead
Flag - 1 if the mail has been read, nil otherwise
wasReturned
Flag - 1 if the mail was returned, nil otherwise
textCreated
Flag - 1 if a letter object has been created from this mail, nil otherwise
canReply
Flag - 1 if this letter can be replied to, nil otherwise

Example

local packageTexture = GetInboxHeaderInfo(1);

Result

packageTexture is "Interface\Icons\INV_Scroll_03.blp"

Notes

This function may be called from anywhere in the world, but will only be current as of the last time CheckInbox() was called.

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetInboxHeaderInfo&oldid=8308"