WoW:API GetInboxHeaderInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Fixed minor typo)
Line 1: Line 1:
<center>'''GetInboxHeaderInfo(index)''' ''-Documentation by [[user: BaHaMuTNeO]]-''</center>
<center>'''GetInboxHeaderInfo(index)''' ''-Documentation by [[user:BaHaMuTNeO]], [[user:Flickering|Flickering]] -''</center>


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);


GetInboxHeaderInfo(index);
Returns information about a mailbox item.
 
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
Returns the path of the header icon for a given mail index.*


----
----
;''Arguments''
;''Arguments''


<!-- List each argument, together with its type -->
:(index)
:("index")
:;index : Number - the index of the message (1 is the first message)
:;index : Number - the index of the message


----
----
;''Returns''
;''Returns''


<!-- List each return value, together with its type -->
 
:;headerinfostring : String - icon file path
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)
:;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


----
----
Line 25: Line 33:


<!-- 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 -->
  local s = GetInboxHeaderInfo(0);
  local packageTexture = GetInboxHeaderInfo(1);


;''Result''
;''Result''


<!-- If it helps, include example results here, though they are not required-->
packageTexture is "Interface\Icons\INV_Scroll_03.blp"
"Interface\Icons\INV_Scroll_03.blp"


----
----
;''Details''
;''Details''


<!-- Details not appropriate for the main description can go here -->
You must be by near to mailbox, and have opened it for this to operate.
*indexs start at 0.


----
----
{{Template:WoW API}}
{{Template:WoW API}}
<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
[[Category:API Mail Functions|GetInboxHeaderInfo]]
[[Category:API Functions|Empty Template]]

Revision as of 21:18, 22 January 2005

GetInboxHeaderInfo(index) -Documentation by user:BaHaMuTNeO, Flickering -

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

Returns information about a mailbox item.

Arguments
(index)
index
Number - the index of the message (1 is the first message)
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)
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"

Details

You must be by near to mailbox, and have opened it for this to operate.

Template:WoW API

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