Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Properties

Readonly alpha

alpha: number

dimension

dimension: number

Object dimension.

remarks

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

frozen

frozen: boolean

Readonly id

id: number

Readonly isRemote

isRemote: boolean

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

Readonly isSpawned

isSpawned: boolean

Returns whether the entity is spawned in the game world.

remarks

This does the same thing as checking if the scriptID is 0.

Readonly lodDistance

lodDistance: number

The distance at which the LOD model of the object starts being applied.

Readonly netOwner

netOwner: Player | null

Network owner of the entity.

remarks

Network owner is responsible for syncing entity with the server. It changes when actual network owner passes the migration range, then the new one is determined based on distance from the entity (if entity is a vehicle, then the driver will take priority for becoming network owner). Disabling migration range will stop this process from happening until turned on again.

pos

pos: Vector3

Object position.

remarks

Setting this throws an error if the client is not the network owner of an entity

Readonly refCount

refCount: number

Returns the ref count of the entity.

remarks

It's only available in debug-mode.

Readonly remoteID

remoteID: number

The serverside id of this entity.

rot

rot: Vector3

Entity rotation in radians

remarks

Setting this throws an error if the client is not the network owner of an entity

Readonly scriptID

scriptID: number

Internal game id that can be used in native calls

Readonly textureVariation

textureVariation: number

Readonly type

type: BaseObjectType

Type of the object.

Readonly valid

valid: boolean

Object usability.

returns

False if object is no longer usable.

Readonly visible

visible: boolean

Static Readonly all

all: readonly Object[]

Static Readonly count

count: number

Static Readonly streamedIn

streamedIn: readonly Object[]

Accessors

model

  • get model(): number

  • Hash of entity model

    Returns number

Methods

deleteMeta

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

destroy

  • destroy(): void

  • Removes the object from the world.

    Returns void

getMeta

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

getMetaDataKeys

  • getMetaDataKeys(): readonly string[]

getStreamSyncedMeta

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

getStreamSyncedMetaKeys

  • getStreamSyncedMetaKeys(): readonly string[]

getSyncInfo

getSyncedMeta

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

getSyncedMetaKeys

  • getSyncedMetaKeys(): readonly string[]

hasMeta

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

hasStreamSyncedMeta

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

  • Determines whether contains the specified key.

    Parameters

    • key: string

      The key of the value to locate.

    Returns boolean

    True if the meta table contains any data at the specified key or False if not

  • Type parameters

    Parameters

    • key: K

    Returns boolean

hasSyncedMeta

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

setMeta

  • setMeta<K>(key: K, value: shared.InterfaceValueByKey<ICustomEntityMeta, K>): void
  • setMeta<K>(key: K, value: ICustomEntityMeta[K]): void
  • setMeta<V, K>(key: K, value: shared.InterfaceValueByKey<ICustomEntityMeta, K, V>): void

Static getByID

  • getByID(id: number): Object | null

Static getByRemoteID

  • getByRemoteID(id: number): Object | null

  • Gets the object with the given remote id

    Parameters

    • id: number

    Returns Object | null

Static getByScriptID

  • getByScriptID(scriptID: number): Entity | null

  • Retrieves the entity from the pool.

    Parameters

    • scriptID: number

      The script id of the entity.

    Returns Entity | null

    Entity if it was found, otherwise null.