Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Player

Hierarchy

  • Player

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Player(handle: number): Player

Properties

Private handle

handle: number

Private ped

ped: undefined | Ped

Private pvp

pvp: boolean = false

Private stateBagCookies

stateBagCookies: number[] = []

Accessors

Character

  • get Character(): Ped

EntityPlayerIsAimingAt

FakeWantedLevel

  • get FakeWantedLevel(): number

Handle

  • get Handle(): number

HasReserveParachute

  • get HasReserveParachute(): boolean

HealthRechargeLimit

  • get HealthRechargeLimit(): number

IsDead

  • get IsDead(): boolean

IsInvincible

  • get IsInvincible(): boolean

MaxArmor

  • get MaxArmor(): number

Name

  • get Name(): string

ParachuteColorTrailColor

  • get ParachuteColorTrailColor(): Color

ParachuteModelOverride

  • get ParachuteModelOverride(): Model

ParachutePackTintIndex

  • get ParachutePackTintIndex(): number

ParachuteTintIndex

  • get ParachuteTintIndex(): number

Ped

PlayerGroup

  • get PlayerGroup(): number

PlayerRgbColour

  • get PlayerRgbColour(): Color

PvPEnabled

  • get PvPEnabled(): boolean
  • set PvPEnabled(value: boolean): void

ReserveParachuteModelOverride

  • get ReserveParachuteModelOverride(): Model

ReserveParachuteTintIndex

  • get ReserveParachuteTintIndex(): number

ServerId

  • get ServerId(): number

SprintTimeRemaining

  • get SprintTimeRemaining(): number

Stamina

  • get Stamina(): number

State

  • get State(): StateBagInterface

StealthNoise

  • get StealthNoise(): number

TargetEntity

Team

  • get Team(): number

Methods

AddStateBagChangeHandler

  • AddStateBagChangeHandler(keyFilter: null | string, handler: StateBagChangeHandler): number

  • Parameters

    • keyFilter: null | string
    • handler: StateBagChangeHandler

    Returns number

CanPedHearPlayer

  • CanPedHearPlayer(ped: Ped): boolean

listenForStateChange

  • listenForStateChange(keyFilter: null | string, handler: StateBagChangeHandler): number

  • A short hand function for AddStateBagChangeHandler, this gets automatically cleaned up on entity deletion.

    Parameters

    • keyFilter: null | string

      the key to filter for or null

    • handler: StateBagChangeHandler

      the function to handle the change

    Returns number

    a cookie to be used in RemoveStateBagChangeHandler

removeAllStateListeners

  • removeAllStateListeners(): void

removeStateListener

  • removeStateListener(tgtCookie: number): void

Static fromPedHandle

  • fromPedHandle(handle: number): Player

Static fromServerId

  • fromServerId(serverId: number): Player

Generated using TypeDoc