Class Player

Hierarchy

Player

Index

Constructors

constructor

new Player(source: number): Player
Parameters
- source: number
Returns Player
- Defined in entities/Player.ts:9

Properties

`Private` `Readonly` source

source: number

`Protected` type

type: ClassTypes = ClassTypes.Player

Accessors

AirDragMultiplier

get AirDragMultiplier(): number
Returns number
- Defined in entities/Player.ts:125

CamerRotation

get CamerRotation(): Vector3
Returns Vector3
- Defined in entities/Player.ts:46

Endpoint

get Endpoint(): string
Returns string
- Defined in entities/Player.ts:42

Exists

get Exists(): boolean
Returns boolean
- Defined in entities/Player.ts:11

Identifiers

get Identifiers(): string[]
Returns string[]
- Defined in entities/Player.ts:38

IsEvadingWanted

get IsEvadingWanted(): boolean
Returns boolean
- Defined in entities/Player.ts:109

IsMuted

get IsMuted(): boolean
Returns boolean
- Defined in entities/Player.ts:133
set IsMuted(isMuted: boolean): void
Parameters
- isMuted: boolean
Returns void
- Defined in entities/Player.ts:137

IsUsingSuperJump

get IsUsingSuperJump(): boolean
Returns boolean
- Defined in entities/Player.ts:129

LastMessage

get LastMessage(): number
Returns the time since the last player UDP message

Returns number
- Defined in entities/Player.ts:53

MaxArmour

get MaxArmour(): number
Returns number
- Defined in entities/Player.ts:57

MaxHealth

get MaxHealth(): number
Returns number
- Defined in entities/Player.ts:61

MeleeModifier

get MeleeModifier(): number
Returns number
- Defined in entities/Player.ts:65

Name

get Name(): string
Returns
the players name

Returns string
- Defined in entities/Player.ts:72

Ped

get Ped(): Ped
Returns Ped
- Defined in entities/Player.ts:30

Ping

get Ping(): number
Returns
the players round trip ping

Returns number
- Defined in entities/Player.ts:86

RoutingBucket

get RoutingBucket(): number
Returns
the current routhing bucket the player is in, default is 0

Returns number
- Defined in entities/Player.ts:93

Source

get Source(): number
Returns number
- Defined in entities/Player.ts:15

Src

get Src(): string
Returns the player source casted as a string

Returns string
- Defined in entities/Player.ts:26

State

get State(): StateBagInterface
Returns StateBagInterface
- Defined in entities/Player.ts:19

Team

get Team(): number
Returns number
- Defined in entities/Player.ts:97

Tokens

get Tokens(): string[]
Returns string[]
- Defined in entities/Player.ts:34

WantedLevel

get WantedLevel(): number
Returns number
- Defined in entities/Player.ts:105

WantedPosition

get WantedPosition(): Vector3
Returns Vector3
- Defined in entities/Player.ts:101

WeaponDamageModifier

get WeaponDamageModifier(): number
Returns number
- Defined in entities/Player.ts:113

WeaponDefenseModifier

get WeaponDefenseModifier(): number
Returns number
- Defined in entities/Player.ts:117

WeaponDefenseModifier2

get WeaponDefenseModifier2(): number
Returns number
- Defined in entities/Player.ts:121

Methods

drop

drop(reason?: string): void
Parameters
- reason: string = "No reason specified"
Returns void
- Defined in entities/Player.ts:149

filteredName

filteredName(): string
Returns
the players name with any color code unicode, etc removed, this can lead to there being no name at all

Returns string
- Defined in entities/Player.ts:79

isAceAllowed

isAceAllowed(object: string): boolean
Parameters
- object: string
Returns boolean
- Defined in entities/Player.ts:141

timeInPersuit

timeInPersuit(lastPursuit?: boolean): number
Parameters
- lastPursuit: boolean = false
Returns number
- Defined in entities/Player.ts:145

Generated using TypeDoc