Class Player

A class that represents a byte object. Tries to replicate the behavior of Java's Object base class.

Hierarchy (view full)

User
- Player

Implements

IObjectifiable<DBPlayerInfo>

Constructors

constructor

new Player(src, uuid, playerData, inventory, position, jobs, gangs, playerPedData): Player
Parameters
- src: number
- uuid: string
- playerData: PlayerData
- inventory: PlayerInventory
- position: Vector4
- jobs: PlayerJob[]
- gangs: PlayerGang[]
- playerPedData: PedData
Returns Player
Overrides User.constructor
- Defined in classes/player.ts:31

Methods

addGang

addGang(gang): void
Parameters
- gang: PlayerGang
Returns void
- Defined in classes/player.ts:114

addJob

addJob(job): void
Parameters
- job: PlayerJob
Returns void
- Defined in classes/player.ts:86

asJSON

asJSON(): string
Returns string
A JSON string representation of the object.
Overrides User.asJSON
- Defined in classes/player.ts:201

asString

asString(): string
Returns string
A string representation of the object.
Overrides User.asString
- Defined in classes/player.ts:197

clone

clone(): this
Clones the object.

Returns this
Inherited from User.clone
- Defined in shared/classes/byteObject.ts:11

compare

compare(other): -1 | 0 | 1
Parameters
- other: this
Returns -1 | 0 | 1
-1 if this is less than other, 0 if they are equal, 1 if this is greater than other.
Inherited from User.compare
- Defined in shared/classes/byteObject.ts:31

equals

equals(other): boolean
Checks if the object is equal to another object.
Parameters
- other: this
  The object to compare to.
Returns boolean
true if the objects are equal, false otherwise.
Inherited from User.equals
- Defined in shared/classes/byteObject.ts:19

getData

getData(): PlayerData
Returns PlayerData
- Defined in classes/player.ts:53

getGang

getGang(gang): undefined | PlayerGang
Parameters
- gang: PlayerGang
Returns undefined | PlayerGang
- Defined in classes/player.ts:61

getGangIndex

getGangIndex(gang): number
Parameters
- gang: PlayerGang
Returns number
- Defined in classes/player.ts:63

getGangs

getGangs(): PlayerGang[]
Returns PlayerGang[]
- Defined in classes/player.ts:57

getIdentifier

getIdentifier(identifier): undefined | string
Parameters
- identifier: string
Returns undefined | string
Inherited from User.getIdentifier
- Defined in classes/user.ts:12

getIdentifiers

getIdentifiers(): Record<string, string>
Returns Record<string, string>
Inherited from User.getIdentifiers
- Defined in classes/user.ts:16

getInventory

getInventory(): PlayerInventory
Returns PlayerInventory
- Defined in classes/player.ts:54

getJob

getJob(job): undefined | PlayerJob
Parameters
- job: PlayerJob
Returns undefined | PlayerJob
- Defined in classes/player.ts:60

getJobIndex

getJobIndex(job): number
Parameters
- job: PlayerJob
Returns number
- Defined in classes/player.ts:62

getJobs

getJobs(): PlayerJob[]
Returns PlayerJob[]
- Defined in classes/player.ts:56

getPlayerPedData

getPlayerPedData(): PedData
Returns PedData
- Defined in classes/player.ts:64

getPosition

getPosition(): Vector4
Returns Vector4
- Defined in classes/player.ts:55

getPrivilege

getPrivilege(): Privilege
Returns Privilege
Inherited from User.getPrivilege
- Defined in classes/user.ts:32

getSrc

getSrc(): number
Returns number
Inherited from User.getSrc
- Defined in classes/user.ts:44

getUuid

getUuid(): string
Returns string
- Defined in classes/player.ts:52

hasGang

hasGang(gang): boolean
Parameters
- gang: PlayerGang
Returns boolean
- Defined in classes/player.ts:59

hash

hash(): number
Returns number
A hash code for the object instance.
Inherited from User.hash
- Defined in shared/classes/byteObject.ts:25

hasJob

hasJob(job): boolean
Parameters
- job: PlayerJob
Returns boolean
- Defined in classes/player.ts:58

hasPrivilege

hasPrivilege(target): boolean
Parameters
- target: Privilege
Returns boolean
Inherited from User.hasPrivilege
- Defined in classes/user.ts:38

removeGang

removeGang(gang): Result
Parameters
- gang: PlayerGang
Returns Result
- Defined in classes/player.ts:121

removeJob

removeJob(job): Result
Parameters
- job: PlayerJob
Returns Result
- Defined in classes/player.ts:93

save

save(): TransactionResult<null>
Returns TransactionResult<null>
- Defined in classes/player.ts:166

setData

setData(data): void
Parameters
- data: PlayerData
Returns void
- Defined in classes/player.ts:66

setDataKey

setDataKey<K>(key, value): void
Type Parameters
- K extends
      | "birthdate"
      | "firstname"
      | "lastname"
      | "gender"
      | "nationality"
Parameters
- key: K
- value: PlayerData[K]
Returns void
- Defined in classes/player.ts:71

setGang

setGang(gang): Result
Parameters
- gang: PlayerGang
Returns Result
- Defined in classes/player.ts:129

setGangs

setGangs(gangs): void
Parameters
- gangs: PlayerGang[]
Returns void
- Defined in classes/player.ts:109

setJob

setJob(job): Result
Parameters
- job: PlayerJob
Returns Result
- Defined in classes/player.ts:101

setJobs

setJobs(jobs): void
Parameters
- jobs: PlayerJob[]
Returns void
- Defined in classes/player.ts:81

setPlayerPedData

setPlayerPedData(data, syncWithClient?): void
Parameters
- data: PedData
- syncWithClient: boolean = true
Returns void
- Defined in classes/player.ts:137

setPosition

setPosition(position): void
Parameters
- position: Vector4
Returns void
- Defined in classes/player.ts:76

toObject

toObject(): DBPlayerInfo
Returns DBPlayerInfo
Implementation of IObjectifiable.toObject
- Defined in classes/player.ts:181

updatePosition

updatePosition(): void
Updates the player's position to the current position of their ped.

Returns void
- Defined in classes/player.ts:159

`Static`emitPlayerReady

emitPlayerReady(player): void
No Self
Emits the PlayerReady event to the client and makes the client load the instance of the player. It is used as a sort of login method. Should only be called once throught the player's lifecycle
Parameters
- player: Player
  The player to emit the event to.
Returns void
- Defined in classes/player.ts:212

`Static`fromObject

fromObject(src, data): Player
No Self
Parameters
- src: number
- data: DBPlayerInfo
Returns Player
- Defined in classes/player.ts:222