Class Player

Base class for all entities in the framework. Still wondering if this should be an abstract class. May change in the future.

Hierarchy (view full)

PlayerPed
- Player

Index

Constructors

constructor

Methods

asJSON asString clone compare delete equals freeze getAccuracy getAlpha getClosestEntityOfType getConfigFlag getCurrentDrawableVariation getCurrentPropDrawableVariation getCurrentPropTextureVariation getCurrentTextureVariation getData getDimensions getEntity getEntityType getExists getGang getGangIndex getGangs getHairColor getHairHightlightColor getHash getHeading getInventory getIsInCdImage getIsLoaded getIsMissionEntity getIsModelValid getJob getJobIndex getJobs getMaxComponents getMaxFaceFeatures getMaxHealth getMaxOverlays getMaxProps getMaxValues getModel getName getNetworkId getPed getPedComponents getPedFaceFeature getPedFaceFeatures getPedGender getPedHeadBlendData getPedHeadBlendHeads getPedHeadBlendsHeadsByGender getPedHeadOverlay getPedHeadOverlayColorType getPedHeadOverlays getPedProps getPosition getRotation getSize getSource getUuid getVelocity getVisible hasGang hash hasJob isFrozen load refreshPedHeadBlendData resurrect setAccuracy setAlpha setConfigFlag setCurrentDrawableVariation setEntity setHairColor setHeading setIsMissionEntity setModel setPedData setPedFaceFeature setPedHeadBlendData setPedHeadOverlay setPedHeadOverlayColor setPlayerModel setPosition setPropDrawableVariation setRotation setSource setVelocity setVisible toNet toObject unload create fromNet getInstance onPlayerReady onPlayerReadySync playerPed setInstance

Constructors

constructor

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

Properties

`Protected`entityId

entityId: number

`Protected`modelHash

modelHash: number

`Protected`modelName

modelName: Optional<string>

Methods

asJSON

asJSON(): string
Returns string
A JSON string representation of the object.
Inherited from PlayerPed.asJSON
- Defined in shared/classes/byteObject.ts:43

asString

asString(): string
Returns string
A string representation of the object.
Inherited from PlayerPed.asString
- Defined in classes/playerPed/clothedPed.ts:494

clone

clone(): this
Clones the object.

Returns this
Inherited from PlayerPed.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 PlayerPed.compare
- Defined in shared/classes/byteObject.ts:31

delete

delete(): void
Returns void
Inherited from PlayerPed.delete
- Defined in classes/game/ped.ts:22

equals

equals(other): boolean
Checks if the object is equal to another object.
Parameters
- other: CEntity
  The object to compare to.
Returns boolean
true if the objects are equal, false otherwise.
Inherited from PlayerPed.equals
- Defined in classes/game/entity.ts:95

freeze

freeze(value): void
Parameters
- value: boolean
Returns void
Inherited from PlayerPed.freeze
- Defined in classes/game/entity.ts:70

getAccuracy

getAccuracy(): IntRange<0, 101>
Returns IntRange<0, 101>
Inherited from PlayerPed.getAccuracy
- Defined in classes/game/ped.ts:13

getAlpha

getAlpha(): IntRange<0, 256>
Returns IntRange<0, 256>
Inherited from PlayerPed.getAlpha
- Defined in classes/game/entity.ts:57

getClosestEntityOfType

getClosestEntityOfType(model, radius?): Optional<CEntity>
Parameters
- model: number | CModel
- radius: number = ...
Returns Optional<CEntity>
Inherited from PlayerPed.getClosestEntityOfType
- Defined in classes/game/entity.ts:73

getConfigFlag

getConfigFlag(flag): boolean
Parameters
- flag: CPedConfigFlags
Returns boolean
Inherited from PlayerPed.getConfigFlag
- Defined in classes/game/ped.ts:15

getCurrentDrawableVariation

getCurrentDrawableVariation(component): number
Parameters
- component: PedComponent
Returns number
Inherited from PlayerPed.getCurrentDrawableVariation
- Defined in classes/playerPed/clothedPed.ts:240

getCurrentPropDrawableVariation

getCurrentPropDrawableVariation(component): number
Parameters
- component: PedProps
Returns number
Inherited from PlayerPed.getCurrentPropDrawableVariation
- Defined in classes/playerPed/clothedPed.ts:275

getCurrentPropTextureVariation

getCurrentPropTextureVariation(component): number
Parameters
- component: PedProps
Returns number
Inherited from PlayerPed.getCurrentPropTextureVariation
- Defined in classes/playerPed/clothedPed.ts:276

getCurrentTextureVariation

getCurrentTextureVariation(component): number
Parameters
- component: PedComponent
Returns number
Inherited from PlayerPed.getCurrentTextureVariation
- Defined in classes/playerPed/clothedPed.ts:241

getData

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

getDimensions

getDimensions(): [min: Vector3, max: Vector3]
Gets the dimensions of the model

Returns [min: Vector3, max: Vector3]
The minimum and maximum dimensions of the model

See
https://docs.fivem.net/natives/?_0x03E8D3D5F549087A
Inherited from PlayerPed.getDimensions
- Defined in classes/game/model.ts:70

getEntity

getEntity(): number
Returns number
Inherited from PlayerPed.getEntity
- Defined in classes/game/entity.ts:27

getEntityType

getEntityType(): CEntityType
Returns CEntityType
Inherited from PlayerPed.getEntityType
- Defined in classes/game/entity.ts:62

getExists

getExists(): boolean
Returns boolean
Inherited from PlayerPed.getExists
- Defined in classes/game/entity.ts:61

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

getHairColor

getHairColor(): Result<number>
Returns Result<number>
Inherited from PlayerPed.getHairColor
- Defined in classes/playerPed/clothedPed.ts:245

getHairHightlightColor

getHairHightlightColor(): Result<number>
Returns Result<number>
Inherited from PlayerPed.getHairHightlightColor
- Defined in classes/playerPed/clothedPed.ts:250

getHash

getHash(): number
Getter for the model hash

Returns number
The model hash
Inherited from PlayerPed.getHash
- Defined in classes/game/entity.ts:38

getHeading

getHeading(): IntRange<0, 361>
Returns IntRange<0, 361>
Inherited from PlayerPed.getHeading
- Defined in classes/game/entity.ts:47

getInventory

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

getIsInCdImage

getIsInCdImage(): boolean
Returns boolean
Whether the model is in the game's CD image
Inherited from PlayerPed.getIsInCdImage
- Defined in classes/game/model.ts:98

getIsLoaded

getIsLoaded(): boolean
Returns boolean
Whether the model is loaded
Inherited from PlayerPed.getIsLoaded
- Defined in classes/game/model.ts:88

getIsMissionEntity

getIsMissionEntity(): boolean
Returns boolean
Inherited from PlayerPed.getIsMissionEntity
- Defined in classes/game/entity.ts:64

getIsModelValid

getIsModelValid(): boolean
Returns boolean
Whether the model is valid
Inherited from PlayerPed.getIsModelValid
- Defined in classes/game/model.ts:93

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

getMaxComponents

getMaxComponents(): Record<
    | "COMP_HEAD"
    | "COMP_BERD"
    | "COMP_HAIR"
    | "COMP_UPPR"
    | "COMP_LOWR"
    | "COMP_HAND"
    | "COMP_FEET"
    | "COMP_TEEF"
    | "COMP_ACCS"
    | "COMP_TASK"
    | "COMP_DECL"
    | "COMP_JBIB", Record<number, number>>
Returns Record<
    | "COMP_HEAD"
    | "COMP_BERD"
    | "COMP_HAIR"
    | "COMP_UPPR"
    | "COMP_LOWR"
    | "COMP_HAND"
    | "COMP_FEET"
    | "COMP_TEEF"
    | "COMP_ACCS"
    | "COMP_TASK"
    | "COMP_DECL"
    | "COMP_JBIB", Record<number, number>>
Inherited from PlayerPed.getMaxComponents
- Defined in classes/playerPed/clothedPed.ts:302

getMaxFaceFeatures

getMaxFaceFeatures(): Record<
    | "NOSE_WIDTH"
    | "NOSE_PEAK"
    | "NOSE_LENGTH"
    | "NOSE_BONE_CURVE"
    | "NOSE_TIP"
    | "NOSE_BONE_TWIST"
    | "EYEBROW_HEIGHT"
    | "EYEBROW_DEPTH"
    | "CHEEK_HEIGHT"
    | "CHEEK_DEPTH"
    | "CHEEK_WIDTH"
    | "EYE_OPENING"
    | "LIP_THICKNESS"
    | "JAW_WIDTH"
    | "JAW_ROUNDNESS"
    | "CHIN_HEIGHT"
    | "CHIN_LENGTH"
    | "CHIN_ROUNDNESS"
    | "CHIN_HOLE"
    | "NECK_THICKNESS", {
    max: number;
    min: number;
}>
Returns Record<
    | "NOSE_WIDTH"
    | "NOSE_PEAK"
    | "NOSE_LENGTH"
    | "NOSE_BONE_CURVE"
    | "NOSE_TIP"
    | "NOSE_BONE_TWIST"
    | "EYEBROW_HEIGHT"
    | "EYEBROW_DEPTH"
    | "CHEEK_HEIGHT"
    | "CHEEK_DEPTH"
    | "CHEEK_WIDTH"
    | "EYE_OPENING"
    | "LIP_THICKNESS"
    | "JAW_WIDTH"
    | "JAW_ROUNDNESS"
    | "CHIN_HEIGHT"
    | "CHIN_LENGTH"
    | "CHIN_ROUNDNESS"
    | "CHIN_HOLE"
    | "NECK_THICKNESS", {
    max: number;
    min: number;
}>
Inherited from PlayerPed.getMaxFaceFeatures
- Defined in classes/playerPed/clothedPed.ts:389

getMaxHealth

getMaxHealth(): number
Returns number
Inherited from PlayerPed.getMaxHealth
- Defined in classes/game/ped.ts:16

getMaxOverlays

getMaxOverlays(): Record<
    | "BLEMISHES"
    | "FACIAL_HAIR"
    | "EYEBROWS"
    | "AGEING"
    | "MAKEUP"
    | "BLUSH"
    | "COMPLEXION"
    | "SUN_DAMAGE"
    | "LIPSTICK"
    | "MOLES"
    | "CHEST_HAIR"
    | "BODY_BLEMISHES"
    | "ADD_BODY_BLEMISHES", number>
Returns Record<
    | "BLEMISHES"
    | "FACIAL_HAIR"
    | "EYEBROWS"
    | "AGEING"
    | "MAKEUP"
    | "BLUSH"
    | "COMPLEXION"
    | "SUN_DAMAGE"
    | "LIPSTICK"
    | "MOLES"
    | "CHEST_HAIR"
    | "BODY_BLEMISHES"
    | "ADD_BODY_BLEMISHES", number>
Inherited from PlayerPed.getMaxOverlays
- Defined in classes/playerPed/clothedPed.ts:363

getMaxProps

getMaxProps(): Record<
    | "ANCHOR_HEAD"
    | "ANCHOR_EYES"
    | "ANCHOR_EARS"
    | "ANCHOR_MOUTH"
    | "ANCHOR_LEFT_HAND"
    | "ANCHOR_RIGHT_HAND"
    | "ANCHOR_LEFT_WRIST"
    | "ANCHOR_RIGHT_WRIST"
    | "ANCHOR_HIP"
    | "ANCHOR_LEFT_FOOT"
    | "ANCHOR_RIGHT_FOOT"
    | "ANCHOR_PH_L_HAND"
    | "ANCHOR_PH_R_HAND", Record<number, number>>
Returns Record<
    | "ANCHOR_HEAD"
    | "ANCHOR_EYES"
    | "ANCHOR_EARS"
    | "ANCHOR_MOUTH"
    | "ANCHOR_LEFT_HAND"
    | "ANCHOR_RIGHT_HAND"
    | "ANCHOR_LEFT_WRIST"
    | "ANCHOR_RIGHT_WRIST"
    | "ANCHOR_HIP"
    | "ANCHOR_LEFT_FOOT"
    | "ANCHOR_RIGHT_FOOT"
    | "ANCHOR_PH_L_HAND"
    | "ANCHOR_PH_R_HAND", Record<number, number>>
Inherited from PlayerPed.getMaxProps
- Defined in classes/playerPed/clothedPed.ts:332

getMaxValues

getMaxValues(): PedMaxValues
Returns PedMaxValues
Inherited from PlayerPed.getMaxValues
- Defined in classes/playerPed/clothedPed.ts:412

getModel

getModel(): CModel
Returns CModel
Inherited from PlayerPed.getModel
- Defined in classes/game/entity.ts:60

getName

getName(): Optional<string>
Getter for the model name

Returns Optional<string>
The model name (can be nil as the model name can't be retrieved from the hash)
Inherited from PlayerPed.getName
- Defined in classes/game/model.ts:63

getNetworkId

getNetworkId(): number
Returns number
Inherited from PlayerPed.getNetworkId
- Defined in classes/game/ped.ts:23

getPed

getPed(): number
Returns number
Inherited from PlayerPed.getPed
- Defined in classes/playerPed/ped.ts:13

getPedComponents

getPedComponents(): Record<
    | "COMP_HEAD"
    | "COMP_BERD"
    | "COMP_HAIR"
    | "COMP_UPPR"
    | "COMP_LOWR"
    | "COMP_HAND"
    | "COMP_FEET"
    | "COMP_TEEF"
    | "COMP_ACCS"
    | "COMP_TASK"
    | "COMP_DECL"
    | "COMP_JBIB", {
    drawable: number;
    texture: number;
}>
Returns Record<
    | "COMP_HEAD"
    | "COMP_BERD"
    | "COMP_HAIR"
    | "COMP_UPPR"
    | "COMP_LOWR"
    | "COMP_HAND"
    | "COMP_FEET"
    | "COMP_TEEF"
    | "COMP_ACCS"
    | "COMP_TASK"
    | "COMP_DECL"
    | "COMP_JBIB", {
    drawable: number;
    texture: number;
}>
Inherited from PlayerPed.getPedComponents
- Defined in classes/playerPed/clothedPed.ts:124

getPedFaceFeature

getPedFaceFeature(feature): number
Parameters
- feature: FaceFeature
Returns number
Inherited from PlayerPed.getPedFaceFeature
- Defined in classes/playerPed/clothedPed.ts:256

getPedFaceFeatures

getPedFaceFeatures(): Record<
    | "NOSE_WIDTH"
    | "NOSE_PEAK"
    | "NOSE_LENGTH"
    | "NOSE_BONE_CURVE"
    | "NOSE_TIP"
    | "NOSE_BONE_TWIST"
    | "EYEBROW_HEIGHT"
    | "EYEBROW_DEPTH"
    | "CHEEK_HEIGHT"
    | "CHEEK_DEPTH"
    | "CHEEK_WIDTH"
    | "EYE_OPENING"
    | "LIP_THICKNESS"
    | "JAW_WIDTH"
    | "JAW_ROUNDNESS"
    | "CHIN_HEIGHT"
    | "CHIN_LENGTH"
    | "CHIN_ROUNDNESS"
    | "CHIN_HOLE"
    | "NECK_THICKNESS", number>
Returns Record<
    | "NOSE_WIDTH"
    | "NOSE_PEAK"
    | "NOSE_LENGTH"
    | "NOSE_BONE_CURVE"
    | "NOSE_TIP"
    | "NOSE_BONE_TWIST"
    | "EYEBROW_HEIGHT"
    | "EYEBROW_DEPTH"
    | "CHEEK_HEIGHT"
    | "CHEEK_DEPTH"
    | "CHEEK_WIDTH"
    | "EYE_OPENING"
    | "LIP_THICKNESS"
    | "JAW_WIDTH"
    | "JAW_ROUNDNESS"
    | "CHIN_HEIGHT"
    | "CHIN_LENGTH"
    | "CHIN_ROUNDNESS"
    | "CHIN_HOLE"
    | "NECK_THICKNESS", number>
Inherited from PlayerPed.getPedFaceFeatures
- Defined in classes/playerPed/clothedPed.ts:152

getPedGender

getPedGender(): PlayerGender
Returns PlayerGender
Inherited from PlayerPed.getPedGender
- Defined in classes/playerPed/clothedPed.ts:38

getPedHeadBlendData

getPedHeadBlendData(): PedHeadBlendData
Returns PedHeadBlendData
Inherited from PlayerPed.getPedHeadBlendData
- Defined in classes/playerPed/clothedPed.ts:48

getPedHeadBlendHeads

getPedHeadBlendHeads(): {
female: number[];
male: number[];
}
Returns {
female: number[];
male: number[];
}
- female: number[]
- male: number[]
Inherited from PlayerPed.getPedHeadBlendHeads
- Defined in classes/playerPed/clothedPed.ts:119

getPedHeadBlendsHeadsByGender

getPedHeadBlendsHeadsByGender(gender): number[]
Parameters
- gender: PlayerGender
Returns number[]
Inherited from PlayerPed.getPedHeadBlendsHeadsByGender
- Defined in classes/playerPed/clothedPed.ts:88

getPedHeadOverlay

getPedHeadOverlay(overlay): PedHeadOverlayData
Parameters
- overlay: PedHeadOverlay
Returns PedHeadOverlayData
Inherited from PlayerPed.getPedHeadOverlay
- Defined in classes/playerPed/clothedPed.ts:261

getPedHeadOverlayColorType

getPedHeadOverlayColorType(overlay): 0 | 1 | 2
Parameters
- overlay: number
Returns 0 | 1 | 2
Inherited from PlayerPed.getPedHeadOverlayColorType
- Defined in classes/playerPed/clothedPed.ts:280

getPedHeadOverlays

getPedHeadOverlays(): Record<
    | "BLEMISHES"
    | "FACIAL_HAIR"
    | "EYEBROWS"
    | "AGEING"
    | "MAKEUP"
    | "BLUSH"
    | "COMPLEXION"
    | "SUN_DAMAGE"
    | "LIPSTICK"
    | "MOLES"
    | "CHEST_HAIR"
    | "BODY_BLEMISHES"
    | "ADD_BODY_BLEMISHES", PedHeadOverlayData>
Returns Record<
    | "BLEMISHES"
    | "FACIAL_HAIR"
    | "EYEBROWS"
    | "AGEING"
    | "MAKEUP"
    | "BLUSH"
    | "COMPLEXION"
    | "SUN_DAMAGE"
    | "LIPSTICK"
    | "MOLES"
    | "CHEST_HAIR"
    | "BODY_BLEMISHES"
    | "ADD_BODY_BLEMISHES", PedHeadOverlayData>
Inherited from PlayerPed.getPedHeadOverlays
- Defined in classes/playerPed/clothedPed.ts:215

getPedProps

getPedProps(): Record<
    | "ANCHOR_HEAD"
    | "ANCHOR_EYES"
    | "ANCHOR_EARS"
    | "ANCHOR_MOUTH"
    | "ANCHOR_LEFT_HAND"
    | "ANCHOR_RIGHT_HAND"
    | "ANCHOR_LEFT_WRIST"
    | "ANCHOR_RIGHT_WRIST"
    | "ANCHOR_HIP"
    | "ANCHOR_LEFT_FOOT"
    | "ANCHOR_RIGHT_FOOT"
    | "ANCHOR_PH_L_HAND"
    | "ANCHOR_PH_R_HAND", {
    drawable: number;
    texture: number;
}>
Returns Record<
    | "ANCHOR_HEAD"
    | "ANCHOR_EYES"
    | "ANCHOR_EARS"
    | "ANCHOR_MOUTH"
    | "ANCHOR_LEFT_HAND"
    | "ANCHOR_RIGHT_HAND"
    | "ANCHOR_LEFT_WRIST"
    | "ANCHOR_RIGHT_WRIST"
    | "ANCHOR_HIP"
    | "ANCHOR_LEFT_FOOT"
    | "ANCHOR_RIGHT_FOOT"
    | "ANCHOR_PH_L_HAND"
    | "ANCHOR_PH_R_HAND", {
    drawable: number;
    texture: number;
}>
Inherited from PlayerPed.getPedProps
- Defined in classes/playerPed/clothedPed.ts:186

getPosition

getPosition(): Vector3
Returns Vector3
Inherited from PlayerPed.getPosition
- Defined in classes/game/entity.ts:43

getRotation

getRotation(): Vector3
Returns Vector3
Inherited from PlayerPed.getRotation
- Defined in classes/game/entity.ts:50

getSize

getSize(): Vector3
Gets the size of the model

Returns Vector3
A vector3 representing the size of the model in the x, y, and z dimensions
Inherited from PlayerPed.getSize
- Defined in classes/game/model.ts:80

getSource

getSource(): number
Returns number
Inherited from PlayerPed.getSource
- Defined in classes/playerPed/ped.ts:17

getUuid

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

getVelocity

getVelocity(): Vector3
Returns Vector3
Inherited from PlayerPed.getVelocity
- Defined in classes/game/entity.ts:54

getVisible

getVisible(): boolean
Returns boolean
Inherited from PlayerPed.getVisible
- Defined in classes/game/entity.ts:67

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 PlayerPed.hash
- Defined in classes/game/model.ts:100

hasJob

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

isFrozen

isFrozen(): boolean
Returns boolean
Inherited from PlayerPed.isFrozen
- Defined in classes/game/entity.ts:71

load

load(wait?): Result
Loads the model into the game
Parameters
- wait: number = 0
  Time to wait for the model to load
Returns Result
Inherited from PlayerPed.load
- Defined in classes/game/model.ts:40

refreshPedHeadBlendData

refreshPedHeadBlendData(): void
Returns void
Inherited from PlayerPed.refreshPedHeadBlendData
- Defined in classes/playerPed/clothedPed.ts:73

resurrect

resurrect(): void
Returns void
Inherited from PlayerPed.resurrect
- Defined in classes/playerPed/ped.ts:37

setAccuracy

setAccuracy(accuracy): void
Parameters
- accuracy: IntRange<0, 101>
Returns void
Inherited from PlayerPed.setAccuracy
- Defined in classes/game/ped.ts:12

setAlpha

setAlpha(alpha): void
Parameters
- alpha: IntRange<0, 256>
Returns void
Inherited from PlayerPed.setAlpha
- Defined in classes/game/entity.ts:58

setConfigFlag

setConfigFlag(flag, value): void
Parameters
- flag: CPedConfigFlags
- value: boolean
Returns void
Inherited from PlayerPed.setConfigFlag
- Defined in classes/game/ped.ts:14

setCurrentDrawableVariation

setCurrentDrawableVariation(component, drawable, texture): void
Parameters
- component: PedComponent
- drawable: number
- texture: number
Returns void
Inherited from PlayerPed.setCurrentDrawableVariation
- Defined in classes/playerPed/clothedPed.ts:242

`Protected`setEntity

setEntity(entityId): void
Parameters
- entityId: number
Returns void
Inherited from PlayerPed.setEntity
- Defined in classes/game/entity.ts:28

setHairColor

setHairColor(color, highlight): void
Parameters
- color: number
- highlight: number
Returns void
Inherited from PlayerPed.setHairColor
- Defined in classes/playerPed/clothedPed.ts:255

setHeading

setHeading(heading): void
Parameters
- heading: IntRange<0, 361>
Returns void
Inherited from PlayerPed.setHeading
- Defined in classes/game/entity.ts:48

setIsMissionEntity

setIsMissionEntity(value): void
Parameters
- value: boolean
Returns void
Inherited from PlayerPed.setIsMissionEntity
- Defined in classes/game/entity.ts:65

`Protected`setModel

setModel(model): void
Parameters
- model: string | number
Returns void
Inherited from PlayerPed.setModel
- Defined in classes/game/model.ts:26

setPedData

setPedData(data): void
Sets the ped data from a PedData object. Does not set the ped model to the one from PedData.pedModel, it assumes the ped given to the constructor already has that model.
Parameters
- data: PedData
Returns void
Inherited from PlayerPed.setPedData
- Defined in classes/playerPed/clothedPed.ts:464

setPedFaceFeature

setPedFaceFeature(feature, value): void
Parameters
- feature: FaceFeature
- value: number
Returns void
Inherited from PlayerPed.setPedFaceFeature
- Defined in classes/playerPed/clothedPed.ts:257

setPedHeadBlendData

setPedHeadBlendData(__namedParameters): void
Parameters
- __namedParameters: PedHeadBlendData
Returns void
Inherited from PlayerPed.setPedHeadBlendData
- Defined in classes/playerPed/clothedPed.ts:49

setPedHeadOverlay

setPedHeadOverlay(overlay, index, opacity): void
Parameters
- overlay: PedHeadOverlay
- index: number
- opacity: number
Returns void
Inherited from PlayerPed.setPedHeadOverlay
- Defined in classes/playerPed/clothedPed.ts:291

setPedHeadOverlayColor

setPedHeadOverlayColor(overlay, firstColor, secondColor): void
Parameters
- overlay: PedHeadOverlay
- firstColor: number
- secondColor: number
Returns void
Inherited from PlayerPed.setPedHeadOverlayColor
- Defined in classes/playerPed/clothedPed.ts:293

setPlayerModel

setPlayerModel(model_): void
Parameters
- model_: string | number
Returns void
Inherited from PlayerPed.setPlayerModel
- Defined in classes/playerPed/ped.ts:20

setPosition

setPosition(position): void
Parameters
- position: Vector3
Returns void
Inherited from PlayerPed.setPosition
- Defined in classes/game/entity.ts:44

setPropDrawableVariation

setPropDrawableVariation(component, drawable, texture): void
Parameters
- component: PedProps
- drawable: number
- texture: number
Returns void
Inherited from PlayerPed.setPropDrawableVariation
- Defined in classes/playerPed/clothedPed.ts:277

setRotation

setRotation(rotation): void
Parameters
- rotation: Vector3
Returns void
Inherited from PlayerPed.setRotation
- Defined in classes/game/entity.ts:51

setSource

setSource(source): number
Parameters
- source: number
Returns number
Inherited from PlayerPed.setSource
- Defined in classes/playerPed/ped.ts:18

setVelocity

setVelocity(velocity): void
Parameters
- velocity: Vector3
Returns void
Inherited from PlayerPed.setVelocity
- Defined in classes/game/entity.ts:55

setVisible

setVisible(value): void
Parameters
- value: boolean
Returns void
Inherited from PlayerPed.setVisible
- Defined in classes/game/entity.ts:68

toNet

toNet(): CNetEntity
Converts the entity to a network entity

Returns CNetEntity
An instance to a CNetEntity
Inherited from PlayerPed.toNet
- Defined in classes/game/entity.ts:89

toObject

toObject(): PedData
Returns PedData
Inherited from PlayerPed.toObject
- Defined in classes/playerPed/clothedPed.ts:428

unload

unload(): void
Unloads the model from the game

Returns void
Inherited from PlayerPed.unload
- Defined in classes/game/model.ts:51

`Static`create

create(model, coords, isNetwork, netMissionEntity): Result<CPed>
No Self
Parameters
- model: CModel
- coords: Vector3
- isNetwork: boolean
- netMissionEntity: boolean
Returns Result<CPed>
Inherited from PlayerPed.create
- Defined in classes/game/ped.ts:30

`Static`fromNet

fromNet(netId): Result<CPed>
No Self
Parameters
- netId: number
Returns Result<CPed>
Inherited from PlayerPed.fromNet
- Defined in classes/game/ped.ts:48

`Static`getInstance

getInstance(): Optional<Player>
No Self
Returns Optional<Player>
- Defined in classes/player.ts:66

`Static`onPlayerReady

onPlayerReady(cb): void
No Self
Parameters
- cb: ((player: Player) => void)
  - - (player): void
    - Parameters
      player: Player
      Returns void
Returns void
- Defined in classes/player.ts:81

`Static`onPlayerReadySync

onPlayerReadySync(): Player
No Self
Returns Player
- Defined in classes/player.ts:87

`Static`playerPed

playerPed(): CPed
No Self
Returns CPed
Inherited from PlayerPed.playerPed
- Defined in classes/game/ped.ts:45

`Static`setInstance

setInstance(instance): void
No Self
Static method called by the server to set the instance of the player with the initial player data Never call this function manually
Parameters
- instance: Player
  Instance of the player
Returns void
- Defined in classes/player.ts:75

Class Player

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Player

Properties

ProtectedentityId

ProtectedmodelHash

ProtectedmodelName

Methods

asJSON

Returns string

asString

Returns string

clone

Returns this

compare

Parameters

Returns -1 | 0 | 1

delete

Returns void

equals

Parameters

Returns boolean

freeze

Parameters

Returns void

getAccuracy

Returns IntRange<0, 101>

getAlpha

Returns IntRange<0, 256>

getClosestEntityOfType

Parameters

Returns Optional<CEntity>

getConfigFlag

Parameters

Returns boolean

getCurrentDrawableVariation

Parameters

Returns number

getCurrentPropDrawableVariation

Parameters

Returns number

getCurrentPropTextureVariation

Parameters

Returns number

getCurrentTextureVariation

Parameters

Returns number

getData

Returns PlayerData

getDimensions

Returns [min: Vector3, max: Vector3]

See

getEntity

Returns number

getEntityType

Returns CEntityType

getExists

Returns boolean

getGang

Parameters

Returns undefined | PlayerGang

getGangIndex

Parameters

Returns number

getGangs

Returns PlayerGang[]

getHairColor

Returns Result<number>

getHairHightlightColor

Returns Result<number>

getHash

Returns number

getHeading

`Protected`entityId

`Protected`modelHash

`Protected`modelName

Returns Record<
| "COMP_HEAD"
| "COMP_BERD"
| "COMP_HAIR"
| "COMP_UPPR"
| "COMP_LOWR"
| "COMP_HAND"
| "COMP_FEET"
| "COMP_TEEF"
| "COMP_ACCS"
| "COMP_TASK"
| "COMP_DECL"
| "COMP_JBIB", Record<number, number>>

Returns Record<
| "BLEMISHES"
| "FACIAL_HAIR"
| "EYEBROWS"
| "AGEING"
| "MAKEUP"
| "BLUSH"
| "COMPLEXION"
| "SUN_DAMAGE"
| "LIPSTICK"
| "MOLES"
| "CHEST_HAIR"
| "BODY_BLEMISHES"
| "ADD_BODY_BLEMISHES", number>

Returns Record<
| "ANCHOR_HEAD"
| "ANCHOR_EYES"
| "ANCHOR_EARS"
| "ANCHOR_MOUTH"
| "ANCHOR_LEFT_HAND"
| "ANCHOR_RIGHT_HAND"
| "ANCHOR_LEFT_WRIST"
| "ANCHOR_RIGHT_WRIST"
| "ANCHOR_HIP"
| "ANCHOR_LEFT_FOOT"
| "ANCHOR_RIGHT_FOOT"
| "ANCHOR_PH_L_HAND"
| "ANCHOR_PH_R_HAND", Record<number, number>>

Returns Record<
| "COMP_HEAD"
| "COMP_BERD"
| "COMP_HAIR"
| "COMP_UPPR"
| "COMP_LOWR"
| "COMP_HAND"
| "COMP_FEET"
| "COMP_TEEF"
| "COMP_ACCS"
| "COMP_TASK"
| "COMP_DECL"
| "COMP_JBIB", {
drawable: number;
texture: number;
}>

Returns {
female: number[];
male: number[];
}

Returns Record<
| "BLEMISHES"
| "FACIAL_HAIR"
| "EYEBROWS"
| "AGEING"
| "MAKEUP"
| "BLUSH"
| "COMPLEXION"
| "SUN_DAMAGE"
| "LIPSTICK"
| "MOLES"
| "CHEST_HAIR"
| "BODY_BLEMISHES"
| "ADD_BODY_BLEMISHES", PedHeadOverlayData>