Index

Search Results for

    Class Ped

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

    Properties

    | Improve this Doc View Source

    all

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

    streamedIn

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

    count

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

    currentWeapon

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

    health

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

    maxHealth

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

    armour

    Declaration
    public readonly armour: number
    Property Value
    Type Description
    number

    Methods

    | Improve this Doc View Source

    getByID(number)

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

    getByScriptID(number)

    Declaration
    public static getByScriptID(scriptID: number): null | Ped
    Parameters
    Type Name Description
    number scriptID
    Returns
    Type Description
    null | Ped
    | Improve this Doc View Source

    getByRemoteID(number)

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

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

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

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

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

    setMeta(MetaValues<ICustomPedMeta>)

    Declaration
    public setMeta(values: MetaValues<ICustomPedMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomPedMeta> values
    | 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

    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 | ICustomPedMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomPedMeta[K]
    | 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

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

    Declaration
    public getSyncedMeta<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

    getSyncedMeta<K extends never>(K)

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

    hasSyncedMeta(string)

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

    hasSyncedMeta<K extends never>(K)

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

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

    Declaration
    public getStreamSyncedMeta<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

    getStreamSyncedMeta<K extends never>(K)

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

    hasStreamSyncedMeta(string)

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

    hasStreamSyncedMeta<K extends never>(K)

    Declaration
    public hasStreamSyncedMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean