LUA:AddPlayerMail - Revision history

Cynnar at 01:05, 12 February 2021

2021-02-12T01:05:33Z

Cynnar at 01:01, 12 February 2021

2021-02-12T01:01:30Z

Cynnar at 00:59, 12 February 2021

2021-02-12T00:59:59Z

Cynnar at 00:30, 12 February 2021

2021-02-12T00:30:08Z

Cynnar: Created page with "{{LUAFunction |Name = AddPlayerMail |Description = Adds mail to the players inbox |Param1 = Spawn |Param1Desc = is the spawn getting the mail |Param2 = string |Param2Desc = is..."

2021-02-12T00:29:07Z

Created page with "{{LUAFunction |Name = AddPlayerMail |Description = Adds mail to the players inbox |Param1 = Spawn |Param1Desc = is the spawn getting the mail |Param2 = string |Param2Desc = is..."

New page

{{LUAFunction
|Name = AddPlayerMail
|Description = Adds mail to the players inbox
|Param1 = Spawn
|Param1Desc = is the spawn 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
|Param5 = int8
|Param5Desc = is the type of mail being sent
|Param6 = int32
|Param6Desc = is the copper to send
|Param7 = int32
|Param7Desc = is the silver to send
|Param8 = int32
|Param8Desc = is the fold to send
|Param9 = int32
|Param9Desc = is the platinum to send
|Param10 = int32
|Param10Desc = is the id of the item to send
|Param11 = int16
|Param11Desc = is the amount of the item to send
|Param12 = int32
|Param12Desc = is the time the mail will expire
|Param13 = int32
|Param13Desc = is the time the mail was sent
|Example =
<pre>
function hailed(NPC, Spawn)
AddPlayerMail(Spawn, "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 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

=== DOES NOT WORK ===
item id
stack size
}}

@@ Line 46: / Line 46: @@
 '''sent time'''  is in unix timestamp or left as 0 for default time of now
-=== DOES NOT WORK ===
+=== <span style="color:#ff0000"> DOES NOT WORK</span> ===
 '''''item id'''''
 '''''stack size'''''
 }}

@@ Line 10: / Line 10: @@
 |Param4 = string
 |Param4Desc = is the body of the mail
-|Param5 = int8
+|OptionalParam1 = int8
-|Param5Desc = is the type of mail being sent
+|OptionalParam1Desc = is the type of mail being sent
-|Param6 = int32
+|OptionalParam2 = int32
-|Param6Desc = is the copper to send
+|OptionalParam2Desc = is the copper to send
-|Param7 = int32
+|OptionalParam3 = int32
-|Param7Desc = is the silver to send
+|OptionalParam3Desc = is the silver to send
-|Param8 = int32
+|OptionalParam4 = int32
-|Param8Desc = is the fold to send
+|OptionalParam4Desc = is the fold to send
-|Param9 = int32
+|OptionalParam5 = int32
-|Param9Desc = is the platinum to send
+|OptionalParam5Desc = is the platinum to send
-|Param10 = int32
+|OptionalParam6 = int32
-|Param10Desc = is the id of the item to send
+|OptionalParam6Desc = is the id of the item to send
-|Param11 = int16
+|OptionalParam7 = int16
-|Param11Desc = is the amount of the item to send
+|OptionalParam7Desc = is the amount of the item to send
-|Param12 = int32
+|OptionalParam8 = int32
-|Param12Desc = is the time the mail will expire
+|OptionalParam8Desc = is the time the mail will expire
-|Param13 = int32
+|OptionalParam9 = int32
-|Param13Desc = is the time the mail was sent
+|OptionalParam9Desc = is the time the mail was sent
 |Example =
 <pre>
@@ Line 48: / Line 48: @@
 === DOES NOT WORK ===
 item id
 stack size
 }}