Class CPed

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)

CEntity
- CPed
  - ClothedPed

Constructors

constructor

new CPed(pedId): CPed
Parameters
- pedId: number
Returns CPed
Overrides CEntity.constructor
- Defined in classes/game/ped.ts:8

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 CEntity.asJSON
- Defined in shared/classes/byteObject.ts:43

asString

asString(): string
Returns string
A string representation of the object.
Overrides CEntity.asString
- Defined in classes/game/ped.ts:25

clone

clone(): this
Clones the object.

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

delete

delete(): void
Returns void
Overrides CEntity.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 CEntity.equals
- Defined in classes/game/entity.ts:95

freeze

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

getAccuracy

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

getAlpha

getAlpha(): IntRange<0, 256>
Returns IntRange<0, 256>
Inherited from CEntity.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 CEntity.getClosestEntityOfType
- Defined in classes/game/entity.ts:73

getConfigFlag

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

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 CEntity.getDimensions
- Defined in classes/game/model.ts:70

getEntity

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

getEntityType

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

getExists

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

getHash

getHash(): number
Getter for the model hash

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

getHeading

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

getIsInCdImage

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

getIsLoaded

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

getIsMissionEntity

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

getIsModelValid

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

getMaxHealth

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

getModel

getModel(): CModel
Returns CModel
Inherited from CEntity.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 CEntity.getName
- Defined in classes/game/model.ts:63

getNetworkId

getNetworkId(): number
Returns number
Overrides CEntity.getNetworkId
- Defined in classes/game/ped.ts:23

getPosition

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

getRotation

getRotation(): Vector3
Returns Vector3
Inherited from CEntity.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 CEntity.getSize
- Defined in classes/game/model.ts:80

getVelocity

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

getVisible

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

hash

hash(): number
Returns number
A hash code for the object instance.
Inherited from CEntity.hash
- Defined in classes/game/model.ts:100

isFrozen

isFrozen(): boolean
Returns boolean
Inherited from CEntity.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 CEntity.load
- Defined in classes/game/model.ts:40

resurrect

resurrect(): void
Returns void
- Defined in classes/game/ped.ts:18

setAccuracy

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

setAlpha

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

setConfigFlag

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

`Protected`setEntity

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

setHeading

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

setIsMissionEntity

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

`Protected`setModel

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

setPosition

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

setRotation

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

setVelocity

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

setVisible

setVisible(value): void
Parameters
- value: boolean
Returns void
Inherited from CEntity.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 CEntity.toNet
- Defined in classes/game/entity.ts:89

unload

unload(): void
Unloads the model from the game

Returns void
Inherited from CEntity.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>
- Defined in classes/game/ped.ts:30

`Static`fromNet

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

`Static`playerPed

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