addMessage (client)

About

Using this export allows you to add a message to the local players chat.
Message object structure:

message = {
  template = template,
  color = color,
  multiline = true,
  args = {author, otherArgs...}
}

Name

addMessage

Parameters

object/string message

Examples

This example sends a chat message to a player locally from a client script (only the executing client will see it).

Lua Example:

AddEventHandler('onResourceStart', function(resourceName)
  if (GetCurrentResourceName() ~= resourceName) then
    return
  end
  exports.chat:addMessage({
    color = {255, 0, 0},
    args = {"SYSTEM", string.format("%s has started.", resourceName)}
  })
end)

Output:
screenshot-1

Last modified January 18, 2024: Added documentation for chat exports. (#234) (4bc0d0e)