EntityMetaReader

@vimp-mp/types 2.0.1

Interface · Client API

Read-only view of an entity's stream-synced meta from client code. Mutations live on the server side; clients only observe.

interface EntityMetaReader

Members

readonly ENTITY_TYPE: EntityTypeMap

Stable entity type discriminants accepted by every reader method.

getStreamSyncedMeta<T = unknown>(type: EntityTypeId, id: number, key: string): T | undefined

Returns undefined if the key isn't set or the remote entity isn't currently streamed.

getStreamSyncedMetaKeys(type: EntityTypeId, id: number): Array<string>

Uses the server/network entity id. For wrappers, pass entity.remoteId, not client-local entity.id.

hasStreamSyncedMeta(type: EntityTypeId, id: number, key: string): boolean

Uses the server/network entity id. For wrappers, pass entity.remoteId, not client-local entity.id.