Index

Search Results for

    Class LocalPlayer

    Inheritance
    BaseObject
    BaseObject
    WorldObject
    Entity
    Player
    LocalPlayer
    Inherited Members
    Player.model
    all
    Player.constructor
    Player.type
    Player.valid
    Player.id
    Player.destroy
    Player.getMetaDataKeys
    Player.refCount
    Module: alt-client
    Package: @altmp/altv-types
    Syntax
    class LocalPlayer extends Player

    Properties

    | Improve this Doc View Source

    dimension

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

    pos

    Declaration
    public pos: Vector3
    Property Value
    Type Description
    Vector3
    | Improve this Doc View Source

    rot

    Declaration
    public rot: Vector3
    Property Value
    Type Description
    Vector3
    | Improve this Doc View Source

    currentAmmo

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

    weapons

    Declaration
    public readonly weapons: readonly IWeapon[]
    Property Value
    Type Description
    readonly IWeapon[]
    | Improve this Doc View Source

    currentWeaponData

    Declaration
    public readonly currentWeaponData: null | WeaponData
    Property Value
    Type Description
    null | WeaponData
    | Improve this Doc View Source

    stamina

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

    maxStamina

    Declaration
    public maxStamina: number
    Property Value
    Type Description
    number

    Methods

    | Improve this Doc View Source

    getWeaponAmmo(number)

    Declaration
    public getWeaponAmmo(hash: number): number
    Parameters
    Type Name Description
    number hash
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getWeaponAmmo(string)

    Declaration
    public getWeaponAmmo(weaponName: string): number
    Parameters
    Type Name Description
    string weaponName
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getWeaponComponents(number)

    Declaration
    public getWeaponComponents(hash: number): readonly number[]
    Parameters
    Type Name Description
    number hash
    Returns
    Type Description
    readonly number[]
    | Improve this Doc View Source

    getWeaponComponents(string)

    Declaration
    public getWeaponComponents(weaponName: string): readonly number[]
    Parameters
    Type Name Description
    string weaponName
    Returns
    Type Description
    readonly number[]
    | Improve this Doc View Source

    hasWeapon(number)

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

    hasWeapon(string)

    Declaration
    public hasWeapon(weaponName: string): boolean
    Parameters
    Type Name Description
    string weaponName
    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 | ICustomLocalPlayerMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomLocalPlayerMeta[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<ICustomLocalPlayerMeta, K, unknown, void>)

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

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

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

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

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

    setMeta(MetaValues<ICustomLocalPlayerMeta>)

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