Lua functions

AddPlayerMailByCharID

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

Historical signature: AddPlayerMailByCharID(CharacterID, 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: AddPlayerMailByCharID(CharacterID, FromName, SubjectName, MailBody, MailType, Copper, Silver, Gold, Platinum, ItemID, StackSize, ExpireTime, SentTime)

Description: Sends a mail message to the Player represented by the CharacterID.

Parameters:

  • CharacterID: int32 - Integer value.
  • 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 - Quantity of the item. Zero or omission delivers one item.
  • ExpireTime: Int64 - Expiration in Unix seconds. Zero keeps the message without a scheduled expiration; negative or out-of-range values fail.
  • SentTime: Int64 - Sent time in Unix seconds. Zero or omission uses the current time; negative or out-of-range values fail. A future value stores the row now but hides it from loading until server time reaches that value.

Returns: Boolean: True after the database accepts a new mail row. False for character ID zero, invalid timestamps, a failed insert, or a missing inserted-row identity. This function stores mail by character ID and does not require an online connection. Database constraints determine whether a nonzero character ID is accepted.

Checked example

No checked example is published for this function yet. No active script call with the current C++ argument count was found.

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