Lua API
On this page

ChatEventArgs

eventargsbase
Inherits from
EventArgs
Object

Fired when we get a chat event from the server

Info

For more information about events, see the Using Events section of the scripting docs.

This event args class is used by the following events:
World.OnChannelMessageWorld.OnChatTextWorld.OnTellWorld.OnLocalMessageWorld.OnEmoteWorld.OnSoulEmoteWorld.OnFellowMessage

Fields:

Eat boolean

Set to true to "eat" this message and prevent the client from displaying it.

Empty EventArgs

staticread only

Provides a value to use with events that do not have event data.

Message string

read only

The message

Room ChatChannel

read only

The chat room, if available.

SenderId number

read only

The id of the sender, if available

SenderName string

read only

The name of the sender, if available

Type ChatMessageType

read only

The message type

Methods:

GetPropertyKeys() : string[]

Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts

Returns:string[]

ToString() : string

Returns a string that represents the current object.

Returns:string