Checkpoint

Hierarchy

• Colshape
  • Checkpoint

Index

Constructors

• constructor

Properties

• colshapeType
• dimension
• height
• id
• max
• maxZ
• min
• minZ
• playersOnly
• points
• pos
• radius
• refCount
• streamingDistance
• type
• valid
• visible
• all
• count

Methods

• deleteMeta
• deleteStreamSyncedMeta
• deleteSyncedMeta
• destroy
• getMeta
• getMetaDataKeys
• getStreamSyncedMeta
• getStreamSyncedMetaKeys
• getSyncedMeta
• getSyncedMetaKeys
• hasMeta
• hasStreamSyncedMeta
• hasSyncedMeta
• isEntityIn
• isPointIn
• setMeta
• setStreamSyncedMeta
• setSyncedMeta
• getByID

Constructors

constructor

• new Checkpoint(type: CheckpointType, x: number, y: number, z: number, radius: number, height: number, r: number, g: number, b: number, a: number, streamingDistance: number): Checkpoint
• new Checkpoint(type: CheckpointType, pos: IVector3, radius: number, height: number, color: RGBA, streamingDistance: number): Checkpoint

• Overrides Colshape.constructor

Properties

publicreadonlycolshapeType

colshapeType: ColShapeType

Inherited from Colshape.colshapeType

publicdimension

dimension: number

Object dimension.

Remarks

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

Inherited from Colshape.dimension

publicreadonlyheight

height: number

Inherited from Colshape.height

publicreadonlyid

id: number

Inherited from Colshape.id

publicreadonlymax

max: Vector3 | Vector2

Inherited from Colshape.max

publicreadonlymaxZ

maxZ: number

Inherited from Colshape.maxZ

publicreadonlymin

min: Vector3 | Vector2

Inherited from Colshape.min

publicreadonlyminZ

minZ: number

Inherited from Colshape.minZ

publicplayersOnly

playersOnly: boolean

Whether this colshape should only trigger its enter/leave events for players or all entities.

Inherited from Colshape.playersOnly

publicreadonlypoints

points: readonly Vector2[]

Inherited from Colshape.points

publicpos

pos: Vector3

Object position.

Inherited from Colshape.pos

publicreadonlyradius

radius: number

Inherited from Colshape.radius

publicreadonlyrefCount

refCount: number

Returns the ref count of the entity.

Remarks

It’s only available in debug-mode.

Inherited from Colshape.refCount

publicreadonlystreamingDistance

streamingDistance: number

Streaming range for the checkpoint

publicreadonlytype

type: BaseObjectType

Type of the object.

Inherited from Colshape.type

publicreadonlyvalid

valid: boolean

Object usability.

Returns

False if object is no longer usable.

Inherited from Colshape.valid

publicvisible

visible: boolean

publicstaticreadonlyall

all: readonly Checkpoint[]

Overrides Colshape.all

publicstaticreadonlycount

count: number

Methods

publicdeleteMeta

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

• Overrides Colshape.deleteMeta

publicdeleteStreamSyncedMeta

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

publicdeleteSyncedMeta

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

• Inherited from Colshape.deleteSyncedMeta

  Removes the specified key and the data connected to that specific key.

publicdestroy

• destroy(): void

• Inherited from Colshape.destroy

  Removes the object from the world.

publicgetMeta

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

• Overrides Colshape.getMeta

  Type parameters

  • K: string

publicgetMetaDataKeys

• getMetaDataKeys(): readonly string[]

• Inherited from Colshape.getMetaDataKeys

publicgetStreamSyncedMeta

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

• Type parameters

  • K: string

publicgetStreamSyncedMetaKeys

• getStreamSyncedMetaKeys(): readonly string[]

publicgetSyncedMeta

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

• Inherited from Colshape.getSyncedMeta

  Gets a value using the specified key.

  ---

  Type parameters

  • K: string

publicgetSyncedMetaKeys

• getSyncedMetaKeys(): readonly string[]

• Inherited from Colshape.getSyncedMetaKeys

publichasMeta

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

• Overrides Colshape.hasMeta

publichasStreamSyncedMeta

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

publichasSyncedMeta

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

• Inherited from Colshape.hasSyncedMeta

  Determines whether contains the specified key.

publicisEntityIn

• isEntityIn(entity: Entity): boolean
• isEntityIn(entityID: number): boolean

• Inherited from Colshape.isEntityIn

publicisPointIn

• isPointIn(position: IVector3): boolean

• Inherited from Colshape.isPointIn

publicsetMeta

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

• Overrides Colshape.setMeta

  Type parameters

  • K: string

publicsetStreamSyncedMeta

• setStreamSyncedMeta<K>(key: K, value: InterfaceValueByKey<ICustomPlayerStreamSyncedMeta, K, unknown, void>): void
• setStreamSyncedMeta<K>(key: K, value: ICustomPlayerStreamSyncedMeta[K]): void

• Type parameters

  • K: string

publicsetSyncedMeta

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

• Inherited from Colshape.setSyncedMeta

  Stores the given value with the specified key.

  Remarks

  The given value will be shared with all clients.

  ---

  Type parameters

  • K: string

publicstaticgetByID

• getByID(id: number): null | Checkpoint

• Overrides Colshape.getByID

  Retrieves the checkpoint from the pool.