Index

Search Results for

    Class Player

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

    Properties

    | Improve this Doc View Source

    all

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

    streamedEntities

    Declaration
    public readonly streamedEntities: readonly { entity: Entity }[]
    Property Value
    Type Description
    readonly { entity: Entity }[]
    | Improve this Doc View Source

    count

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

    armour

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

    currentWeapon

    Declaration
    public currentWeapon: 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

    currentWeaponComponents

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

    currentWeaponTintIndex

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

    entityAimOffset

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

    entityAimingAt

    Declaration
    public readonly entityAimingAt: null | Entity
    Property Value
    Type Description
    null | Entity
    | Improve this Doc View Source

    flashlightActive

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

    moveSpeed

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

    isInRagdoll

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

    isAiming

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

    isDead

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

    isReloading

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

    isEnteringVehicle

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

    isLeavingVehicle

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

    isOnLadder

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

    isInMelee

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

    isInCover

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

    isParachuting

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

    aimPos

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

    headRot

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

    health

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

    ip

    Declaration
    public readonly ip: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    maxArmour

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

    maxHealth

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

    name

    Declaration
    public readonly name: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    ping

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

    cloudID

    Declaration
    public readonly cloudID: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    cloudAuthResult

    Declaration
    public readonly cloudAuthResult: CloudAuthResult
    Property Value
    Type Description
    CloudAuthResult
    | Improve this Doc View Source

    seat

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

    vehicle

    Declaration
    public readonly vehicle: null | Vehicle
    Property Value
    Type Description
    null | Vehicle
    | Improve this Doc View Source

    invincible

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

    isSuperJumpEnabled

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

    isCrouching

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

    isStealthy

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

    isSpawned

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

    socialID

    Declaration
    public readonly socialID: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    socialClubName

    Declaration
    public readonly socialClubName: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    hwidHash

    Declaration
    public readonly hwidHash: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    hwidExHash

    Declaration
    public readonly hwidExHash: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    authToken

    Declaration
    public readonly authToken: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    discordID

    Declaration
    public readonly discordID: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    currentAnimationDict

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

    currentAnimationName

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

    forwardSpeed

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

    strafeSpeed

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

    currentInterior

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

    lastDamagedBodyPart

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

    sendNames

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

    netOwnershipDisabled

    Declaration
    public netOwnershipDisabled: boolean
    Property Value
    Type Description
    boolean

    Methods

    | Improve this Doc View Source

    getByID(number)

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

    emit<K extends never>(K, Parameters<ICustomServerClientEvent[K]>)

    Declaration
    public emit<K extends never>(eventName: K, ...args: Parameters<ICustomServerClientEvent[K]>): void
    Parameters
    Type Name Description
    K eventName
    Parameters<ICustomServerClientEvent[K]> args
    | Improve this Doc View Source

    emit<K extends string>(Exclude<K, never>, any[])

    Declaration
    public emit<K extends string>(eventName: Exclude<K, never>, ...args: any[]): void
    Parameters
    Type Name Description
    Exclude<K, never> eventName
    any[] args
    | Improve this Doc View Source

    emitRaw<K extends never>(K, Parameters<ICustomServerClientEvent[K]>)

    Declaration
    public emitRaw<K extends never>(eventName: K, ...args: Parameters<ICustomServerClientEvent[K]>): void
    Parameters
    Type Name Description
    K eventName
    Parameters<ICustomServerClientEvent[K]> args
    | Improve this Doc View Source

    emitRaw<K extends string>(Exclude<K, never>, any[])

    Declaration
    public emitRaw<K extends string>(eventName: Exclude<K, never>, ...args: any[]): void
    Parameters
    Type Name Description
    Exclude<K, never> eventName
    any[] args
    | Improve this Doc View Source

    emitRpc<K extends never>(K, Parameters<ICustomServerClientRpc[K]>)

    Declaration
    public emitRpc<K extends never>(rpcName: K, ...args: Parameters<ICustomServerClientRpc[K]>): Promise<ReturnType<ICustomServerClientRpc[K]>>
    Parameters
    Type Name Description
    K rpcName
    Parameters<ICustomServerClientRpc[K]> args
    Returns
    Type Description
    Promise<ReturnType<ICustomServerClientRpc[K]>>
    | Improve this Doc View Source

    emitRpc<K extends string>(Exclude<K, never>, any[])

    Declaration
    public emitRpc<K extends string>(rpcName: Exclude<K, never>, ...args: any[]): Promise<any>
    Parameters
    Type Name Description
    Exclude<K, never> rpcName
    any[] args
    Returns
    Type Description
    Promise<any>
    | Improve this Doc View Source

    addWeaponComponent(number, number)

    Declaration
    public addWeaponComponent(weaponHash: number, component: number): void
    Parameters
    Type Name Description
    number weaponHash
    number component
    | Improve this Doc View Source

    hasWeaponComponent(string | number, string | number)

    Declaration
    public hasWeaponComponent(weaponModel: string | number, component: string | number): boolean
    Parameters
    Type Name Description
    string | number weaponModel
    string | number component
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    clearBloodDamage()

    Declaration
    public clearBloodDamage(): void
    | Improve this Doc View Source

    getBloodDamageBase64()

    Declaration
    public getBloodDamageBase64(): string
    Returns
    Type Description
    string
    | Improve this Doc View Source

    setBloodDamageBase64(string)

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

    giveWeapon(string | number, number, boolean)

    Declaration
    public giveWeapon(weaponModel: string | number, ammo: number, equipNow: boolean): void
    Parameters
    Type Name Description
    string | number weaponModel
    number ammo
    boolean equipNow
    | Improve this Doc View Source

    hasWeapon(string | number)

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

    kick(string)

    Declaration
    public kick(reason?: string): void
    Parameters
    Type Name Description
    string reason
    | Improve this Doc View Source

    removeAllWeapons(boolean)

    Declaration
    public removeAllWeapons(removeAllAmmo?: boolean): void
    Parameters
    Type Name Description
    boolean removeAllAmmo
    | Improve this Doc View Source

    removeWeapon(number)

    Declaration
    public removeWeapon(weaponHash: number): void
    Parameters
    Type Name Description
    number weaponHash
    | Improve this Doc View Source

    removeWeaponComponent(number, number)

    Declaration
    public removeWeaponComponent(weaponHash: number, component: number): void
    Parameters
    Type Name Description
    number weaponHash
    number component
    | Improve this Doc View Source

    setDateTime(DateTimeDay, DateTimeMonth, number, DateTimeHour, DateTimeMinute, DateTimeSecond)

    Declaration
    public setDateTime(day: DateTimeDay, month: DateTimeMonth, year: number, hour: DateTimeHour, minute: DateTimeMinute, second: DateTimeSecond): void
    Parameters
    Type Name Description
    DateTimeDay day
    DateTimeMonth month
    number year
    DateTimeHour hour
    DateTimeMinute minute
    DateTimeSecond second
    | Improve this Doc View Source

    setWeaponTintIndex(number, number)

    Declaration
    public setWeaponTintIndex(weaponHash: number, tintIndex: number): void
    Parameters
    Type Name Description
    number weaponHash
    number tintIndex
    | Improve this Doc View Source

    setWeather(WeatherType)

    Declaration
    public setWeather(weatherType: WeatherType): void
    Parameters
    Type Name Description
    WeatherType weatherType
    | Improve this Doc View Source

    setWeather<T extends number>(T)

    Declaration
    public setWeather<T extends number>(weatherType: T): void
    Parameters
    Type Name Description
    T weatherType
    | Improve this Doc View Source

    spawn(number, number, number, number)

    Declaration
    public spawn(x: number, y: number, z: number, delay?: number): void
    Parameters
    Type Name Description
    number x
    number y
    number z
    number delay
    | Improve this Doc View Source

    spawn(IVector3, number)

    Declaration
    public spawn(pos: IVector3, delay?: number): void
    Parameters
    Type Name Description
    IVector3 pos
    number delay
    | Improve this Doc View Source

    spawn(string | number, IVector3)

    Declaration
    public spawn(model: string | number, pos: IVector3): void
    Parameters
    Type Name Description
    string | number model
    IVector3 pos
    | Improve this Doc View Source

    despawn()

    Declaration
    public despawn(): void
    | Improve this Doc View Source

    getClothes(number)

    Declaration
    public getClothes(component: number): ICloth
    Parameters
    Type Name Description
    number component
    Returns
    Type Description
    ICloth
    | Improve this Doc View Source

    getDlcClothes(number)

    Declaration
    public getDlcClothes(component: number): IDlcCloth
    Parameters
    Type Name Description
    number component
    Returns
    Type Description
    IDlcCloth
    | Improve this Doc View Source

    clearClothes(number)

    Declaration
    public clearClothes(component: number): void
    Parameters
    Type Name Description
    number component
    | Improve this Doc View Source

    setClothes(number, number, number, number)

    Declaration
    public setClothes(component: number, drawable: number, texture: number, palette?: number): boolean
    Parameters
    Type Name Description
    number component
    number drawable
    number texture
    number palette
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    setDlcClothes(number, number, number, number, number)

    Declaration
    public setDlcClothes(dlc: number, component: number, drawable: number, texture: number, palette?: number): boolean
    Parameters
    Type Name Description
    number dlc
    number component
    number drawable
    number texture
    number palette
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getProp(number)

    Declaration
    public getProp(component: number): IProp
    Parameters
    Type Name Description
    number component
    Returns
    Type Description
    IProp
    | Improve this Doc View Source

    getDlcProp(number)

    Declaration
    public getDlcProp(component: number): IDlcProp
    Parameters
    Type Name Description
    number component
    Returns
    Type Description
    IDlcProp
    | Improve this Doc View Source

    setProp(number, number, number)

    Declaration
    public setProp(component: number, drawable: number, texture: number): boolean
    Parameters
    Type Name Description
    number component
    number drawable
    number texture
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    setDlcProp(number, number, number, number)

    Declaration
    public setDlcProp(dlc: number, component: number, drawable: number, texture: number): boolean
    Parameters
    Type Name Description
    number dlc
    number component
    number drawable
    number texture
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    clearProp(number)

    Declaration
    public clearProp(component: number): void
    Parameters
    Type Name Description
    number component
    | Improve this Doc View Source

    isEntityInStreamRange(Entity)

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

    setIntoVehicle(Vehicle, number)

    Declaration
    public setIntoVehicle(vehicle: Vehicle, seat: number): void
    Parameters
    Type Name Description
    Vehicle vehicle
    number seat
    | Improve this Doc View Source

    playAmbientSpeech(string, string, number)

    Declaration
    public playAmbientSpeech(speechName: string, speechParam: string, speechDictHash: number): void
    Parameters
    Type Name Description
    string speechName
    string speechParam
    number speechDictHash
    | Improve this Doc View Source

    setHeadOverlay(number, number, number)

    Declaration
    public setHeadOverlay(overlayID: number, index: number, opacity: number): boolean
    Parameters
    Type Name Description
    number overlayID
    number index
    number opacity
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    removeHeadOverlay(number)

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

    setHeadOverlayColor(number, number, number, number)

    Declaration
    public setHeadOverlayColor(overlayID: number, colorType: number, colorIndex: number, secondColorIndex: number): boolean
    Parameters
    Type Name Description
    number overlayID
    number colorType
    number colorIndex
    number secondColorIndex
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getHeadOverlay(number)

    Declaration
    public getHeadOverlay(overlayID: number): IHeadOverlay
    Parameters
    Type Name Description
    number overlayID
    Returns
    Type Description
    IHeadOverlay
    | Improve this Doc View Source

    setFaceFeature(number, number)

    Declaration
    public setFaceFeature(index: number, scale: number): boolean
    Parameters
    Type Name Description
    number index
    number scale
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getFaceFeatureScale(number)

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

    removeFaceFeature(number)

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

    setHeadBlendPaletteColor(number, number, number, number)

    Declaration
    public setHeadBlendPaletteColor(id: number, red: number, green: number, blue: number): boolean
    Parameters
    Type Name Description
    number id
    number red
    number green
    number blue
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getHeadBlendPaletteColor(number)

    Declaration
    public getHeadBlendPaletteColor(id: number): RGBA
    Parameters
    Type Name Description
    number id
    Returns
    Type Description
    RGBA
    | Improve this Doc View Source

    removeHeadBlendPaletteColor()

    Declaration
    public removeHeadBlendPaletteColor(): void
    | Improve this Doc View Source

    setHeadBlendData(number, number, number, number, number, number, number, number, number)

    Declaration
    public setHeadBlendData(shapeFirstID: number, shapeSecondID: number, shapeThirdID: number, skinFirstID: number, skinSecondID: number, skinThirdID: number, shapeMix: number, skinMix: number, thirdMix: number): void
    Parameters
    Type Name Description
    number shapeFirstID
    number shapeSecondID
    number shapeThirdID
    number skinFirstID
    number skinSecondID
    number skinThirdID
    number shapeMix
    number skinMix
    number thirdMix
    | Improve this Doc View Source

    removeHeadBlendData()

    Declaration
    public removeHeadBlendData(): void
    | Improve this Doc View Source

    getHeadBlendData()

    Declaration
    public getHeadBlendData(): IHeadBlendData
    Returns
    Type Description
    IHeadBlendData
    | Improve this Doc View Source

    setEyeColor(number)

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

    getEyeColor()

    Declaration
    public getEyeColor(): number
    Returns
    Type Description
    number
    | Improve this Doc View Source

    setHairColor(number)

    Declaration
    public setHairColor(hairColor: number): void
    Parameters
    Type Name Description
    number hairColor
    | Improve this Doc View Source

    getHairColor()

    Declaration
    public getHairColor(): number
    Returns
    Type Description
    number
    | Improve this Doc View Source

    setHairHighlightColor(number)

    Declaration
    public setHairHighlightColor(hairHighlightColor: number): void
    Parameters
    Type Name Description
    number hairHighlightColor
    | Improve this Doc View Source

    getHairHighlightColor()

    Declaration
    public getHairHighlightColor(): number
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addDecoration(string | number, string | number, number)

    Declaration
    public addDecoration(collection: string | number, overlay: string | number, count?: number): void
    Parameters
    Type Name Description
    string | number collection
    string | number overlay
    number count
    | Improve this Doc View Source

    removeDecoration(string | number, string | number)

    Declaration
    public removeDecoration(collection: string | number, overlay: string | number): void
    Parameters
    Type Name Description
    string | number collection
    string | number overlay
    | Improve this Doc View Source

    clearDecorations()

    Declaration
    public clearDecorations(): void
    | Improve this Doc View Source

    getDecorations()

    Declaration
    public getDecorations(): readonly IDecoration[]
    Returns
    Type Description
    readonly IDecoration[]
    | Improve this Doc View Source

    playAnimation(string, string, number, number, number, number, number, boolean, boolean, boolean)

    Declaration
    public playAnimation(animDict: string, animName: string, blendInSpeed?: number, blendOutSpeed?: number, duration?: number, flags?: number, playbackRate?: number, lockX?: boolean, lockY?: boolean, lockZ?: boolean): void
    Parameters
    Type Name Description
    string animDict
    string animName
    number blendInSpeed
    number blendOutSpeed
    number duration
    number flags
    number playbackRate
    boolean lockX
    boolean lockY
    boolean lockZ
    | Improve this Doc View Source

    clearTasks()

    Declaration
    public clearTasks(): void
    | Improve this Doc View Source

    playScenario(string)

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

    getAmmo(string | number)

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

    setAmmo(string | number, number)

    Declaration
    public setAmmo(ammoHash: string | number, ammo: number): void
    Parameters
    Type Name Description
    string | number ammoHash
    number ammo
    | Improve this Doc View Source

    getWeaponAmmo(string | number)

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

    setWeaponAmmo(string | number, number)

    Declaration
    public setWeaponAmmo(weaponHash: string | number, ammo: number): void
    Parameters
    Type Name Description
    string | number weaponHash
    number ammo
    | Improve this Doc View Source

    getAmmoSpecialType(string | number)

    Declaration
    public getAmmoSpecialType(ammoHash: string | number): AmmoSpecialType
    Parameters
    Type Name Description
    string | number ammoHash
    Returns
    Type Description
    AmmoSpecialType
    | Improve this Doc View Source

    setAmmoSpecialType(string | number, AmmoSpecialType)

    Declaration
    public setAmmoSpecialType(ammoHash: string | number, ammoSpecialType: AmmoSpecialType): void
    Parameters
    Type Name Description
    string | number ammoHash
    AmmoSpecialType ammoSpecialType
    | Improve this Doc View Source

    getAmmoFlags(string | number)

    Declaration
    public getAmmoFlags(ammoHash: string | number): IAmmoFlags
    Parameters
    Type Name Description
    string | number ammoHash
    Returns
    Type Description
    IAmmoFlags
    | Improve this Doc View Source

    setAmmoFlags(string | number, boolean, boolean, boolean, boolean)

    Declaration
    public setAmmoFlags(ammoHash: string | number, infiniteAmmo: boolean, addSmokeOnExplosion: boolean, fuse: boolean, fixedAfterExplosion: boolean): void
    Parameters
    Type Name Description
    string | number ammoHash
    boolean infiniteAmmo
    boolean addSmokeOnExplosion
    boolean fuse
    boolean fixedAfterExplosion
    | Improve this Doc View Source

    getAmmoMax(string | number)

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

    setAmmoMax(string | number, number)

    Declaration
    public setAmmoMax(ammoHash: string | number, ammoMax: number): void
    Parameters
    Type Name Description
    string | number ammoHash
    number ammoMax
    | Improve this Doc View Source

    getAmmoMax50(string | number)

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

    setAmmoMax50(string | number, number)

    Declaration
    public setAmmoMax50(ammoHash: string | number, ammoMax: number): void
    Parameters
    Type Name Description
    string | number ammoHash
    number ammoMax
    | Improve this Doc View Source

    getAmmoMax100(string | number)

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

    setAmmoMax100(string | number, number)

    Declaration
    public setAmmoMax100(ammoHash: string | number, ammoMax: number): void
    Parameters
    Type Name Description
    string | number ammoHash
    number ammoMax
    | Improve this Doc View Source

    setLocalMeta<K extends string>(K, InterfaceValueByKey<ICustomPlayerLocalMeta, K, unknown, void>)

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

    setLocalMeta<K extends never>(K, ICustomPlayerLocalMeta[K])

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

    setLocalMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomPlayerLocalMeta, K, V, void>)

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

    setLocalMeta(MetaValues<ICustomPlayerLocalMeta>)

    Declaration
    public setLocalMeta(values: MetaValues<ICustomPlayerLocalMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomPlayerLocalMeta> values
    | Improve this Doc View Source

    deleteLocalMeta(string)

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

    deleteLocalMeta<K extends never>(K)

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

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

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

    getLocalMeta<K extends never>(K)

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

    getLocalMeta<V extends unknown>(string)

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

    hasLocalMeta(string)

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

    hasLocalMeta<K extends never>(K)

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

    getLocalMetaKeys()

    Declaration
    public getLocalMetaKeys(): readonly string[]
    Returns
    Type Description
    readonly string[]
    | Improve this Doc View Source

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

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

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

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

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

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

    setMeta(MetaValues<ICustomPlayerMeta>)

    Declaration
    public setMeta(values: MetaValues<ICustomPlayerMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomPlayerMeta> 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 | ICustomPlayerMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomPlayerMeta[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

    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

    setSyncedMeta<K extends string>(K, InterfaceValueByKey<ICustomPlayerSyncedMeta, K, unknown, void>)

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

    setSyncedMeta<K extends never>(K, ICustomPlayerSyncedMeta[K])

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

    setSyncedMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomPlayerSyncedMeta, K, V, void>)

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

    setSyncedMeta(MetaValues<ICustomPlayerSyncedMeta>)

    Declaration
    public setSyncedMeta(values: MetaValues<ICustomPlayerSyncedMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomPlayerSyncedMeta> values
    | Improve this Doc View Source

    deleteSyncedMeta(string)

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

    deleteSyncedMeta<K extends never>(K)

    Declaration
    public deleteSyncedMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | 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 | ICustomPlayerSyncedMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomPlayerSyncedMeta[K]
    | Improve this Doc View Source

    getSyncedMeta<V extends unknown>(string)

    Declaration
    public getSyncedMeta<V extends unknown>(key: string): undefined | V
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    undefined | V
    | 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

    setStreamSyncedMeta<K extends string>(K, InterfaceValueByKey<ICustomPlayerStreamSyncedMeta, K, unknown, void>)

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

    setStreamSyncedMeta<K extends never>(K, ICustomPlayerStreamSyncedMeta[K])

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

    setStreamSyncedMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomPlayerStreamSyncedMeta, K, V, void>)

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

    setStreamSyncedMeta(MetaValues<ICustomPlayerStreamSyncedMeta>)

    Declaration
    public setStreamSyncedMeta(values: MetaValues<ICustomPlayerStreamSyncedMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomPlayerStreamSyncedMeta> values
    | Improve this Doc View Source

    deleteStreamSyncedMeta(string)

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

    deleteStreamSyncedMeta<K extends never>(K)

    Declaration
    public deleteStreamSyncedMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | 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 | ICustomPlayerStreamSyncedMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomPlayerStreamSyncedMeta[K]
    | Improve this Doc View Source

    getStreamSyncedMeta<V extends unknown>(string)

    Declaration
    public getStreamSyncedMeta<V extends unknown>(key: string): undefined | V
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    undefined | V
    | 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