VirtualEntity | custom alt:V docs JS

Documentation

Hierarchy

WorldObject
- VirtualEntity

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overrides BaseObject.constructor
- Defined in types-server/index.d.ts:746
Creates a new Virtual Entity

Parameters
- group: VirtualEntityGroup
- position: Vector3
- streamingDistance: number
- Optional data: Record<string, any>
Returns VirtualEntity

Properties

dimension

dimension: number

Object dimension.

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

Readonly group

group: VirtualEntityGroup

Virtual Entity Group this entity belongs to

Readonly id

id: number

pos

pos: Vector3

Object position.

Readonly refCount

refCount: number

Returns the ref count of the entity.

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

Readonly streamingDistance

streamingDistance: number

Streaming range for the virtual entity

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

Static Readonly all

all: readonly VirtualEntity[]

Returns all Virtual Entity instances

Methods

deleteMeta

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

Inherited from BaseObject.deleteMeta

Overrides BaseObject.deleteMeta
- Defined in types-server/index.d.ts:674
Parameters
- key: string
Returns void
Inherited from BaseObject.deleteMeta

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

deleteStreamSyncedMeta

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

- Defined in types-server/index.d.ts:801
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:802
Type parameters
- K: shared.ExtractStringKeys<ICustomVirtualEntityStreamSyncedMeta>
Parameters
- key: K
Returns void

deleteSyncedMeta

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

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

Parameters
- key: string
  
  The key of the value to remove.
Returns void
Inherited from BaseObject.deleteSyncedMeta
- Defined in types-server/index.d.ts:696
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectSyncedMeta>
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

getMeta

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

Inherited from BaseObject.getMeta

Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:680
Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomBaseObjectMeta>
Returns unknown
Inherited from BaseObject.getMeta

Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:681
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectMeta>
Parameters
- key: K
Returns ICustomBaseObjectMeta[K] | undefined
Inherited from BaseObject.getMeta

Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:683
deprecated

See ICustomBaseObjectMeta

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 ICustomVirtualEntityStreamSyncedMeta>): unknown
getStreamSyncedMeta<K>(key: K): ICustomVirtualEntityStreamSyncedMeta[K] | undefined
getStreamSyncedMeta<V>(key: string): V | undefined

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

Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomVirtualEntityStreamSyncedMeta>
  
  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:768
Type parameters
- K: shared.ExtractStringKeys<ICustomVirtualEntityStreamSyncedMeta>
Parameters
- key: K
Returns ICustomVirtualEntityStreamSyncedMeta[K] | undefined
- Defined in types-server/index.d.ts:770
deprecated

See "alt-shared".ICustomVirtualEntityStreamSyncedMeta

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

getStreamSyncedMetaKeys

getStreamSyncedMetaKeys(): readonly string[]

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

getSyncedMeta

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

Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2614
Gets a value using the specified key.

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

Dynamic value associated with the specified key or undefined if no data is present.
Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2615
Type parameters
- K: ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
Returns ICustomBaseObjectSyncedMeta[K] | undefined
Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2617
deprecated

See "alt-shared".ICustomBaseObjectSyncedMeta

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

getSyncedMetaKeys

getSyncedMetaKeys(): readonly string[]

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

hasMeta

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

Inherited from BaseObject.hasMeta

Overrides BaseObject.hasMeta
- Defined in types-server/index.d.ts:677
Parameters
- key: string
Returns boolean
Inherited from BaseObject.hasMeta

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

hasStreamSyncedMeta

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

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

hasSyncedMeta

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

Inherited from BaseObject.hasSyncedMeta
- Defined in types-shared/index.d.ts:2625
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
Inherited from BaseObject.hasSyncedMeta
- Defined in types-shared/index.d.ts:2626
Type parameters
- K: ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
Returns boolean

setMeta

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

Inherited from BaseObject.setMeta

Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:685
Type parameters
- K: string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomBaseObjectMeta, K>
Returns void
Inherited from BaseObject.setMeta

Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:686
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectMeta>
Parameters
- key: K
- value: ICustomBaseObjectMeta[K]
Returns void
Inherited from BaseObject.setMeta

Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:688
deprecated

See ICustomBaseObjectMeta

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

setStreamSyncedMeta

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

- Defined in types-server/index.d.ts:791
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<ICustomVirtualEntityStreamSyncedMeta, K>
  
  The value to store.
Returns void
- Defined in types-server/index.d.ts:792
Type parameters
- K: shared.ExtractStringKeys<ICustomVirtualEntityStreamSyncedMeta>
Parameters
- key: K
- value: ICustomVirtualEntityStreamSyncedMeta[K]
Returns void
- Defined in types-server/index.d.ts:794
deprecated

See "alt-shared".ICustomVirtualEntityStreamSyncedMeta

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

setSyncedMeta

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

Inherited from BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:706
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<ICustomBaseObjectSyncedMeta, K>
  
  The value to store.
Returns void
Inherited from BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:707
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
- value: ICustomBaseObjectSyncedMeta[K]
Returns void
Inherited from BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:709
deprecated

See "alt-shared".ICustomBaseObjectSyncedMeta

Type parameters
- V: any
- K: string = string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomBaseObjectSyncedMeta, 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

Methods

Constructors

constructor

Parameters

group: VirtualEntityGroup

position: Vector3

streamingDistance: number

Optional data: Record<string, any>

Returns VirtualEntity

Properties

dimension

Readonly group

Readonly id

pos

Readonly refCount

Readonly streamingDistance

Readonly type

Readonly valid

visible

Static Readonly all

Methods

deleteMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomBaseObjectMeta>

Parameters

key: K

Returns void

deleteStreamSyncedMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomVirtualEntityStreamSyncedMeta>

Parameters

key: K

Returns void

deleteSyncedMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomBaseObjectSyncedMeta>

Parameters

key: K

Returns void

destroy

Returns void

getMeta

Type parameters

K: string

Parameters

key: Exclude<K, keyof ICustomBaseObjectMeta>

Returns unknown

Type parameters

K: shared.ExtractStringKeys<ICustomBaseObjectMeta>

Parameters

key: K

Returns ICustomBaseObjectMeta[K] | undefined

Type parameters

V: any

Parameters

key: string

Returns V | undefined

getMetaDataKeys

Returns readonly string[]

getStreamSyncedMeta

Type parameters

K: string

Parameters

key: Exclude<K, keyof ICustomVirtualEntityStreamSyncedMeta>

Returns unknown

Type parameters

K: shared.ExtractStringKeys<ICustomVirtualEntityStreamSyncedMeta>