ClientEvents

API reference for ClientEvents in @erlcjs/core.

Interface mapping client event names to their callback parameters.

Signature:

interface ClientEvents

#Properties

Property

Modifiers

Type

Description

COMMAND

[log: CommandLog]

Emitted when a server command is run.

CUSTOM_COMMAND

[player: Player, command: string, args: string[]]

Emitted when a custom command is executed in-game.

EMERGENCY_CALL_ADD

[call: EmergencyCall]

Emitted when an emergency call is created.

EMERGENCY_CALL_REMOVE

[call: EmergencyCall]

Emitted when an emergency call is cleared.

EMERGENCY_CALL_UPDATE

[oldCall: EmergencyCall | null, newCall: EmergencyCall]

Emitted when an emergency call is updated.

error

[error: unknown]

Emitted when an error is caught during polling or gateway operations.

JOIN_LOG

[log: JoinLog]

Emitted when a join or leave log entry is received.

KILL

[kill: KillLog]

Emitted when a player is killed.

MOD_CALL_ANSWERED

[call: ModCall]

Emitted when a mod call is answered by a moderator.

MOD_CALL

[call: ModCall]

Emitted when a player requests moderator assistance.

PLAYER_JOIN

[player: Player]

Emitted when a player joins a server.

PLAYER_LEAVE

[player: Player]

Emitted when a player leaves a server.

PLAYER_UPDATE

[oldPlayer: Player | null, newPlayer: Player]

Emitted when a player's data updates.

POLL

[server: Server]

Emitted when a periodic server poll finishes.

READY

[]

Emitted when every configured server has completed its first poll and the client is ready.

SERVER_CREATE

[server: ServerInfo]

Emitted when server details are first loaded.

SERVER_OFFLINE

[server: Server]

Emitted when a server goes offline and its caches are cleared.

SERVER_ONLINE

[server: Server]

Emitted when an offline server recovers and becomes reachable again.

SERVER_READY

[server: Server]

Emitted when a server completes its first successful poll.

SERVER_UPDATE

[oldServer: ServerInfo | null, newServer: ServerInfo]

Emitted when server details are updated.

STAFF_ADD

[staff: Staff, type: 'Admin' | 'Mod' | 'Helper']

Emitted when a player is given a staff role.

STAFF_REMOVE

[staff: Staff, type: 'Admin' | 'Mod' | 'Helper']

Emitted when a player is removed from a staff role.

VEHICLE_ADD

[vehicle: Vehicle]

Emitted when a vehicle is spawned.

VEHICLE_REMOVE

[vehicle: Vehicle]

Emitted when a vehicle is despawned.

VEHICLE_UPDATE

[oldVehicle: Vehicle | null, newVehicle: Vehicle]

Emitted when a vehicle's data updates.

WEBHOOK_PROBE

[server: Server]

Emitted when a player enters the webhook in-game.