How to use Events

From GTA Connected
Jump to navigation Jump to search

Summary

Events are used to run your code when something specific occurs.
An event system is also called the observer pattern.

A scripting function can be bound to an event, by using the event name with addEventHandler or bindEventHandler.
When an event is invoked, all scripting functions that are bound to that event are called.

Event names are not case-sensitive, OnPlayerJoined is the same as onPlayerJoined.

Example

JS, Server-Side:

addEventHandler('onPlayerJoined', function(event,client)
{
    message(client.player.name + ' has joined the server!', COLOUR_GREEN);
});

Lua, Server-Side:

addEventHandler('onPlayerJoined', function(event,client)
    message(client.player.name .. ' has joined the server!', COLOUR_GREEN)
end)