GameObject

@vimp-mp/types 2.0.1

Interface · Server API

World object handle returned by vimp.objects.create.

interface GameObject extends StreamSyncedMeta

Members

alpha

alpha: number

Entity alpha, clamped by runtime to 0-255.

dimension

dimension: number

Virtual world (dimension). The object is visible only to players in the same dimension. Defaults to 0.

id

readonly id: number

Server-assigned object identifier.

isExists

readonly isExists: boolean

Whether the object is still registered with the server runtime.

model

model: number

GTA object model hash.

position

position: Vec3

Authoritative world position replicated to streaming clients.

rotation

rotation: Vec3

Authoritative rotation in degrees replicated to streaming clients.

deleteStreamSyncedMeta

deleteStreamSyncedMeta(key: string): void

Deletes key and propagates the removal to streaming clients.

destroy

destroy(): boolean

Destroy the object and unregister it from vimp.objects.

getStreamSyncedMeta

getStreamSyncedMeta<T = unknown>(key: string): T | undefined

Returns undefined if the key is unset.

getStreamSyncedMetaKeys

getStreamSyncedMetaKeys(): Array<string>

Returns all stream-synced metadata keys stored on the entity.

hasStreamSyncedMeta

hasStreamSyncedMeta(key: string): boolean

Returns whether the entity has a value for key.

setStreamSyncedMeta

setStreamSyncedMeta(key: string, value: unknown): void

Set or replace one key. The value is forwarded to every player currently streaming this entity, plus included in the snapshot for any future stream-in. Use deleteStreamSyncedMeta rather than undefined when the key must be removed.