Index

Search Results for

    Class Colshape

    Inheritance
    BaseObject
    BaseObject
    WorldObject
    Colshape
    Inherited Members
    pos
    WorldObject.constructor
    WorldObject.type
    WorldObject.valid
    WorldObject.id
    WorldObject.destroy
    WorldObject.getMetaDataKeys
    WorldObject.getSyncedMeta
    WorldObject.hasSyncedMeta
    WorldObject.getSyncedMetaKeys
    WorldObject.refCount
    Module: alt-client
    Package: @altmp/altv-types
    Syntax
    class Colshape extends WorldObject

    Properties

    | Improve this Doc View Source

    all

    Declaration
    public readonly static all: readonly Colshape[]
    Property Value
    Type Description
    readonly Colshape[]
    | Improve this Doc View Source

    colshapeType

    Declaration
    public readonly colshapeType: ColShapeType
    Property Value
    Type Description
    ColShapeType
    | Improve this Doc View Source

    playersOnly

    Declaration
    public playersOnly: boolean
    Property Value
    Type Description
    boolean
    | Improve this Doc View Source

    radius

    Declaration
    public readonly radius: number
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    height

    Declaration
    public readonly height: number
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    min

    Declaration
    public readonly min: Vector3 | Vector2
    Property Value
    Type Description
    Vector3 | Vector2
    | Improve this Doc View Source

    max

    Declaration
    public readonly max: Vector3 | Vector2
    Property Value
    Type Description
    Vector3 | Vector2
    | Improve this Doc View Source

    minZ

    Declaration
    public readonly minZ: number
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    maxZ

    Declaration
    public readonly maxZ: number
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    points

    Declaration
    public readonly points: readonly Vector2[]
    Property Value
    Type Description
    readonly Vector2[]

    Methods

    | Improve this Doc View Source

    getByID(number)

    Declaration
    public static getByID(id: number): null | Colshape
    Parameters
    Type Name Description
    number id
    Returns
    Type Description
    null | Colshape
    | Improve this Doc View Source

    isEntityIn(Entity)

    Declaration
    public isEntityIn(entity: Entity): boolean
    Parameters
    Type Name Description
    Entity entity
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isEntityIn(number)

    Declaration
    public isEntityIn(entityID: number): boolean
    Parameters
    Type Name Description
    number entityID
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isPointIn(IVector3)

    Declaration
    public isPointIn(position: IVector3): boolean
    Parameters
    Type Name Description
    IVector3 position
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    deleteMeta(string)

    Declaration
    public deleteMeta(key: string): void
    Parameters
    Type Name Description
    string key
    | Improve this Doc View Source

    deleteMeta<K extends never>(K)

    Declaration
    public deleteMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | Improve this Doc View Source

    hasMeta(string)

    Declaration
    public hasMeta(key: string): boolean
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    hasMeta<K extends never>(K)

    Declaration
    public hasMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getMeta<K extends string>(Exclude<K, never>)

    Declaration
    public getMeta<K extends string>(key: Exclude<K, never>): unknown
    Parameters
    Type Name Description
    Exclude<K, never> key
    Returns
    Type Description
    unknown
    | Improve this Doc View Source

    getMeta<K extends never>(K)

    Declaration
    public getMeta<K extends never>(key: K): undefined | ICustomColshapeMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomColshapeMeta[K]
    | Improve this Doc View Source

    getMeta<V extends unknown>(string)

    Declaration
    public getMeta<V extends unknown>(key: string): undefined | V
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    undefined | V
    | Improve this Doc View Source

    setMeta<K extends string>(K, InterfaceValueByKey<ICustomColshapeMeta, K, unknown, void>)

    Declaration
    public setMeta<K extends string>(key: K, value: InterfaceValueByKey<ICustomColshapeMeta, K, unknown, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomColshapeMeta, K, unknown, void> value
    | Improve this Doc View Source

    setMeta<K extends never>(K, ICustomColshapeMeta[K])

    Declaration
    public setMeta<K extends never>(key: K, value: ICustomColshapeMeta[K]): void
    Parameters
    Type Name Description
    K key
    ICustomColshapeMeta[K] value
    | Improve this Doc View Source

    setMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomColshapeMeta, K, V, void>)

    Declaration
    public setMeta<V extends unknown, K extends string>(key: K, value: InterfaceValueByKey<ICustomColshapeMeta, K, V, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomColshapeMeta, K, V, void> value
    | Improve this Doc View Source

    setMeta(MetaValues<ICustomColshapeMeta>)

    Declaration
    public setMeta(values: MetaValues<ICustomColshapeMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomColshapeMeta> values