Skip to main content
Branch: Development

Colshape

Hierarchy

  • WorldObject
    • Colshape

Index

Properties

Methods

Properties

publicreadonlycolshapeType

colshapeType: ColShapeType

publicdimension

dimension: number

Object dimension.

Remarks

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

publicreadonlyheight

height: number

publicreadonlyid

id: number

publicreadonlymax

max: Vector3 | Vector2

publicreadonlymaxZ

maxZ: number

publicreadonlymin

min: Vector3 | Vector2

publicreadonlyminZ

minZ: number

publicplayersOnly

playersOnly: boolean

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

publicreadonlypoints

points: readonly Vector2[]

publicpos

pos: Vector3

Object position.

publicreadonlyradius

radius: number

publicreadonlyrefCount

refCount: number

Returns the ref count of the entity.

Remarks

It’s only available in debug-mode.

publicreadonlytype

type: BaseObjectType

Type of the object.

publicreadonlyvalid

valid: boolean

Object usability.

Returns

False if object is no longer usable.

publicstaticreadonlyall

all: readonly Colshape[]

Methods

publicdeleteMeta

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

publicdeleteSyncedMeta

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

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

publicdestroy

  • destroy(): void

  • Removes the object from the world.

publicgetMeta

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

  • Type parameters

    • K: string

publicgetMetaDataKeys

  • getMetaDataKeys(): readonly string[]

publicgetSyncedMeta

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

  • Gets a value using the specified key.

    Type parameters

    • K: string

publicgetSyncedMetaKeys

  • getSyncedMetaKeys(): readonly string[]

publichasMeta

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

publichasSyncedMeta

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

  • Determines whether contains the specified key.

publicisEntityIn

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

publicisPointIn

  • isPointIn(position: IVector3): boolean

publicsetMeta

  • setMeta<K>(key: K, value: InterfaceValueByKey<ICustomColshapeMeta, K, unknown, void>): void
  • setMeta<K>(key: K, value: ICustomColshapeMeta[K]): void
  • setMeta<V, K>(key: K, value: InterfaceValueByKey<ICustomColshapeMeta, K, V, void>): 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

  • 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 | Colshape

  • Retrieves the colshape from the pool.