OnChatOutput: Difference between revisions

From GTA Connected
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
Line 1: Line 1:
{{ScriptItem
{{ScriptItem2
|endpoint = client
|name = onChatOutput
|side = client
|type = event
|type = event
|name = onChatOutput
|games = iii vc sa iv
|usage = a message is added to the chat box
|desc = a message is added to the chat box
|parameters = Event event, string message, int colour
|arg1 = string message The message that is added to the chat box.
|parameter1 = string message The message that is added to the chat box.
|arg2 = int colour The message colour.
|parameter2 = int colour The message colour.
|cancel = true
|cancellable = true
}}
}}

Latest revision as of 20:28, 19 November 2022

Event Client Only icon-iii.png icon-vc.png icon-sa.png icon-iv.png Online and Offline Cancellable

Available since Client 1.0.0

onChatOutput(Event event, string message, int colour)

The onChatOutput event is invoked when a message is added to the chat box.

Parameters

1) Event event The event object for this event.
2) string message The message that is added to the chat box.
3) int colour The message colour.

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

Client Related

icon-iii.png icon-vc.png icon-sa.png icon-iv.png OnChatOutput