Skip to main content
Branch: Release Candidate

VirtualEntity

Documentation

Hierarchy

  • WorldObject
    • VirtualEntity

Index

Constructors

Properties

Methods

Constructors

publicconstructor

  • new VirtualEntity(group: VirtualEntityGroup, position: Vector3, streamingDistance: number, data?: Record<string, any>): VirtualEntity

  • Creates a new Virtual Entity

Properties

publicdimension

dimension: number

Object dimension.

Remarks

Check https://docs.altv.mp/articles/dimensions.html to understand how it works.

publicreadonlygroup

group: VirtualEntityGroup

Virtual Entity Group this entity belongs to

publicreadonlyid

id: number

publicreadonlyisRemote

isRemote: boolean

Whether this entity was created clientside or serverside. (Clientside = false, Serverside = true).

publicreadonlyisStreamedIn

isStreamedIn: boolean

publicpos

pos: Vector3

Object position

publicreadonlyrefCount

refCount: number

Returns the ref count of the entity.

Remarks

It’s only available in debug-mode.

publicreadonlyremoteID

remoteID: number

The serverside id of this entity.

publicreadonlytype

type: BaseObjectType

Type of the object.

publicreadonlyvalid

valid: boolean

Object usability.

Returns

False if object is no longer usable.

publicvisible

visible: boolean

publicstaticreadonlyall

all: readonly VirtualEntity[]

Returns all Virtual Entity instances

publicstaticreadonlystreamedIn

streamedIn: readonly VirtualEntity[]

Methods

publicdeleteMeta

  • deleteMeta(key: string): void
  • deleteMeta<K>(key: K): void

publicdestroy

  • destroy(): void

  • Removes the object from the world.

publicgetMeta

  • getMeta<K>(key: Exclude<K, never>): unknown
  • getMeta<K>(key: K): undefined | ICustomBaseObjectMeta[K]
  • getMeta<V>(key: string): undefined | V

  • Type parameters

    • K: string

publicgetMetaDataKeys

  • getMetaDataKeys(): readonly string[]

publicgetStreamSyncedMeta

  • getStreamSyncedMeta<K>(key: Exclude<K, never>): unknown
  • getStreamSyncedMeta<K>(key: K): undefined | ICustomVirtualEntityStreamSyncedMeta[K]
  • getStreamSyncedMeta<V>(key: string): undefined | V

  • Gets a value using the specified key. Only available for server-side created Virtual Entities.

    Type parameters

    • K: string

publicgetStreamSyncedMetaKeys

  • getStreamSyncedMetaKeys(): readonly string[]

  • Returns all set meta keys of the Virtual Entity. Only available for server-side created Virtual Entities.

publicgetSyncedMeta

  • getSyncedMeta<K>(key: Exclude<K, never>): unknown
  • getSyncedMeta<K>(key: K): undefined | ICustomBaseObjectSyncedMeta[K]
  • getSyncedMeta<V>(key: string): undefined | V

  • Gets a value using the specified key.

    Type parameters

    • K: string

publicgetSyncedMetaKeys

  • getSyncedMetaKeys(): readonly string[]

publichasMeta

  • hasMeta(key: string): boolean
  • hasMeta<K>(key: K): boolean

publichasStreamSyncedMeta

  • hasStreamSyncedMeta(key: string): boolean
  • hasStreamSyncedMeta<K>(key: K): boolean

  • Determines whether contains the specified key. Only available for server-side created Virtual Entities.

publichasSyncedMeta

  • hasSyncedMeta(key: string): boolean
  • hasSyncedMeta<K>(key: K): boolean

  • Determines whether contains the specified key.

publicsetMeta

  • setMeta<K>(key: K, value: InterfaceValueByKey<ICustomBaseObjectMeta, K, unknown, void>): void
  • setMeta<K>(key: K, value: ICustomBaseObjectMeta[K]): void
  • setMeta<V, K>(key: K, value: InterfaceValueByKey<ICustomBaseObjectMeta, K, V, void>): void

  • Type parameters

    • K: string

publicstaticgetByID

  • getByID(type: BaseObjectType, id: number): null | BaseObject

  • Gets the base object with the given type and local id

publicstaticgetByRemoteID

  • getByRemoteID(type: BaseObjectType, id: number): null | BaseObject