Checkpoint | custom alt:V docs JS

Hierarchy

WorldObject
- Checkpoint

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Checkpoint(type: CheckpointType, pos: IVector3, nextPos: IVector3, radius: number, height: number, rgbColor: RGBA, iconColor: RGBA, streamingDistance: number): Checkpoint

Overrides BaseObject.constructor
- Defined in types-client/index.d.ts:804
Parameters
- type: CheckpointType
- pos: IVector3
- nextPos: IVector3
- radius: number
- height: number
- rgbColor: RGBA
- iconColor: RGBA
- streamingDistance: number
Returns Checkpoint

Properties

checkpointType

checkpointType: CheckpointType

color

color: RGBA

dimension

dimension: number

Object dimension.

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

height

height: number

iconColor

iconColor: RGBA

Readonly id

id: number

Readonly isRemote

isRemote: boolean

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

Readonly isStreamedIn

isStreamedIn: boolean

nextPos

nextPos: Vector3

pos

pos: Vector3

Object position

radius

radius: number

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.

Readonly scriptID

scriptID: number

Readonly streamingDistance

streamingDistance: number

Streaming range for the checkpoint

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 Checkpoint[]

Static Readonly count

count: number

Methods

deleteMeta

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

Overrides BaseObject.deleteMeta
- Defined in types-client/index.d.ts:834
Parameters
- key: string
Returns void
Overrides BaseObject.deleteMeta
- Defined in types-client/index.d.ts:835
Type parameters
- K: shared.ExtractStringKeys<ICustomCheckpointMeta>
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 ICustomCheckpointMeta>): unknown
getMeta<K>(key: K): ICustomCheckpointMeta[K] | undefined
getMeta<V>(key: string): V | undefined

Overrides BaseObject.getMeta
- Defined in types-client/index.d.ts:840
Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomCheckpointMeta>
Returns unknown
Overrides BaseObject.getMeta
- Defined in types-client/index.d.ts:841
Type parameters
- K: shared.ExtractStringKeys<ICustomCheckpointMeta>
Parameters
- key: K
Returns ICustomCheckpointMeta[K] | undefined
Overrides BaseObject.getMeta
- Defined in types-client/index.d.ts:843
deprecated

See ICustomCheckpointMeta

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[]

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

Overrides BaseObject.hasMeta
- Defined in types-client/index.d.ts:837
Parameters
- key: string
Returns boolean
Overrides BaseObject.hasMeta
- Defined in types-client/index.d.ts:838
Type parameters
- K: shared.ExtractStringKeys<ICustomCheckpointMeta>
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

isEntityIn

isEntityIn(entity: Entity): boolean

- Defined in types-client/index.d.ts:831
Parameters
- entity: Entity
Returns boolean

isPointIn

isPointIn(pos: IVector3): boolean

- Defined in types-client/index.d.ts:832
Parameters
- pos: IVector3
Returns boolean

setMeta

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

Overrides BaseObject.setMeta
- Defined in types-client/index.d.ts:845
Type parameters
- K: string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomCheckpointMeta, K>
Returns void
Overrides BaseObject.setMeta
- Defined in types-client/index.d.ts:846
Type parameters
- K: shared.ExtractStringKeys<ICustomCheckpointMeta>
Parameters
- key: K
- value: ICustomCheckpointMeta[K]
Returns void
Overrides BaseObject.setMeta
- Defined in types-client/index.d.ts:848
deprecated

See ICustomCheckpointMeta

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

Static getByID

getByID(id: number): Checkpoint | null

Overrides BaseObject.getByID
- Defined in types-client/index.d.ts:825
Retrieves the checkpoint from the pool.

Parameters
- id: number
  
  The id of the checkpoint.
Returns Checkpoint | null

Entity if it was found, otherwise null.

Static getByRemoteID

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

Inherited from BaseObject.getByRemoteID
- Defined in types-client/index.d.ts:579
Parameters
- type: BaseObjectType
- id: number
Returns BaseObject | null

Static getByScriptID

getByScriptID(scriptID: number): Checkpoint | null

- Defined in types-client/index.d.ts:827
Parameters
- scriptID: number
Returns Checkpoint | null

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

type: CheckpointType

pos: IVector3

nextPos: IVector3

radius: number

height: number

rgbColor: RGBA

iconColor: RGBA

streamingDistance: number

Returns Checkpoint

Properties

checkpointType

color

dimension

height

iconColor

Readonly id

Readonly isRemote

Readonly isStreamedIn

nextPos

pos

radius

Readonly refCount

Readonly remoteID

Readonly scriptID

Readonly streamingDistance

Readonly type

Readonly valid

visible

Static Readonly all

Static Readonly count

Methods

deleteMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomCheckpointMeta>

Parameters

key: K

Returns void

destroy

Returns void

getMeta

Type parameters

K: string

Parameters

key: Exclude<K, keyof ICustomCheckpointMeta>

Returns unknown

Type parameters

K: shared.ExtractStringKeys<ICustomCheckpointMeta>

Parameters

key: K

Returns ICustomCheckpointMeta[K] | undefined

Type parameters

V: any

Parameters

key: string

Returns V | undefined

getMetaDataKeys

Returns readonly string[]

getSyncedMeta

Type parameters

K: string

Parameters

key: Exclude<K, keyof ICustomBaseObjectSyncedMeta>

Returns unknown

Type parameters

K: ExtractStringKeys<ICustomBaseObjectSyncedMeta>

Parameters

key: K

Returns ICustomBaseObjectSyncedMeta[K] | undefined

Type parameters