Cynnar: Created page with "{{LUAFunction |Name = AddPlayerMail |Description = Adds mail to the players inbox |Param1 = Character ID |Param1Desc = is the id of the Character getting the mail |Param2 = st..."

2021-02-12T23:45:04Z

Created page with "{{LUAFunction |Name = AddPlayerMail |Description = Adds mail to the players inbox |Param1 = Character ID |Param1Desc = is the id of the Character getting the mail |Param2 = st..."

New page

{{LUAFunction
|Name = AddPlayerMail
|Description = Adds mail to the players inbox
|Param1 = Character ID
|Param1Desc = is the id of the Character getting the mail
|Param2 = string
|Param2Desc = is the person the mail is from
|Param3 = string
|Param3Desc = is the subject of the mail
|Param4 = string
|Param4Desc = is the body of the mail
|OptionalParam1 = int8
|OptionalParam1Desc = is the type of mail being sent
|OptionalParam2 = int32
|OptionalParam2Desc = is the copper to send
|OptionalParam3 = int32
|OptionalParam3Desc = is the silver to send
|OptionalParam4 = int32
|OptionalParam4Desc = is the fold to send
|OptionalParam5 = int32
|OptionalParam5Desc = is the platinum to send
|OptionalParam6 = int32
|OptionalParam6Desc = is the id of the item to send
|OptionalParam7 = int16
|OptionalParam7Desc = is the amount of the item to send
|OptionalParam8 = int32
|OptionalParam8Desc = is the time the mail will expire
|OptionalParam9 = int32
|OptionalParam9Desc = is the time the mail was sent
|Example =
<pre>
function hailed(NPC, Spawn)
AddPlayerMail(17, "Neatz", "You Got Mail", "This buds for you!", 1, 2, 3, 4, 5, 420, 10, 0, 0)
end
</pre>
|ExampleDesc = a NPC with this function will send the player with the id of 17 mail from Neatz with a subject of ''You Got Mail'' and the mail saying ''This buds for you!'' in the form of spam. The player will also receive 2 copper, 3 silver, 4 gold, and 5 platinum along with the item associated with item id 420 and a 10 stack of that item. The mail will never expire and sets the sent time as the current time it was sent.
|Notes = === Mail Type ===
<pre>
0 = Regular
1 = Spam
2 = GM
</pre>

'''expire time''' is in seconds for expiration, leave 0 for unlimited.

'''sent time''' is in unix timestamp or left as 0 for default time of now

=== <span style="color:#ff0000"> DOES NOT WORK</span> ===

'''''item id'''''

'''''stack size'''''
}}

LUA:AddPlayerMailByCharID - Revision history

Cynnar: Created page with "{{LUAFunction |Name = AddPlayerMail |Description = Adds mail to the players inbox |Param1 = Character ID |Param1Desc = is the id of the Character getting the mail |Param2 = st..."