VimpClientBuiltinEvents

@vimp-mp/types 2.0.1

Interface · Client API

Built-in client-side events. Handlers receive a single argument with the type shown here.

interface VimpClientBuiltinEvents

Members

blipCreated

blipCreated: (blip: Blip | null) => void

Fires when the client learns about a server blip.

blipDestroyed

blipDestroyed: (blip: Blip | null) => void

Fires when a server blip is removed from multiplayer state.

blipStreamIn

blipStreamIn: (blip: Blip | null) => void

Fires when a server blip receives a local map handle.

blipStreamOut

blipStreamOut: (blip: Blip | null) => void

Fires when a server blip releases its local map handle.

chatMessage

chatMessage: (payload: ChatMessagePayload) => void

Fires when a chat message is delivered by the server.

colshapeCreated

colshapeCreated: (colshape: Colshape | null) => void

Fires when the client learns about a server colshape.

colshapeDestroyed

colshapeDestroyed: (colshape: Colshape | null) => void

Fires when a server colshape is removed from multiplayer state.

colshapeStreamIn

colshapeStreamIn: (colshape: Colshape | null) => void

Fires when a server colshape enters the streaming range.

colshapeStreamOut

colshapeStreamOut: (colshape: Colshape | null) => void

Fires when a server colshape leaves the streaming range.

connectionStateChanged

connectionStateChanged: (state: ConnectionStateChangedPayload) => void

Fires after the multiplayer connection state changes.

keyDown

keyDown: (key: number) => void

Virtual-Key code (Win32 VK_*).

keyUp

keyUp: (key: number) => void

Fires when a keyboard key is released; receives a Win32 virtual-key code.

markerCreated

markerCreated: (marker: Marker | null) => void

Fires when the client learns about a server marker.

markerDestroyed

markerDestroyed: (marker: Marker | null) => void

Fires when a server marker is removed from multiplayer state.

markerStreamIn

markerStreamIn: (marker: Marker | null) => void

Fires when a server marker enters the streaming range.

markerStreamOut

markerStreamOut: (marker: Marker | null) => void

Fires when a server marker leaves the streaming range.

objectCreated

objectCreated: (object: Object | null) => void

Fires when the client learns about a server object.

objectDestroyed

objectDestroyed: (object: Object | null) => void

Fires when a server object is removed from multiplayer state.

objectStreamIn

objectStreamIn: (object: Object | null) => void

Fires when a server object receives a local GTA handle.

objectStreamOut

objectStreamOut: (object: Object | null) => void

Fires when a server object releases its local GTA handle.

pedCreated

pedCreated: (ped: Ped | null) => void

Fires when the client learns about a server ped.

pedDestroyed

pedDestroyed: (ped: Ped | null) => void

Fires when a server ped is removed from multiplayer state.

pedStreamIn

pedStreamIn: (ped: Ped | null) => void

Fires when a server ped receives a local GTA handle.

pedStreamOut

pedStreamOut: (ped: Ped | null) => void

Fires when a server ped releases its local GTA handle.

playerConnected

playerConnected: (player: Player) => void

Fires when a player wrapper is added to the client registry.

playerDisconnected

playerDisconnected: (player: Player) => void

Fires when a player connection closes and its wrapper is removed.

playerEnterVehicle

playerEnterVehicle: (payload: PlayerVehicleEventPayload) => void

Fires after the local player enters a vehicle seat.

playerLeaveVehicle

playerLeaveVehicle: (payload: PlayerVehicleEventPayload) => void

Fires after the local player leaves a vehicle seat.

playerStreamIn

playerStreamIn: (player: Player) => void

Fires when a remote player's native ped enters the streaming range.

playerStreamOut

playerStreamOut: (player: Player) => void

Fires when a remote player's native ped leaves the streaming range.

render

render: () => void

Fires once for each rendered frame. Receives no payload.

streamSyncedMetaChange

streamSyncedMetaChange: (payload: StreamSyncedMetaChangePayload) => void

Fires whenever a stream-synced meta key changes for an entity currently visible to this client — including every key in the initial snapshot at StreamIn (with oldValue: undefined) and on Delete (with newValue: undefined). Does NOT fire when an entity leaves the streaming range (the local store is just cleared silently).

vehicleCreated

vehicleCreated: (vehicle: Vehicle | null) => void

Fires when the client learns about a server vehicle.

vehicleDestroyed

vehicleDestroyed: (vehicle: Vehicle | null) => void

Fires when a server vehicle is removed from multiplayer state.

vehicleStreamIn

vehicleStreamIn: (vehicle: Vehicle | null) => void

Fires when a server vehicle receives a local GTA handle.

vehicleStreamOut

vehicleStreamOut: (vehicle: Vehicle | null) => void

Fires when a server vehicle releases its local GTA handle.

voiceChannelChanged

voiceChannelChanged: (payload: VoiceChannelChangedPayload) => void

Fires after the local player's active voice channel changes.

voiceChannelsChanged

voiceChannelsChanged: () => void

Fires when the server-provided voice-channel list changes.

voiceError

voiceError: (payload: VoiceErrorPayload) => void

Fires when the voice subsystem reports a recoverable or fatal error.

voiceStart

voiceStart: (player: Player) => void

Fires when a remote player starts transmitting voice audio.

voiceStop

voiceStop: (player: Player) => void

Fires when a remote player stops transmitting voice audio.