Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Colshape

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Properties

Readonly colshapeType

colshapeType: ColShapeType

dimension

dimension: number

Object dimension.

remarks

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

Readonly height

height: number

Readonly id

id: number

Readonly isRemote

isRemote: boolean

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

Readonly max

max: Vector2 | Vector3

Readonly maxZ

maxZ: number

Readonly min

min: Vector2 | Vector3

Readonly minZ

minZ: number

playersOnly

playersOnly: boolean

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

Readonly points

points: readonly Vector2[]

pos

pos: Vector3

Object position

Readonly 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 type

type: BaseObjectType

Type of the object.

Readonly valid

valid: boolean

Object usability.

returns

False if object is no longer usable.

Static Readonly all

all: readonly Colshape[]

Methods

deleteMeta

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

destroy

  • destroy(): void

  • Removes the object from the world.

    Returns void

getMeta

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

getMetaDataKeys

  • getMetaDataKeys(): readonly string[]

getSyncedMeta

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

getSyncedMetaKeys

  • getSyncedMetaKeys(): readonly string[]

hasMeta

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

  • Parameters

    • key: string

    Returns boolean

  • Type parameters

    Parameters

    • key: K

    Returns boolean

hasSyncedMeta

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

  • 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

  • Type parameters

    Parameters

    • key: K

    Returns boolean

isEntityIn

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

  • Parameters

    Returns boolean

  • Parameters

    • entityID: number

    Returns boolean

isPointIn

  • isPointIn(position: IVector3): boolean

  • Parameters

    Returns boolean

setMeta

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

Static getByID

  • Retrieves the colshape from the pool.

    Parameters

    • id: number

      The id of the colshape.

    Returns Colshape | null

    Entity if it was found, otherwise null.

Static getByRemoteID