VimpServerBuiltinEvents

@vimp-mp/types 2.0.1

Interface · Server API

Built-in server-side events. Handlers receive positional arguments that match the signature here.

interface VimpServerBuiltinEvents

Members

objectCreated

objectCreated: (object: GameObject) => void

Fires after a server object has been created and registered.

objectDestroyed

objectDestroyed: (object: GameObject) => void

Fires when a server object is destroyed.

playerConnected

playerConnected: (player: Player) => void

Fires after a player has joined and their server wrapper is available.

playerDimensionChange

playerDimensionChange: (player: Player, oldDim: number, newDim: number) => void

Fired after a player's dimension has changed (either explicitly via player.dimension = N or as a cascade from a vehicle's dimension change). The event fires AFTER all visibility recomputes and any auto-exit-from-vehicle, so observable state is final by the time the handler runs.

playerDisconnected

playerDisconnected: (player: Player) => void

Fires with the player's cached final state after their connection closes.

playerEnterColshape

playerEnterColshape: (player: Player, colshape: Colshape | null) => void

Fired when a player enters a colshape. colshape may be null if the colshape was destroyed between the server emitting and JS dispatching the event — handlers should null-check.

playerEnterVehicle

playerEnterVehicle: (player: Player, vehicle: Vehicle, seat: number) => void

Fires after a player enters a vehicle seat.

playerExitColshape

playerExitColshape: (player: Player, colshape: Colshape | null) => void

Fired when a player exits a colshape (or the colshape is destroyed while inside).

playerExitVehicle

playerExitVehicle: (player: Player, vehicle: Vehicle, seat: number) => void

Fires after a player leaves a vehicle seat.

playerVoiceChannelChange

playerVoiceChannelChange: (player: Player, oldChannelId: number | null, newChannelId: number | null) => void

Fires after the player's active voice channel changes.

playerVoiceStart

playerVoiceStart: (player: Player, route: VoiceRoute) => void

Fires when the player starts transmitting over the supplied voice route.

playerVoiceStop

playerVoiceStop: (player: Player, route: VoiceRoute) => void

Fires when the player stops transmitting over the supplied voice route.

vehicleCreated

vehicleCreated: (vehicle: Vehicle) => void

Fires after a server vehicle has been created and registered.

vehicleDestroyed

vehicleDestroyed: (vehicle: Vehicle) => void

Fires when a server vehicle is destroyed.