Class LocalPlayer

Hierarchy (View Summary)

Ped
- LocalPlayer

Index

Constructors

Properties

Accessors

armour currentVehicle exists handle heading health isDead isInVehicle isNetworked model netId position rotation serverId

Methods

delete distanceTo freeze resetAlpha setAlpha setCollision

Constructors

constructor

new LocalPlayer(): LocalPlayer
Returns LocalPlayer
Overrides Ped.constructor
- Defined in client/entities/local-player.ts:5

Properties

`Protected`_handle

_handle: number

Accessors

armour

get armour(): number
Returns number
Inherited from Ped.armour
- Defined in client/entities/ped.ts:8
set armour(v: number): void
Parameters
- v: number
Returns void
Inherited from Ped.armour
- Defined in client/entities/ped.ts:12

currentVehicle

get currentVehicle(): Vehicle | null
Returns Vehicle | null
- Defined in client/entities/local-player.ts:17

exists

get exists(): boolean
Returns boolean
Inherited from Ped.exists
- Defined in client/entities/entity.ts:12

handle

get handle(): number
Returns number
Overrides Ped.handle
- Defined in client/entities/local-player.ts:9

heading

get heading(): number
Returns number
Inherited from Ped.heading
- Defined in client/entities/entity.ts:44
set heading(v: number): void
Parameters
- v: number
Returns void
Inherited from Ped.heading
- Defined in client/entities/entity.ts:48

health

get health(): number
Returns number
Inherited from Ped.health
- Defined in client/entities/entity.ts:52
set health(v: number): void
Parameters
- v: number
Returns void
Inherited from Ped.health
- Defined in client/entities/entity.ts:56

isDead

get isDead(): boolean
Returns boolean
Inherited from Ped.isDead
- Defined in client/entities/ped.ts:16

isInVehicle

get isInVehicle(): boolean
Returns boolean
Inherited from Ped.isInVehicle
- Defined in client/entities/ped.ts:4

isNetworked

get isNetworked(): boolean
Returns boolean
Inherited from Ped.isNetworked
- Defined in client/entities/entity.ts:20

model

get model(): number
Returns number
Inherited from Ped.model
- Defined in client/entities/entity.ts:16

netId

get netId(): number
Returns number
Inherited from Ped.netId
- Defined in client/entities/entity.ts:24

position

get position(): Vector3
Returns Vector3
Inherited from Ped.position
- Defined in client/entities/entity.ts:28
set position(v: IVector3): void
Parameters
- v: IVector3
Returns void
Inherited from Ped.position
- Defined in client/entities/entity.ts:32

rotation

get rotation(): Vector3
Returns Vector3
Inherited from Ped.rotation
- Defined in client/entities/entity.ts:36
set rotation(v: IVector3): void
Parameters
- v: IVector3
Returns void
Inherited from Ped.rotation
- Defined in client/entities/entity.ts:40

serverId

get serverId(): number
Returns number
- Defined in client/entities/local-player.ts:13

Methods

delete

delete(): void
Returns void
Inherited from Ped.delete
- Defined in client/entities/entity.ts:81

distanceTo

distanceTo(other: IVector3 | Entity): number
Parameters
- other: IVector3 | Entity
Returns number
Inherited from Ped.distanceTo
- Defined in client/entities/entity.ts:76

freeze

freeze(toggle: boolean): void
Parameters
- toggle: boolean
Returns void
Inherited from Ped.freeze
- Defined in client/entities/entity.ts:60

resetAlpha

resetAlpha(): void
Returns void
Inherited from Ped.resetAlpha
- Defined in client/entities/entity.ts:72

setAlpha

setAlpha(alpha: number): void
Parameters
- alpha: number
Returns void
Inherited from Ped.setAlpha
- Defined in client/entities/entity.ts:68

setCollision

setCollision(toggle: boolean): void
Parameters
- toggle: boolean
Returns void
Inherited from Ped.setCollision
- Defined in client/entities/entity.ts:64