VimpClient

@vimp-mp/types 2.0.1

Interface · Client API

Root API installed as the global vimp object in client scripts.

interface VimpClient

Members

blips

readonly blips: BlipManager

Local and streamed blip manager.

browsers

readonly browsers: BrowserManager

CEF browser manager.

cameras

readonly cameras: CameraManager

Scripted and gameplay camera manager.

colshapes

readonly colshapes: ColshapeManager

Local and streamed colshape manager.

connection

readonly connection: ConnectionManager

Multiplayer connection controls.

cursor

readonly cursor: CursorManager

CEF cursor controls.

entities

readonly entities: EntityMetaReader

Generic stream-synced meta reader for any entity. For Player there are also class-level shortcuts on the Player instance that bind type and the server player id implicitly. For entity wrappers with separate client-local ids, pass entity.remoteId.

graphics

readonly graphics: VimpGraphics

Screen drawing helpers.

markers

readonly markers: MarkerManager

Local and streamed marker manager.

nametags

readonly nametags: NametagManager

Multiplayer nametag controls.

natives

readonly natives: VimpNatives

Typed GTA V native namespaces.

objects

readonly objects: ObjectManager

Local and streamed object manager.

peds

readonly peds: PedManager

Local and streamed ped manager.

players

readonly players: PlayerManager

Local and remote player manager.

storage

readonly storage: StorageManager

Server-scoped persistent storage.

vehicles

readonly vehicles: VehicleManager

Local and streamed vehicle manager.

voice

readonly voice: VoiceManager

Voice state and playback controls.

emitServer

emitServer<K extends never>(event: K, data: VimpServerInboundEvents[K]): void

emitServer(event: string, data: unknown): void

Send a custom event to the server. data is JSON-serialized unless it is already a string.

notify

notify(text: string): void

Show a HUD notification. Supports GTA color codes (~r~, ~g~, ...).

on

on<K extends keyof VimpClientBuiltinEvents>(event: K, callback: VimpClientBuiltinEvents[K]): void

on<K extends never>(event: K, callback: (data: VimpClientEvents[K]) => void): void

on(event: string, callback: (...args: Array<any>) => void): void

Registers a handler for a built-in client event.