message

From GTA Connected
Jump to navigation Jump to search

Function Server and Client All Games Online and Offline

Server 1.0.0, Client 1.0.0

void message(string message, [ int colour = COLOUR_LIME ])

Description

The message function is used to add a message to the chat box.

When used server-side, the message is shown for all players.
When used client-side, the message is only shown for the local player.

Parameters

Type Name Presence Default Value Description
string
message
required n/a The message to display in the chat box.
int
colour
optional
COLOUR_LIME
The text colour for the message.

Returns

Success Returns

Type Description
void
This function doesn't return any values on success.

Failure Returns

Type Value
void
n/a

Notes

Examples

Example 1 - Lua:

message("This text is shown in the chat box.", COLOUR_GREEN)

Compatibility

There isn't any compatibility information for this function.

Related

Server Related

message
messageAllExcept
messageClient


Client Related

message
setChatWindowEnabled