EQ2Emu
Discord Log in

Lua functions

AddPlayerMail

Registered in this checkout as EQ2Emu_lua_AddPlayerMail; implementation found at WorldServer/Lua/LuaFunctions.cpp:14307.

Historical signature: AddPlayerMail(Spawn, FromName, SubjectName, MailBody, MailType, Copper, Silver, Gold, Platinum, ItemID, StackSize, ExpireTime, SentTime)

Parameter and behavior details in the historical explanation are under review against the current implementation.

Function: AddPlayerMail(Spawn, FromName, SubjectName, MailBody, MailType, Copper, Silver, Gold, Platinum, ItemID, StackSize, ExpireTime, SentTime)

Description: Sends a mail message to the Spawn.

Parameters:

  • Spawn: Spawn - The Spawn (Player) to send the mail.
  • FromName: string - From header name.
  • SubjectName: string - Subject header name.
  • MailBody: string - Body value.
  • MailType: UInt8 - Type of mail, 0 = Regular, 1 = Spam, 2 = GM.
  • Copper: UInt32 - Amount of copper included in the mail.
  • Silver: UInt32 - Amount of silver included in the mail.
  • Gold: UInt32 - Amount of gold included in the mail.
  • Platinum: UInt32 - Amount of platinum included in the mail.
  • ItemID: UInt32 - ItemID to provide to the Spawn in the mail.
  • StackSize: UInt16 - StackSize (Quantity) of the item.
  • ExpireTime: UInt32 - Unix Timestamp Expiration (defaults to 30 days after the sent time). Not active?
  • SentTime: UInt32 - Unix Timestamp of when the mail was sent (optional defaults to current time).

Returns: Boolean: True if successful adding mail, otherwise False.

Checked example

No checked example is published for this function yet. No suitable maintained runtime-script example passed the argument and source review.

Current registration: WorldServer/Lua/LuaInterface.cpp. Historical explanation: EQ2Emu Lua documentation.