Client API

@vimp-mp/types 2.0.1

Streamed entities, browsers, cameras, input, storage, voice, and client events.

Declaration	Description
Blip	Server-known blip.
BlipCreateOptions	Initial state applied when creating a client-local map blip.
BlipManager	Creates client-local blips and tracks server-owned blip wrappers.
Browser	CEF (Chromium Embedded Framework) UI overlay.
BrowserManager	Creates and tracks CEF browser overlays.
Camera	Scripted or gameplay camera exposed by the client runtime.
CameraManager	Creates scripted cameras and exposes the gameplay camera.
ChatMessagePayload	Chat message delivered by the multiplayer server.
Colshape	Server-known colshape trigger volume.
ColshapeCreateOptions	Metadata applied when creating a client-local colshape.
ColshapeManager	Creates client-local colshapes and tracks server-owned trigger volumes.
ColshapeType	Geometric kind of a client colshape wrapper.
ConnectionManager	Controls the multiplayer server connection.
ConnectionState	Current multiplayer connection state exposed to client scripts.
ConnectionStateChangedPayload	Connection details delivered after a connect or disconnect transition.
CursorManager	Controls the CEF mouse cursor and reports its screen position.
EntityMetaReader	Read-only view of an entity's stream-synced meta from client code.
EntityTypeId	Discriminant matching EntityType::as_u8 on the server.
EntityTypeMap	Numeric discriminants used by the generic client entity metadata API.
Marker	Server-known marker.
MarkerCreateOptions	Initial state applied when creating a client-local marker.
MarkerManager	Creates client-local markers and tracks server-owned marker wrappers.
NametagManager	Controls rendering of multiplayer player nametags.
Object	Server-known object.
ObjectCreateOptions	Initial state applied when creating a client-local object.
ObjectManager	Creates client-local objects and tracks server-owned object wrappers.
Ped	Client-created local ped or server-known ped.
PedCreateOptions	Initial state applied when creating a client-local ped.
PedManager	Manages ped instances in this scripting context.
Player	Player known to this client.
PlayerManager	Provides access to the local player and remote players known to the client.
PlayerVehicleEventPayload	Payload emitted when the local player enters or leaves a vehicle.
Rgb	RGB color with byte-sized channels.
StorageManager	Persistent JSON storage scoped to the current server.
StreamSyncedMetaChangePayload	Describes one replicated entity-metadata update observed by the client.
Vehicle	Server-known vehicle.
VehicleCreateOptions	Initial state applied when creating a client-local vehicle.
VehicleLightState	Current low-beam and high-beam state of a vehicle.
VehicleManager	Creates local vehicles and tracks server-owned vehicle wrappers.
VimpClient	Root API installed as the global vimp object in client scripts.
VimpClientBuiltinEvents	Built-in client-side events.
VimpClientEvents	Custom events received from the server (broadcast via vimp.emitAllClients or sent to one player via player.emit).
VimpDrawTextOptions	Optional GTA text-rendering state applied by vimp.graphics.drawText.
VimpGraphics	Immediate-mode screen drawing helpers.
VimpServerInboundEvents	Custom events the client sends to the server (vimp.emitServer).
VoiceChannelChangedPayload	Previous and current channel IDs after a local voice-route change.
VoiceErrorPayload	Structured diagnostic information emitted by the voice subsystem.
VoiceErrorReason	Stable category suitable for localized handling of a voice error.
VoiceManager	Exposes local voice state, channels, and per-player playback controls.
VoiceState	Snapshot of the local voice subsystem state.