Entity | custom alt:V docs JS

Hierarchy

WorldObject
- Entity
  - Player
  - Vehicle
  - Ped
  - Object

Index

Constructors

constructor

Properties

Accessors

model

Constructors

Protected constructor

new Entity(): Entity

Inherited from BaseObject.constructor
- Defined in types-shared/index.d.ts:2543
Returns Entity

Properties

collision

collision: boolean

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 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.

Readonly refCount

refCount: number

Returns the ref count of the entity.

remarks: It's only available in debug-mode.

rot

rot: Vector3

Entity rotation.

remarks: Values are provided in radians.

streamed

streamed: boolean

Whether the entity should be streamed for other entities.

streamingDistance

streamingDistance: number

Readonly timestamp

timestamp: number

Readonly type

type: BaseObjectType

Type of the object.

Readonly valid

valid: boolean

Object usability.

returns: False if object is no longer usable.

visible

visible: boolean

Whether the entity is visible.

Static Readonly all

all: readonly Entity[]

Array with all entities.

remarks

This creates a clone of the array everytime it is called. It is advised to call this once and store the result in a variable, before iterating over it.

example

const entities = alt.Entity.all; // Store it in a variable, so it doesn't create a copy of the array on each iteration
for(let i = 0; i < entities.length; i++)
{
  alt.log(`${entities[i].id}`); // Logs the id of every entity
}

Accessors

model

get model(): number
set model(model: number | string): any

- Defined in types-server/index.d.ts:836
Entity model hash.

Returns number
- Defined in types-server/index.d.ts:837
Entity model hash.

Parameters
- model: number | string
Returns any

Methods

attachTo

attachTo(entity: Entity, entityBone: number | string, ownBone: number | string, pos: IVector3, rot: IVector3, enableCollisions: boolean, noFixedRotation: boolean): void

- Defined in types-server/index.d.ts:996
Attaches this entity to another entity.

Parameters
- entity: Entity
  
  Target entity.
- entityBone: number | string
  
  Target bone id or name.
- ownBone: number | string
  
  Origin bone id or name.
- pos: IVector3
  
  Position offset.
- rot: IVector3
  
  Rotation - needs to be in radians.
- enableCollisions: boolean
  
  If true the attached entity has a collision.
- noFixedRotation: boolean
  
  If false the entity is attached with a fixed rotation (no bouncing). That means if the value in native was true, you have to use false in the serverside method
Returns void

deleteMeta

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

Overrides BaseObject.deleteMeta
- Defined in types-server/index.d.ts:861
Parameters
- key: string
Returns void
Overrides BaseObject.deleteMeta
- Defined in types-server/index.d.ts:862
Type parameters
- K: shared.ExtractStringKeys<ICustomEntityMeta>
Parameters
- key: K
Returns void

deleteStreamSyncedMeta

deleteStreamSyncedMeta(key: string): void
deleteStreamSyncedMeta<K>(key: K): void

- Defined in types-server/index.d.ts:920
Removes the specified key and the data connected to that specific key.

Parameters
- key: string
  
  The key of the value to remove.
Returns void
- Defined in types-server/index.d.ts:921
Type parameters
- K: shared.ExtractStringKeys<ICustomEntityStreamSyncedMeta>
Parameters
- key: K
Returns void

deleteSyncedMeta

deleteSyncedMeta(key: string): void
deleteSyncedMeta<K>(key: K): void

Overrides BaseObject.deleteSyncedMeta
- Defined in types-server/index.d.ts:877
Removes the specified key and the data connected to that specific key.

Parameters
- key: string
  
  The key of the value to remove.
Returns void
Overrides BaseObject.deleteSyncedMeta
- Defined in types-server/index.d.ts:878
Type parameters
- K: shared.ExtractStringKeys<ICustomEntitySyncedMeta>
Parameters
- key: K
Returns void

destroy

destroy(): void

Inherited from BaseObject.destroy
- Defined in types-shared/index.d.ts:2563
Removes the object from the world.

Returns void

detach

detach(): void

- Defined in types-server/index.d.ts:1001
Detaches this entity if attached to another entity.

Returns void

getMeta

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

Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:864
Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomEntityMeta>
Returns unknown
Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:865
Type parameters
- K: shared.ExtractStringKeys<ICustomEntityMeta>
Parameters
- key: K
Returns ICustomEntityMeta[K] | undefined
Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:867
deprecated

See ICustomEntityMeta

Type parameters
- V: any
Parameters
- key: string
Returns V | undefined

getMetaDataKeys

getMetaDataKeys(): readonly string[]

Inherited from BaseObject.getMetaDataKeys
- Defined in types-shared/index.d.ts:2593
Returns readonly string[]

getStreamSyncedMeta

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

- Defined in types-server/index.d.ts:929
Gets a value using the specified key.

Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomEntityStreamSyncedMeta>
  
  The key of the value to get.
Returns unknown

Dynamic value associated with the specified key or undefined if no data is present.
- Defined in types-server/index.d.ts:930
Type parameters
- K: shared.ExtractStringKeys<ICustomEntityStreamSyncedMeta>
Parameters
- key: K
Returns ICustomEntityStreamSyncedMeta[K] | undefined
- Defined in types-server/index.d.ts:932
deprecated

See "alt-shared".ICustomEntityStreamSyncedMeta

Type parameters
- V: any
Parameters
- key: string
Returns V | undefined

getStreamSyncedMetaKeys

getStreamSyncedMetaKeys(): readonly string[]

- Defined in types-server/index.d.ts:943
Returns readonly string[]

getSyncedMeta

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

Overrides BaseObject.getSyncedMeta
- Defined in types-server/index.d.ts:886
Gets a value using the specified key.

Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomEntitySyncedMeta>
  
  The key of the value to get.
Returns unknown

Dynamic value associated with the specified key or undefined if no data is present.
Overrides BaseObject.getSyncedMeta
- Defined in types-server/index.d.ts:887
Type parameters
- K: shared.ExtractStringKeys<ICustomEntitySyncedMeta>
Parameters
- key: K
Returns ICustomEntitySyncedMeta[K] | undefined
Overrides BaseObject.getSyncedMeta
- Defined in types-server/index.d.ts:889
deprecated

See "alt-shared".ICustomEntitySyncedMeta

Type parameters
- V: any
Parameters
- key: string
Returns V | undefined

getSyncedMetaKeys

getSyncedMetaKeys(): readonly string[]

Overrides BaseObject.getSyncedMetaKeys
- Defined in types-server/index.d.ts:900
Returns readonly string[]

hasMeta

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

Overrides BaseObject.hasMeta
- Defined in types-server/index.d.ts:869
Parameters
- key: string
Returns boolean
Overrides BaseObject.hasMeta
- Defined in types-server/index.d.ts:870
Type parameters
- K: shared.ExtractStringKeys<ICustomEntityMeta>
Parameters
- key: K
Returns boolean

hasStreamSyncedMeta

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

- Defined in types-server/index.d.ts:940
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
- Defined in types-server/index.d.ts:941
Type parameters
- K: shared.ExtractStringKeys<ICustomEntityStreamSyncedMeta>
Parameters
- key: K
Returns boolean

hasSyncedMeta

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

Overrides BaseObject.hasSyncedMeta
- Defined in types-server/index.d.ts:897
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
Overrides BaseObject.hasSyncedMeta
- Defined in types-server/index.d.ts:898
Type parameters
- K: shared.ExtractStringKeys<ICustomEntitySyncedMeta>
Parameters
- key: K
Returns boolean

resetNetOwner

resetNetOwner(disableMigration?: boolean): void

- Defined in types-server/index.d.ts:983
Resets overwritten network owner.

remarks

See {@link Entity~netOwner} to understand how network owner works.

Keep in mind that disabling migration can lead to unexpected behaviour when the network owner gets out of the streaming range.

Parameters
- Optional disableMigration: boolean
  
  Pass true to disable migration, false to keep it enabled. If not specified, it defaults to "false".
Returns void

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

Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:856
Type parameters
- K: string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomEntityMeta, K>
Returns void
Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:857
Type parameters
- K: shared.ExtractStringKeys<ICustomEntityMeta>
Parameters
- key: K
- value: ICustomEntityMeta[K]
Returns void
Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:859
deprecated

See ICustomEntityMeta

Type parameters
- V: any
- K: string = string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomEntityMeta, K, V>
Returns void

setNetOwner

setNetOwner(player: Player, disableMigration?: boolean): void

- Defined in types-server/index.d.ts:970
Changes network owner to the specified player.

remarks

See {@link Entity~netOwner} to understand how network owner works.

Keep in mind that disabling migration can lead to unexpected behaviour when the network owner gets out of the streaming range.

Parameters
- player: Player
  
  The given player that will be set as new network owner.
- Optional disableMigration: boolean
  
  Pass true to disable migration, false to keep it enabled. If not specified, it defaults to "false".
Returns void

setStreamSyncedMeta

setStreamSyncedMeta<K>(key: K, value: shared.InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K>): void
setStreamSyncedMeta<K>(key: K, value: ICustomEntityStreamSyncedMeta[K]): void
setStreamSyncedMeta<V, K>(key: K, value: shared.InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K, V>): void

- Defined in types-server/index.d.ts:953
Stores the given value with the specified key.

remarks

The given value will be shared with all clients in streaming range.

Type parameters
- K: string
Parameters
- key: K
  
  The key of the value to store.
- value: shared.InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K>
  
  The value to store.
Returns void
- Defined in types-server/index.d.ts:954
Type parameters
- K: shared.ExtractStringKeys<ICustomEntityStreamSyncedMeta>
Parameters
- key: K
- value: ICustomEntityStreamSyncedMeta[K]
Returns void
- Defined in types-server/index.d.ts:956
deprecated

See "alt-shared".ICustomEntityStreamSyncedMeta

Type parameters
- V: any
- K: string = string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K, V>
Returns void

setSyncedMeta

setSyncedMeta<K>(key: K, value: shared.InterfaceValueByKey<ICustomEntitySyncedMeta, K>): void
setSyncedMeta<K>(key: K, value: ICustomEntitySyncedMeta[K]): void
setSyncedMeta<V, K>(key: K, value: shared.InterfaceValueByKey<ICustomEntitySyncedMeta, K, V>): void

Overrides BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:910
Stores the given value with the specified key.

remarks

The given value will be shared with all clients.

Type parameters
- K: string
Parameters
- key: K
  
  The key of the value to store.
- value: shared.InterfaceValueByKey<ICustomEntitySyncedMeta, K>
  
  The value to store.
Returns void
Overrides BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:911
Type parameters
- K: shared.ExtractStringKeys<ICustomEntitySyncedMeta>
Parameters
- key: K
- value: ICustomEntitySyncedMeta[K]
Returns void
Overrides BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:913
deprecated

See "alt-shared".ICustomEntitySyncedMeta

Type parameters
- V: any
- K: string = string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomEntitySyncedMeta, K, V>
Returns void

Static getByID

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

Inherited from BaseObject.getByID
- Defined in types-server/index.d.ts:672
Gets the base object with the given type and id

Parameters
- type: BaseObjectType
- id: number
Returns BaseObject | null

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Returns Entity

Properties

collision

dimension

frozen

Readonly id

Readonly netOwner

pos

Readonly refCount

rot

streamed

streamingDistance

Readonly timestamp

Readonly type

Readonly valid

visible

Static Readonly all

Accessors

model

Returns number

Parameters

model: number | string

Returns any

Methods

attachTo

Parameters

entity: Entity

entityBone: number | string

ownBone: number | string

pos: IVector3

rot: IVector3

enableCollisions: boolean

noFixedRotation: boolean

Returns void

deleteMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomEntityMeta>

Parameters

key: K

Returns void

deleteStreamSyncedMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomEntityStreamSyncedMeta>

Parameters

key: K

Returns void

deleteSyncedMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomEntitySyncedMeta>

Parameters

key: K

Returns void

destroy

Returns void

detach

Returns void

getMeta

Type parameters

K: string

Parameters

key: Exclude<K, keyof ICustomEntityMeta>

Returns unknown

Type parameters