a library to speed up the development of Fivem scripts and frameworks
fivem-ts - Documentation v0.7.5 • Docs
fivem-ts - Documentation v0.7.5 / Client / Ped
Represents a pedestrian character (Ped) in the game world.
new Ped(
owner):Ped
• owner: number
getAttachedBlip():Blip
Retrieves the attached blip for the entity. If a valid blip handle exists for the entity, it returns a new Blip instance; otherwise, it returns null.
The attached Blip instance or null if no valid blip exists.
getBones():PedBoneCollection
Retrieves the EntityBoneCollection associated with this entity.
Entity Bone Collection of Entity
getCanRagdoll():boolean
setCanRagdoll(value):void
• value: boolean
boolean
getCurrentVehicle():Vehicle
setDrivingSpeed(value):void
• value: number
getDrivingStyle():DrivingStyle
setDrivingStyle(style):void
• style: DrivingStyle
setDropsWeaponsOnDeath(value):void
• value: boolean
setFiringPattern(value):void
• value: number
getHandle():number
Gets the handle value.
number
The handle value as a number.
getHasCollided():boolean
Checks if the entity with the specified handle has collided with anything.
boolean
Returns true if the entity has collided with anything, otherwise false.
setHasGravity(value):void
Sets whether the entity has gravity.
• value: boolean
A boolean value indicating whether the entity should have gravity.
getHeading():number
Retrieves the current heading of the entity.
setHeading(heading):void
Sets the heading of an entity to a specified value.
• heading: number
The new heading value for the entity.
number
The heading of the entity.
getHealth():number
Retrieves the current health of the entity.
setHealth(health):void
Retrieves the current health of the entity.
• health: number
number
The health of the entity.
getHeightAboveGround():number
Calculates and returns the height of the entity above the ground level.
number
The height of the entity above the ground.
getIsAimingFromCover():boolean
boolean
getIsAlive():boolean
Checks the living status of the entity.
boolean
Returns true if the entity is alive, otherwise false.
getIsAmbientSpeechEnabled():boolean
boolean
getIsAmbientSpeechPlaying():boolean
boolean
getIsAnySpeechPlaying():boolean
boolean
getIsBeingJacked():boolean
boolean
getIsBeingStealthKilled():boolean
boolean
getIsBeingStunned():boolean
boolean
getIsClimbing():boolean
boolean
getIsCollisionEnabled():boolean
Checks if collision is enabled for
setIsCollisionEnabled(value):void
Enables or disables collision detection for the entity.
• value: boolean
A boolean indicating whether collision should be enabled (true) or disabled (false).
boolean
getIsCuffed():boolean
boolean
getIsDead():boolean
Checks whether the entity is dead.
boolean
Returns true if the entity is dead, otherwise false.
getIsDiving():boolean
boolean
getIsDoingDriveBy():boolean
boolean
getIsDucking():boolean
setIsDucking(value):void
• value: boolean
boolean
setIsEnemy(value):void
• value: boolean
getIsFalling():boolean
boolean
getIsFleeing():boolean
boolean
getIsGettingIntoAVehicle():boolean
boolean
getIsGettingUp():boolean
boolean
getIsGoingIntoCover():boolean
boolean
getIsHuman():boolean
boolean
getIsIdle():boolean
boolean
getIsInAir():boolean
Determines if the entity is currently in the air.
boolean
A boolean value indicating whether the entity is airborne.
getIsInBoat():boolean
boolean
getIsInCombat():boolean
boolean
getIsInCoverFacingLeft():boolean
boolean
getIsInFlyingVehicle():boolean
boolean
getIsInGroup():boolean
boolean
getIsInHeli():boolean
boolean
getIsInjured():boolean
boolean
getIsInMeleeCombat():boolean
boolean
getIsInParachuteFreeFall():boolean
boolean
getIsInPlane():boolean
boolean
getIsInPoliceVehicle():boolean
boolean
getIsInStealthMode():boolean
boolean
getIsInSub():boolean
boolean
getIsInTaxi():boolean
boolean
getIsInTrain():boolean
boolean
setIsInvincible(value):void
Sets the invincibility status of the entity.
• value: boolean
A boolean value where true makes the entity invincible and false removes invincibility.
getIsInWater():boolean
Determines if the entity represented by this instance is in water.
boolean
True if the entity is in water, otherwise false.
getIsJacking():boolean
boolean
getIsJumping():boolean
boolean
getIsJumpingOutOfVehicle():boolean
boolean
getIsOccluded():boolean
Checks if the current entity is occluded.
This method determines whether the entity associated with the current instance is occluded, meaning it is blocked from view by other objects or entities.
boolean
getIsOnBike():boolean
boolean
getIsOnFire():boolean
Checks if the entity is currently on fire.
boolean
getIsOnFoot():boolean
boolean
setIsOnlyDamagedByPlayer(value):void
Modifies the entity to only take damage from players.
• value: boolean
If true, the entity will only be damaged by players; otherwise, it can be damaged by other sources.
getIsOnScreen():boolean
Checks if the entity represented by this object is currently visible on the screen.
boolean
True if the entity is on the screen, false otherwise.
setIsPainAudioEnabled(value):void
• value: boolean
getIsPerformingStealthKill():boolean
boolean
getIsPersistent():boolean
Determines whether the current entity is persistent.
setIsPersistent(value):void
• value: boolean
boolean
True if the entity is persistent; otherwise, false.
getIsPlantingBomb():boolean
boolean
getIsPlayer():boolean
boolean
setIsPositionFrozen(value):void
Sets the frozen state of the entity’s position.
• value: boolean
If true, the entity’s position will be frozen. If false, the entity’s position will be unfrozen.
setIsPriorityTargetForEnemies(value):void
• value: boolean
getIsProne():boolean
boolean
getIsRagdoll():boolean
boolean
setIsRecordingCollisions(value):void
Sets whether the entity is recording collisions.
• value: boolean
A boolean indicating whether the entity should record collisions.
getIsReloading():boolean
boolean
getIsRunning():boolean
boolean
getIsScriptedSpeechPlaying():boolean
boolean
getIsShooting():boolean
boolean
getIsSprinting():boolean
boolean
getIsStopped():boolean
boolean
getIsSwimming():boolean
boolean
getIsSwimmingUnderWater():boolean
boolean
getIsTryingToEnterALockedVehicle():boolean
boolean
getIsUpright():boolean
Checks if the entity is in an upright position.
boolean
True if the entity is upright, false otherwise.
getIsUpsideDown():boolean
Determines if the entity is upside down. This method checks the orientation
boolean
getIsVaulting():boolean
boolean
getIsVisible():boolean
Check if the entity is currently visible.
setIsVisible(value):void
Sets the visibility of the entity.
• value: boolean
A boolean value indicating whether the entity should be visible.
boolean
True if the entity is visible, otherwise false.
getIsWalking():boolean
boolean
getIsWearingHelmet():boolean
boolean
getJacker():Ped
getJackTarget():Ped
getKiller():Entity
getLastVehicle():Vehicle
getLodDistance():number
Retrieves the Level of Detail (LOD) distance for the current entity.
setLodDistance(value):void
Sets the Level of Detail (LOD) distance for the entity.
• value: number
The distance at which the entity will switch LOD models.
number
The LOD distance of the entity.
setMaxDrivingSpeed(value):void
• value: number
getMaxHealth():number
Retrieves the maximum health value of an entity.
setMaxHealth(amount):void
Retrieves the maximum health value of an entity.
• amount: number
number
The maximum health of the entity.
setMaxSpeed(value):void
Sets the maximum speed for the entity.
• value: number
The maximum speed to be set for the entity.
getMeleeTarget():Ped
getModel():Model
Gets an instance of the Model class.
A new instance of the Model class initialized with the entity model of the current handle.
getNetworkId():number
Retrieves the network ID associated with the current entity.
number
The network ID of the entity.
setNeverLeavesGroup(value):void
• value: boolean
getOpacity():number
Retrieves the opacity level of the entity associated with this handle.
setOpacity(value):void
Sets the opacity (alpha value) of this entity.
• value: number
The opacity value to set, where 0 is fully transparent and 255 is fully opaque.
number
The opacity level as a number, where 0 represents fully transparent and 255 represents fully opaque.
getPosition():Vector3
Gets the current position of the entity as a Vector3 object.
setPosition(vector):void
Sets the position of the entity to the specified coordinates.
• vector: Vector3
The vector containing the new coordinates (x, y, z).
The position of the entity in 3D space.
getQuaternion():Quaternion
Retrieves the quaternion for the current entity.
setQuaternion(quaternion):void
Sets the quaternion values for this entity.
• quaternion: Quaternion
The quaternion object containing x, y, z, and w components.
The quaternion representing the entity’s orientation.
getRotation():Vector3
Retrieves the rotation of the entity as a Vector3.
setRotation(vector):void
Sets the rotation of the entity.
• vector: Vector3
The vector representing the new rotation angles (in degrees) for the entity.
The rotation of the
getRotationVelocity():Vector3
Retrieves the current rotation velocity of an entity. The rotation velocity is represented as a Vector3 object.
The rotation velocity of the entity.
getSpeechModifiersName():string[]
string[]
setStaysInVehicleWhenJacked(value):void
• value: boolean
getSubmersionLevel():number
Retrieves the submersion level of the entity as a number.
number
The submersion level of the entity, where a higher value indicates a greater degree of submersion.
getVehicleTryingToEnter():Vehicle
getVelocity():Vector3
Computes and returns the velocity of the entity as a Vector3
setVelocity(velocity):void
Sets the velocity for the entity.
• velocity: Vector3
applyDamage(
damageAmount):void
• damageAmount: number
void
applyForce(
direction,rotation,forceType?):void
Applies a force to the entity in a specified direction and with a specified rotation.
• direction: Vector3
The direction in which the force is to be applied.
• rotation: Vector3
The rotational force to be applied.
• forceType?: ForceType = ForceType.MaxForceRot2
The type of force to be applied, default is MaxForceRot2.
void
applyForceRelative(
direction,rotation,forceType?):void
Applies a force to an entity in a direction relative to its current rotation.
• direction: Vector3
The direction vector in which the force is applied.
• rotation: Vector3
The rotation vector representing the entity’s current rotation.
• forceType?: ForceType = ForceType.MaxForceRot2
The type of force to be applied. Defaults to MaxForceRot2.
void
attachBlip():
Blip
Attaches a blip to the entity associated with this instance.
The newly created Blip associated with the entity.
attachTo(
entity,position,rotation):void
Attaches the current entity to a specified target entity at a given position and rotation.
• entity: Entity
The target entity to attach to.
• position: Vector3
The position offset from the target entity.
• rotation: Vector3
The rotation offset from the target entity.
void
attachToBone(
entityBone,position,rotation):void
Attaches the current entity to a specified bone of another entity with given position and rotation offsets.
• entityBone: EntityBone
The bone of the target entity to attach this entity to.
• position: Vector3
The position offset relative to the bone position.
• rotation: Vector3
The rotation offset relative to the bone orientation.
void
cancelRagdoll():
void
void
clearBloodDamage():
void
void
clearLastWeaponDamage():
void
Clears the last recorded weapon damage for the entity.
void
This method does not return a value.
clone(
networked):Ped
• networked: boolean
delete():
void
Deletes the current entity if it is not the player’s entity. The method first sets the entity as a mission entity and then deletes it.
void
No return value.
detach():
void
Detaches the current entity from its parent, effectively making it independent.
This method calls DetachEntity with parameters to ensure the entity is completely detached,
handling any necessary dependencies and housekeeping.
void
No return value.
exists():
boolean
Checks if the entity exists in the current context.
boolean
True if the entity exists, otherwise false.
getConfigFlag(
flagId):boolean
• flagId: number
boolean
getEntityAttachedTo():
Entity
Returns the entity to which this entity is attached.
The entity that this entity is attached to.
getLastWeaponImpactPosition():
Vector3
Experimental
Retrieves the last recorded impact position of a weapon. To Check after v0.9.0 update
The position where the last weapon impact occurred.
getOffsetPosition(
offset):Vector3
Calculates the world position offset from the entity’s current position.
• offset: Vector3
The local offset vector to be applied to the entity’s position.
The new world position vector after applying the given offset.
getPositionOffset(
worldCoords):Vector3
Calculates the position offset from the given world coordinates.
• worldCoords: Vector3
The world coordinates to calculate the offset from.
giveHelmet(
canBeRemoved,helmetType,textureIndex):void
• canBeRemoved: boolean
• helmetType: HelmetType
• textureIndex: number
void
giveWeapon(
weapon,ammoCount?,isHidden?,equipNow?):void
Assigns a weapon to the character with specified properties.
• weapon: WeaponsHash
The type of weapon to give.
• ammoCount?: number = 999
The amount of ammunition for the weapon.
• isHidden?: boolean = false
Whether the weapon should be hidden.
• equipNow?: boolean = true
Whether the weapon should be equipped immediately.
void
hasBeenDamagedBy(
entity):boolean
Determines if the current entity has been damaged by the specified entity.
• entity: Entity
The entity to check against for damage.
boolean
hasBeenDamagedByAnyMeleeWeapon():
boolean
Checks if the entity has been damaged by any melee weapon.
This method determines whether the entity, represented by the ‘handle’, has sustained damage from any weapon falling under the melee category.
boolean
True if the entity has been damaged by any melee weapon; otherwise, false.
Entity.hasBeenDamagedByAnyMeleeWeapon
hasBeenDamagedByAnyWeapon():
boolean
Checks if the entity has been damaged by any weapon.
boolean
True if the entity has been damaged by any weapon; otherwise, false.
Entity.hasBeenDamagedByAnyWeapon
hasBeenDamagedByWeapon(
weapon):boolean
Checks if the entity has been damaged by the specified weapon.
• weapon: WeaponsHash
The weapon to check against.
boolean
hasClearLosToEntity(
entity,traceType?):boolean
Checks if there is a clear line of sight to the specified entity.
• entity: Entity
The entity to check line of sight to.
• traceType?: number = 17
The type of trace to use for the line of sight check.
boolean
hasClearLosToEntityInFront(
entity):boolean
Determines if there is a clear line of sight (LOS) from the current entity to the specified entity in front.
• entity: Entity
The target entity to check LOS against.
boolean
Entity.hasClearLosToEntityInFront
isAttached():
boolean
Determines if the entity is currently attached.
boolean
True if the entity is attached, otherwise false.
isAttachedTo(
entity):boolean
Checks whether the current entity is attached to the specified entity.
• entity: Entity
The entity to which the current entity might be attached.
boolean
True if the current entity is attached to the specified entity, false otherwise.
isHeadtracking(
entity):boolean
• entity: Entity
boolean
isInAngledArea(
origin,edge,angle):boolean
Determines if the entity is within an angled area specified by an origin point, an edge point, and an angle.
• origin: Vector3
The origin point of the angled area.
• edge: Vector3
The edge point defining the angled area’s width.
• angle: number
The angle of the area.
boolean
isInAnyVehicle():
boolean
boolean
isInArea(
minBounds,maxBounds):boolean
Checks if the current entity is within the specified area defined by the minimum and maximum bounds.
• minBounds: Vector3
A Vector3 object representing the minimum bounds of the area.
• maxBounds: Vector3
A Vector3 object representing the maximum bounds of the area.
boolean
isInCombatAgainst(
target):boolean
• target: Ped
boolean
isInCover(
expectUseWeapon):boolean
• expectUseWeapon: boolean = false
boolean
isInRangeOf(
position,range):boolean
Determines whether a given position is within a specified range of this object’s position.
• position: Vector3
The position to check against this object’s position.
• range: number
The range within which to check.
boolean
Returns true if the given position is within the specified range, otherwise false.
isInVehicle(
vehicle):boolean
• vehicle: Vehicle
boolean
isNearEntity(
entity,bounds):boolean
Checks if the current entity is near the specified entity within the given bounds.
• entity: Entity
The entity to check proximity against.
• bounds: Vector3
The 3D vector specifying the bounds to check within.
boolean
isSittingInAnyVehicle():
boolean
boolean
isSittingInVehicle(
vehicle):boolean
• vehicle: Vehicle
boolean
isTouching(
entity):boolean
Checks if the current entity is touching the specified entity.
• entity: Entity
The entity to check against.
boolean
True if the current entity is touching the specified entity, otherwise false.
isTouchingModel(
model):boolean
Checks if the current entity is touching the specified model.
• model: Model
The model to check against.
boolean
kill():
void
void
leaveGroup():
void
void
markAsNoLongerNeeded():
void
Marks the entity as no longer needed by the game, which allows the game engine to clean it up as necessary. This method effectively turns off the mission flag for the entity and informs the system that it can regard this entity as disposable.
void
No return value.
openParachute():
void
void
playAmbientSpeed(
speechName,voiceName,modifier):void
• speechName: string
• voiceName: string = ''
• modifier: SpeechModifier = SpeechModifier.Standard
void
ragdoll(
duration,ragdollType):void
• duration: number = -1
• ragdollType: RagdollType = RagdollType.Normal
void
ragdollWithFall(
duration,ragdollType,position):void
• duration: number = -1
• ragdollType: RagdollType = RagdollType.Normal
• position: Vector3 = ...
void
removeAllParticleEffects():
void
Removes all particle effects from the entity associated with this instance.
void
This method does not return a value.
Entity.removeAllParticleEffects
removeAllWeapons():
void
Removes all weapons from the current entity.
This method will strip the entity of all weapons it currently possesses.
void
removeHelmet(
instantly):void
• instantly: boolean
void
removeWeapon(
weapon):void
Removes the specified weapon from the current entity.
• weapon: WeaponsHash
The hash of the weapon to be removed.
void
resetConfigFlag(
flagId):void
• flagId: number
void
resetOpacity():
void
void
resetVisibleDamage():
void
void
resurrect():
void
void
setConfigFlag(
flagId,value):void
• flagId: number
• value: boolean
void
setIntoVehicle(
vehicle,seat):void
• vehicle: Vehicle
• seat: VehicleSeat
void
setNoCollision(
entity,toggle):void
Sets the no-collision state between this entity and another entity.
• entity: Entity
The entity with which collision state will be set.
• toggle: boolean
A boolean flag indicating whether to enable or disable the no-collision state.
void
Creates an instance of Ped, Vehicle, or Prop based on the given handle.
• handle: number
The handle of the entity.
Converts a network identifier to a corresponding entity (Ped, Vehicle, or Prop).
• networkId: number
The network identifier for the entity.