OnPlayerChat: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
|type = event | |type = event | ||
|games = iii vc sa iv | |games = iii vc sa iv | ||
|desc = a player submits a chat message.<br>This | |desc = a player submits a chat message.<br>This event is not triggered for messages starting with the command character (a forward slash).<br>By default, chat messages (not chat commands) are displayed in the chat box for all players | ||
|arg1 = Client client The client that submitted a chat message. | |arg1 = Client client The client that submitted a chat message. | ||
|arg2 = string message The chat message. | |arg2 = string message The chat message. | ||
|cancel = true | |cancel = true | ||
}} | }} | ||
Latest revision as of 03:38, 26 February 2024
Event Server and Client 
Online and Offline Cancellable
Available since Server 1.0.0, Client 1.0.0
onPlayerChat(Event event, Client client, string message)
The onPlayerChat event is invoked when a player submits a chat message.
This event is not triggered for messages starting with the command character (a forward slash).
By default, chat messages (not chat commands) are displayed in the chat box for all players.
This event is not triggered for messages starting with the command character (a forward slash).
By default, chat messages (not chat commands) are displayed in the chat box for all players.
Parameters
| 1) | Event | event | The event object for this event. |
| 2) | Client | client | The client that submitted a chat message. |
| 3) | string | message | The chat message. |
Attributes
| cancellable | This event can be cancelled, by using event.preventDefault. |
Notes
There aren't any notes for this event.
Examples
There aren't any examples for this event.
Compatibility
There isn't any compatibility information for this event.
Related
Server Related OnPlayerChat
OnPlayerCommand
OnPlayerConnect
OnPlayerJoin
OnPlayerJoined
OnPlayerQuit
Client Related
OnPlayerJoin