Getting Started with Events

RAGE:MP Documentation

</div>

Events System

</div>

Events are the backbone of scripting in RAGE:MP. This page explains what they are, how to register them, how communication works between server, client, and CEF, and how to manage them cleanly.

</div>

Core Idea

</div>

Events react to things

</div>

Built-in events react automatically. Custom events react when you trigger them.

</div>

Communication

</div>

Know your direction

</div>

Server, client, and CEF do not all communicate the same way.

</div>

Rule

</div>

</div>

An event must be registered before you can use or trigger it.

</div>

Introduction

Events are the <b>core scripting system</b> for RAGE:MP.

They are registered by you and triggered when a specific action or situation happens.

For example, [PlayerEnterCheckpoint](/playerentercheckpoint) is triggered when a player enters a checkpoint. That event gives you:

the <b>Player</b> that entered it
the <b>Checkpoint</b> that was entered

</div>

Event Types

Type 1

</div>

Built-in Events

</div>

These are provided by <b>RAGE:MP</b> and are triggered automatically in certain situations.

</div>

Examples:

</div>

player entering a checkpoint
player quitting
player spawning

<b>Lists:</b>

[Server-side events](/server-side-events)

[Client-side events](/client-side-events)

</div>

Type 2

</div>

Custom Events

</div>

These are created by <b>you</b> and can be triggered whenever you want.

</div>

Use them to:

</div>

connect systems together
trigger your own gameplay logic
send data between layers
create reusable scripting flows

</div>

Registering Events

<b>Important:</b> You must register an event before using it anywhere.

</div>

Server-side Event

A normal server-side event can be registered like this:

</div>

Client → Server Event

If the event is <b>triggered from client-side</b> but <b>registered on server-side</b>, the first argument must be <b>player</b>.

This happens because the client sends the local player together with the event data, allowing the server to know who triggered it.

</div>

CEF Notes

CEF behaves differently

</div>

CEF cannot communicate directly with server-side
CEF mainly communicates with client-side
Older documentation often describes CEF more restrictively, but newer support exists in later versions

In version 1.1:

</div>

``` Added: CEF: mp.events.add(string eventName, function handler) Added: CEF: mp.events.reset() Added: CEF: mp.events.remove(string eventName) Added: CEF: mp.events.call(string eventName) (alias to mp.trigger) Added: Client-side: Browser.call(eventName, arguments...) ```

</div>

Calling Events

<b>Tip:</b> Most event confusion comes from not knowing which side is calling which side.

</div>

Local

</div>

Same Side

</div>

Use this when you call an event on the same side it exists on.

</div>

Syntax

</div>

Remote

</div>

Server → Client

</div>

The server tells one player or multiple players to execute a client-side event.

</div>

Single player

</div>

All players

</div>

Filtered players

</div>

Remote

</div>

Client → Server

</div>

Use this when the client wants to trigger a server-side event.

</div>

Syntax

</div>

Bridge

</div>

Client ↔ CEF

</div>

CEF does not directly talk to server-side. It goes through the client.

</div>

Client → CEF

</div>

CEF → Client

</div>

Example Flow

Server command triggering a client effect

</div>

In this example, a player uses a server command, and the server tells that player's client to start a screen effect.

</div>

<div>

Server-side

</div>

<div>

Client-side

</div>

Cancelling and Managing Events

Method 1

</div>

Pause / Destroy

</div>

To control an event instance directly, you can use <b>mp.Event</b>.

</div>

Method 2

</div>

Remove from Tree

</div>

You can remove a specific handler, remove all handlers for an event, remove multiple events, or reset the whole tree.

</div>

Quick Reference

Cheat Sheet

</div>

Action	Method
Register local event	`mp.events.add(...)`
Call local event	`mp.events.call(...)`
Client to server	`mp.events.callRemote(...)`
Server to one client	`player.call(...)`
Server to all clients	`mp.players.call(...)`
CEF to client	`mp.trigger(...)`
Client to CEF	`browser.execute(...)`
Remove event	`mp.events.remove(...)`
Reset all events	`mp.events.reset()`

</div>

Summary

Events are the foundation of scripting in RAGE:MP
Built-in events are automatic, custom events are created by you
Always register events before using them
Server, client, and CEF each have different communication rules
You can disable, destroy, remove, or reset events when needed

</div>

Introduction​

Event Types​

Registering Events​

Server-side Event​

Client → Server Event​

CEF Notes​

Calling Events​

Example Flow​

Cancelling and Managing Events​

Quick Reference​

Summary​

See also​

Introduction

Event Types

Registering Events

Server-side Event

Client → Server Event

CEF Notes

Calling Events

Example Flow

Cancelling and Managing Events

Quick Reference

Summary

See also