Server API

@vimp-mp/types 2.0.1

Players, entities, world state, voice, lifecycle, and server events.

Declaration	Description
Blip	World blip handle returned by vimp.blips.create.
BlipExtras	Initial state applied when creating a server blip.
BlipManager	Manages blip instances in this scripting context.
Checkpoint	World checkpoint handle returned by vimp.checkpoints.create.
CheckpointColor	RGBA colour used by a checkpoint.
CheckpointExtras	Initial state applied when creating a server checkpoint.
CheckpointManager	Manages checkpoint instances in this scripting context.
Colshape	Server-side trigger volume returned by vimp.colshapes.create*.
ColshapeExtras	Initial state applied when creating a server colshape.
ColshapeManager	Manages colshape instances in this scripting context.
ColshapeType	Geometric kind of a colshape trigger volume.
GameObject	World object handle returned by vimp.objects.create.
Marker	World marker handle returned by vimp.markers.create.
MarkerColor	RGBA colour used by Marker.color.
MarkerExtras	Initial state applied when creating a server marker.
MarkerManager	Manages marker instances in this scripting context.
ObjectCreateOptions	Initial state applied when creating a server object.
ObjectManager	Manages object instances in this scripting context.
Ped	Server-spawned NPC (pedestrian).
PedExtras	Initial state applied when creating a server ped.
PedManager	Manages ped instances in this scripting context.
Player	Player currently connected to the server.
PlayerManager	Provides access to all players currently connected to the server.
StreamSyncedMeta	Metadata replicated with an entity to clients that currently stream it.
Vehicle	Server-spawned vehicle handle returned by vimp.vehicles.create.
VehicleExtras	Initial state applied when creating a server vehicle.
VehicleManager	Creates and tracks authoritative server vehicles.
VimpClientInboundEvents	Custom events sent from server to a specific client (via player.emit) or broadcast to all clients (via vimp.emitAllClients).
VimpServer	Root API installed as the global vimp object in server scripts.
VimpServerBuiltinEvents	Built-in server-side events.
VimpServerEvents	Custom events sent by clients via vimp.emitServer(event, data).
VoiceChannel	Server-owned voice channel and its per-player routing permissions.
VoiceChannelCreateOptions	Optional routing behaviour applied when a voice channel is created.
VoiceManager	Creates and looks up server-owned voice channels.
WorldManager	Authoritative server-side world state.
WorldTime	Snapshot of the in-game clock.