Class Ped

Inheritance
Object
PoolObject
Entity
Ped
Inherited Members
Namespace: GTA
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class Ped : Entity, INativeValue, IDeletable, IExistable, ISpatial

Properties

| Improve this Doc View Source

Accuracy

Gets or sets how accurate this Peds shooting ability is. The higher the value of this property is, the more likely it is that this Ped will shoot at exactly where they are aiming at.

Declaration
public int Accuracy { get; set; }
Property Value
Type Description
Int32

The accuracy from 0 to 100, 0 being very inaccurate, which means this Ped cannot shoot at exactly where they are aiming at, 100 being perfectly accurate.
| Improve this Doc View Source

AlwaysKeepTask

Declaration
public bool AlwaysKeepTask { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Armor

Gets or sets how much armor this Ped is wearing as an Int32.

Declaration
public int Armor { get; set; }
Property Value
Type Description
Int32

The armor as an Int32.
Remarks

if you need to get or set the value precisely, use ArmorFloat instead.

| Improve this Doc View Source

ArmorFloat

Gets or sets how much Armor this Ped is wearing as a Single.

Declaration
public float ArmorFloat { get; set; }
Property Value
Type Description
Single

The armor as a Single.
| Improve this Doc View Source

BlockPermanentEvents

Sets whether permanent events are blocked for this Ped. If permanent events are blocked, this Ped will only do as it's told, and won't flee when shot at, etc.

Declaration
public bool BlockPermanentEvents { set; }
Property Value
Type Description
Boolean

true if permanent events are blocked; otherwise, false.
| Improve this Doc View Source

Bones

Gets a collection of the PedBones in this Ped.

Declaration
public PedBoneCollection Bones { get; }
Property Value
Type Description
PedBoneCollection
| Improve this Doc View Source

CanBeDraggedOutOfVehicle

Declaration
public bool CanBeDraggedOutOfVehicle { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanBeKnockedOffBike

Declaration
public bool CanBeKnockedOffBike { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanBeShotInVehicle

Declaration
public bool CanBeShotInVehicle { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanBeTargetted

Declaration
public bool CanBeTargetted { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanFlyThroughWindscreen

Declaration
public bool CanFlyThroughWindscreen { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanPlayGestures

Declaration
public bool CanPlayGestures { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanRagdoll

Declaration
public bool CanRagdoll { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanSufferCriticalHits

Gets or Sets whether this Ped can suffer critical damage (which deals 1000 times base damages to non-player characters with default weapon configs) when bullets hit this Ped's head bone or its child bones. If this Ped can't suffer critical damage, they will take base damage of weapons when bullets hit their head bone or its child bones, just like when bullets hit a bone other than their head bone, its child bones, or limb bones.

Declaration
public bool CanSufferCriticalHits { get; set; }
Property Value
Type Description
Boolean

true if this Ped can suffer critical damage; otherwise, false.
| Improve this Doc View Source

CanSwitchWeapons

Sets if this Ped can switch between different weapons.

Declaration
public bool CanSwitchWeapons { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanWearHelmet

Declaration
public bool CanWearHelmet { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CanWrithe

Declaration
public bool CanWrithe { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

CauseOfDeath

Gets the WeaponHash that this Ped is killed with. The return value is not necessarily a weapon hash for a human Peds (e.g. can be the hash of WEAPON_COUGAR).

Declaration
public WeaponHash CauseOfDeath { get; }
Property Value
Type Description
WeaponHash
| Improve this Doc View Source

CurrentVehicle

Gets the current Vehicle this Ped is using.

Declaration
public Vehicle CurrentVehicle { get; }
Property Value
Type Description
Vehicle
Remarks

returns null if this Ped isn't in a Vehicle.

| Improve this Doc View Source

DiesInstantlyInWater

Declaration
public bool DiesInstantlyInWater { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

DiesOnLowHealth

Declaration
public bool DiesOnLowHealth { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

DrivingSpeed

Declaration
public float DrivingSpeed { set; }
Property Value
Type Description
Single
| Improve this Doc View Source

DrivingStyle

Declaration
public DrivingStyle DrivingStyle { set; }
Property Value
Type Description
DrivingStyle
| Improve this Doc View Source

DropsEquippedWeaponOnDeath

Sets whether this Ped will drop the equipped weapon when they get killed. Note that Peds will drop only their equipped weapon when they get killed.

Declaration
public bool DropsEquippedWeaponOnDeath { get; set; }
Property Value
Type Description
Boolean

true if Ped drops the equipped weapon when killed; otherwise, false.
| Improve this Doc View Source

DrownsInSinkingVehicle

Declaration
public bool DrownsInSinkingVehicle { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

DrownsInWater

Declaration
public bool DrownsInWater { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Euphoria

Opens a list of Euphoria Helpers which can be applied to this Ped.

Declaration
public Euphoria Euphoria { get; }
Property Value
Type Description
Euphoria
| Improve this Doc View Source

FatalInjuryHealthThreshold

Gets or sets the fatal injury health threshold for this Ped. The pedestrian health will be set to 0.0 when it drops below this value.

Declaration
public float FatalInjuryHealthThreshold { get; set; }
Property Value
Type Description
Single

The fatal injury health threshold. Should be below MaxHealth.
Remarks

Note on player controlled pedestrians: One of the game scripts will consider the player wasted when their health drops below InjuryHealthThreshold, regardless of this setting.

| Improve this Doc View Source

FiringPattern

Gets of sets the pattern this Ped uses to fire weapons.

Declaration
public FiringPattern FiringPattern { get; set; }
Property Value
Type Description
FiringPattern
| Improve this Doc View Source

Gender

Gets the gender of this Ped.

Declaration
public Gender Gender { get; }
Property Value
Type Description
Gender
| Improve this Doc View Source

HearingRange

Declaration
public float HearingRange { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

InjuryHealthThreshold

Gets or sets the injury health threshold for this Ped. The pedestrian is considered injured when its health drops below this value. The pedestrian dies on attacks when its health is below this value.

Declaration
public float InjuryHealthThreshold { get; set; }
Property Value
Type Description
Single

The injury health threshold. Should be below MaxHealth.
Remarks

Note on player controlled pedestrians: One of the game scripts will consider the player wasted when their health drops below this setting value.

| Improve this Doc View Source

IsAiming

Declaration
public bool IsAiming { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsAimingFromCover

Declaration
public bool IsAimingFromCover { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsAmbientSpeechEnabled

Declaration
public bool IsAmbientSpeechEnabled { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsAmbientSpeechPlaying

Declaration
public bool IsAmbientSpeechPlaying { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsAnySpeechPlaying

Declaration
public bool IsAnySpeechPlaying { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsBeingJacked

Declaration
public bool IsBeingJacked { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsBeingStealthKilled

Declaration
public bool IsBeingStealthKilled { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsBeingStunned

Declaration
public bool IsBeingStunned { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsClimbing

Declaration
public bool IsClimbing { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsCuffed

Declaration
public bool IsCuffed { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsDiving

Declaration
public bool IsDiving { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsDoingDriveBy

Declaration
public bool IsDoingDriveBy { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsDucking

Declaration
public bool IsDucking { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsEnemy

Declaration
public bool IsEnemy { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsFalling

Declaration
public bool IsFalling { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsFleeing

Declaration
public bool IsFleeing { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsGettingIntoVehicle

Declaration
public bool IsGettingIntoVehicle { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsGettingUp

Declaration
public bool IsGettingUp { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsGoingIntoCover

Declaration
public bool IsGoingIntoCover { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsHuman

Gets a value indicating whether this Ped is human.

Declaration
public bool IsHuman { get; }
Property Value
Type Description
Boolean

true if this Ped is human; otherwise, false.
| Improve this Doc View Source

IsIdle

Declaration
public bool IsIdle { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInBoat

Declaration
public bool IsInBoat { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInCombat

Declaration
public bool IsInCombat { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInCover

Declaration
public bool IsInCover { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInCoverFacingLeft

Declaration
public bool IsInCoverFacingLeft { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInFlyingVehicle

Declaration
public bool IsInFlyingVehicle { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInGroup

Gets if this Ped is in a PedGroup.

Declaration
public bool IsInGroup { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInHeli

Declaration
public bool IsInHeli { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInjured

Gets a value indicating whether this Ped is injured (Health of the Ped is lower than InjuryHealthThreshold) or does not exist. Can be called safely to check if Peds exist and are not injured without calling Exists().

Declaration
public bool IsInjured { get; }
Property Value
Type Description
Boolean

true this Ped is injured or does not exist; otherwise, false.
See Also
| Improve this Doc View Source

IsInMeleeCombat

Declaration
public bool IsInMeleeCombat { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInParachuteFreeFall

Declaration
public bool IsInParachuteFreeFall { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInPlane

Declaration
public bool IsInPlane { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInPoliceVehicle

Declaration
public bool IsInPoliceVehicle { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInStealthMode

Declaration
public bool IsInStealthMode { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInSub

Declaration
public bool IsInSub { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInTaxi

Declaration
public bool IsInTaxi { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsInTrain

Declaration
public bool IsInTrain { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsJacking

Declaration
public bool IsJacking { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsJumping

Declaration
public bool IsJumping { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsJumpingOutOfVehicle

Gets a value indicating whether this Ped is jumping out of their vehicle.

Declaration
public bool IsJumpingOutOfVehicle { get; }
Property Value
Type Description
Boolean

true if this Ped is jumping out of their vehicle; otherwise, false.
| Improve this Doc View Source

IsOnBike

Declaration
public bool IsOnBike { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsOnFoot

Declaration
public bool IsOnFoot { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsPainAudioEnabled

Declaration
public bool IsPainAudioEnabled { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsPerformingStealthKill

Declaration
public bool IsPerformingStealthKill { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsPlantingBomb

Declaration
public bool IsPlantingBomb { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsPlayer

Declaration
public bool IsPlayer { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsPriorityTargetForEnemies

Declaration
public bool IsPriorityTargetForEnemies { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsProne

Declaration
public bool IsProne { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsRagdoll

Declaration
public bool IsRagdoll { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsReloading

Declaration
public bool IsReloading { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsRunning

Declaration
public bool IsRunning { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsScriptedSpeechPlaying

Declaration
public bool IsScriptedSpeechPlaying { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsShooting

Declaration
public bool IsShooting { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsSprinting

Declaration
public bool IsSprinting { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsStopped

Declaration
public bool IsStopped { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsSwimming

Declaration
public bool IsSwimming { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsSwimmingUnderWater

Declaration
public bool IsSwimmingUnderWater { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsTryingToEnterALockedVehicle

Declaration
public bool IsTryingToEnterALockedVehicle { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsVaulting

Declaration
public bool IsVaulting { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsWalking

Declaration
public bool IsWalking { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsWearingHelmet

Declaration
public bool IsWearingHelmet { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Jacker

Declaration
public Ped Jacker { get; }
Property Value
Type Description
Ped
| Improve this Doc View Source

JackTarget

Declaration
public Ped JackTarget { get; }
Property Value
Type Description
Ped
| Improve this Doc View Source

Killer

Gets the Entity that killed this Ped.

Declaration
public Entity Killer { get; }
Property Value
Type Description
Entity
| Improve this Doc View Source

LastVehicle

Gets the last Vehicle this Ped used.

Declaration
public Vehicle LastVehicle { get; }
Property Value
Type Description
Vehicle
Remarks

returns null if the last vehicle doesn't exist.

| Improve this Doc View Source

LastWeaponImpactPosition

Declaration
public Vector3 LastWeaponImpactPosition { get; }
Property Value
Type Description
Vector3
| Improve this Doc View Source

MaxDrivingSpeed

Sets the maximum driving speed this Ped can drive at.

Declaration
public float MaxDrivingSpeed { set; }
Property Value
Type Description
Single
| Improve this Doc View Source

MaxHealth

Gets or sets the maximum health of this Ped as an Int32.

Declaration
public override int MaxHealth { get; set; }
Property Value
Type Description
Int32

The maximum health as an Int32.
Overrides
| Improve this Doc View Source

MeleeTarget

Declaration
public Ped MeleeTarget { get; }
Property Value
Type Description
Ped
| Improve this Doc View Source

Money

Gets or sets how much money this Ped is carrying.

Declaration
public int Money { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MovementAnimationSet

Sets the animation dictionary or set this Ped should use or null to clear it.

Declaration
public string MovementAnimationSet { set; }
Property Value
Type Description
String
| Improve this Doc View Source

NeverLeavesGroup

Declaration
public bool NeverLeavesGroup { set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

ParachuteLandingType

Declaration
public ParachuteLandingType ParachuteLandingType { get; }
Property Value
Type Description
ParachuteLandingType
| Improve this Doc View Source

ParachuteState

Declaration
public ParachuteState ParachuteState { get; }
Property Value
Type Description
ParachuteState
| Improve this Doc View Source

PedGroup

Gets the PedGroup this Ped is in.

Declaration
public PedGroup PedGroup { get; }
Property Value
Type Description
PedGroup
| Improve this Doc View Source

RelationshipGroup

Declaration
public RelationshipGroup RelationshipGroup { get; set; }
Property Value
Type Description
RelationshipGroup
| Improve this Doc View Source

SeatIndex

Gets the VehicleSeat this Ped is in.

Declaration
public VehicleSeat SeatIndex { get; }
Property Value
Type Description
VehicleSeat

The VehicleSeat this Ped is in if this Ped is in a Vehicle; otherwise, None.
| Improve this Doc View Source

SeeingRange

Declaration
public float SeeingRange { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

ShootRate

Sets the rate this Ped will shoot at.

Declaration
public int ShootRate { set; }
Property Value
Type Description
Int32

The shoot rate from 0.0f to 1000.0f, 100.0f is the default value.
| Improve this Doc View Source

StaysInVehicleWhenJacked

Sets a value indicating whether this Ped will stay in the vehicle when the driver gets jacked.

Declaration
public bool StaysInVehicleWhenJacked { set; }
Property Value
Type Description
Boolean

true if Ped stays in vehicle when jacked; otherwise, false.
| Improve this Doc View Source

Style

Opens a list of clothing and prop configurations that this Ped can wear.

Declaration
public Style Style { get; }
Property Value
Type Description
Style
| Improve this Doc View Source

Sweat

Gets or sets the how much sweat should be rendered on this Ped.

Declaration
public float Sweat { get; set; }
Property Value
Type Description
Single

The sweat from 0 to 100, 0 being no sweat, 100 being saturated.
| Improve this Doc View Source

Task

Opens a list of TaskInvoker that this Ped can carry out.

Declaration
public TaskInvoker Task { get; }
Property Value
Type Description
TaskInvoker
| Improve this Doc View Source

TaskSequenceProgress

Gets the stage of the TaskSequence this Ped is currently executing.

Declaration
public int TaskSequenceProgress { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

TimeOfDeath

Gets the time when this Ped is killed. This value determines how this Ped is rendered when IsThermalVisionActive is true and the Ped is dead.

Declaration
public int TimeOfDeath { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

VehicleDrivingFlags

Declaration
public VehicleDrivingFlags VehicleDrivingFlags { set; }
Property Value
Type Description
VehicleDrivingFlags
| Improve this Doc View Source

VehicleTryingToEnter

Gets the Vehicle this Ped is trying to enter.

Declaration
public Vehicle VehicleTryingToEnter { get; }
Property Value
Type Description
Vehicle
Remarks

returns null if this Ped isn't trying to enter a Vehicle.

| Improve this Doc View Source

VehicleWeapon

Gets the vehicle weapon this Ped is using. The vehicle weapon, returns Invalid if this Ped isnt using a vehicle weapon.

Declaration
public VehicleWeaponHash VehicleWeapon { get; set; }
Property Value
Type Description
VehicleWeaponHash
| Improve this Doc View Source

VisualFieldCenterAngle

Declaration
public float VisualFieldCenterAngle { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

VisualFieldMaxAngle

Declaration
public float VisualFieldMaxAngle { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

VisualFieldMaxElevationAngle

Declaration
public float VisualFieldMaxElevationAngle { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

VisualFieldMinAngle

Declaration
public float VisualFieldMinAngle { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

VisualFieldMinElevationAngle

Declaration
public float VisualFieldMinElevationAngle { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

VisualFieldPeripheralRange

Declaration
public float VisualFieldPeripheralRange { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

Voice

Sets the voice to use when this Ped speaks.

Declaration
public string Voice { set; }
Property Value
Type Description
String
| Improve this Doc View Source

WasKilledByStealth

Gets a value indicating whether this Ped was killed by a stealth attack.

Declaration
public bool WasKilledByStealth { get; }
Property Value
Type Description
Boolean

true if this Ped was killed by stealth; otherwise, false.
| Improve this Doc View Source

WasKilledByTakedown

Gets a value indicating whether this Ped was killed by a takedown.

Declaration
public bool WasKilledByTakedown { get; }
Property Value
Type Description
Boolean

true if this Ped was killed by a takedown; otherwise, false.
| Improve this Doc View Source

Weapons

Gets a collection of all this Peds Weapons.

Declaration
public WeaponCollection Weapons { get; }
Property Value
Type Description
WeaponCollection
| Improve this Doc View Source

WetnessHeight

Sets how high up on this Peds body water should be visible.

Declaration
public float WetnessHeight { set; }
Property Value
Type Description
Single

The height ranges from 0.0f to 1.99f, 0.0f being no water visible, 1.99f being covered in water.

Methods

| Improve this Doc View Source

ApplyDamage(Int32)

Declaration
public void ApplyDamage(int damageAmount)
Parameters
Type Name Description
Int32 damageAmount
| Improve this Doc View Source

CancelRagdoll()

Declaration
public void CancelRagdoll()
| Improve this Doc View Source

ClearBloodDamage()

Declaration
public void ClearBloodDamage()
| Improve this Doc View Source

ClearCauseOfDeathRecord()

Clears the record of the cause of death that killed this Ped with. Can be useful after resurrecting this Ped.

Internally, when a Ped killed and the value for the cause of death in the instance of this Ped is not 0, the game does not write the weapon hash value for the cause of death.

Declaration
public void ClearCauseOfDeathRecord()
| Improve this Doc View Source

ClearKillerRecord()

Clears the Entity record that killed this Ped. Can be useful after resurrecting this Ped.

Internally, when a Ped killed and the value for the source of death in the instance of this Ped is not 0 (not null), the game does not write the memory address of the Ped that killed this Ped.

Declaration
public void ClearKillerRecord()
| Improve this Doc View Source

ClearLastWeaponDamage()

Declaration
public override void ClearLastWeaponDamage()
Overrides
| Improve this Doc View Source

ClearTimeOfDeathRecord()

Clears the time record when this Ped is killed. Can be useful after resurrecting this Ped.

Internally, when a Ped killed and the value for the time of death in the instance of this Ped is not 0, the game does not write the game time value for the time of death.

Declaration
public void ClearTimeOfDeathRecord()
| Improve this Doc View Source

ClearVisibleDamage()

Declaration
public void ClearVisibleDamage()
| Improve this Doc View Source

Clone(Single)

Spawn an identical clone of this Ped.

Declaration
public Ped Clone(float heading = 0F)
Parameters
Type Name Description
Single heading

The direction the clone should be facing.
Returns
Type Description
Ped
| Improve this Doc View Source

Exists()

Determines if this Ped exists. You should ensure Peds still exist before manipulating them or getting some values for them on every tick, since some native functions may crash the game if invalid entity handles are passed.

Declaration
public bool Exists()
Returns
Type Description
Boolean

true if this Ped exists; otherwise, false
See Also
| Improve this Doc View Source

GetAllLoadedModelsAppropriateForAmbientPeds()

Gets an array of all loaded PedHashs that is appropriate to spawn as ambient vehicles. The result array can contains animal hashes, which CREATE_RANDOM_PED excludes to spawn. All the model hashes of the elements are loaded and the Peds with the model hashes can be spawned immediately.

Declaration
public static PedHash[] GetAllLoadedModelsAppropriateForAmbientPeds()
Returns
Type Description
PedHash[]
| Improve this Doc View Source

GetAllModels()

Declaration
public static PedHash[] GetAllModels()
Returns
Type Description
PedHash[]
| Improve this Doc View Source

GetConfigFlag(Int32)

Declaration
public bool GetConfigFlag(int flagID)
Parameters
Type Name Description
Int32 flagID
Returns
Type Description
Boolean
| Improve this Doc View Source

GetRelationshipWithPed(Ped)

Declaration
public Relationship GetRelationshipWithPed(Ped ped)
Parameters
Type Name Description
Ped ped
Returns
Type Description
Relationship
| Improve this Doc View Source

GiveHelmet(Boolean, Helmet, Int32)

Declaration
public void GiveHelmet(bool canBeRemovedByPed, Helmet helmetType, int textureIndex)
Parameters
Type Name Description
Boolean canBeRemovedByPed
Helmet helmetType
Int32 textureIndex
| Improve this Doc View Source

HasBeenDamagedBy(WeaponHash)

Declaration
public override bool HasBeenDamagedBy(WeaponHash weapon)
Parameters
Type Name Description
WeaponHash weapon
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

HasBeenDamagedByAnyMeleeWeapon()

Declaration
public override bool HasBeenDamagedByAnyMeleeWeapon()
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

HasBeenDamagedByAnyWeapon()

Declaration
public override bool HasBeenDamagedByAnyWeapon()
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

IsHeadtracking(Entity)

Declaration
public bool IsHeadtracking(Entity entity)
Parameters
Type Name Description
Entity entity
Returns
Type Description
Boolean
| Improve this Doc View Source

IsInCombatAgainst(Ped)

Declaration
public bool IsInCombatAgainst(Ped target)
Parameters
Type Name Description
Ped target
Returns
Type Description
Boolean
| Improve this Doc View Source

IsInVehicle()

Declaration
public bool IsInVehicle()
Returns
Type Description
Boolean
| Improve this Doc View Source

IsInVehicle(Vehicle)

Declaration
public bool IsInVehicle(Vehicle vehicle)
Parameters
Type Name Description
Vehicle vehicle
Returns
Type Description
Boolean
| Improve this Doc View Source

IsSittingInVehicle()

Declaration
public bool IsSittingInVehicle()
Returns
Type Description
Boolean
| Improve this Doc View Source

IsSittingInVehicle(Vehicle)

Declaration
public bool IsSittingInVehicle(Vehicle vehicle)
Parameters
Type Name Description
Vehicle vehicle
Returns
Type Description
Boolean
| Improve this Doc View Source

Kill()

Kills this Ped immediately.

Declaration
public void Kill()
| Improve this Doc View Source

LeaveGroup()

Declaration
public void LeaveGroup()
| Improve this Doc View Source

OpenParachute()

Declaration
public void OpenParachute()
| Improve this Doc View Source

PlayAmbientSpeech(String, SpeechModifier)

Declaration
public void PlayAmbientSpeech(string speechName, SpeechModifier modifier = SpeechModifier.Standard)
Parameters
Type Name Description
String speechName
SpeechModifier modifier
| Improve this Doc View Source

PlayAmbientSpeech(String, String, SpeechModifier)

Declaration
public void PlayAmbientSpeech(string speechName, string voiceName, SpeechModifier modifier = SpeechModifier.Standard)
Parameters
Type Name Description
String speechName
String voiceName
SpeechModifier modifier
| Improve this Doc View Source

Ragdoll(Int32, RagdollType)

Enables this Ped's ragdoll by starting a ragdoll task and applying to this Ped. If ragdollType is not set to Relax or ScriptControl, the ragdoll behavior for Balance will be used.

Declaration
public void Ragdoll(int duration = -1, RagdollType ragdollType = RagdollType.Relax)
Parameters
Type Name Description
Int32 duration
RagdollType ragdollType
| Improve this Doc View Source

RemoveHelmet(Boolean)

Declaration
public void RemoveHelmet(bool instantly)
Parameters
Type Name Description
Boolean instantly
| Improve this Doc View Source

ResetConfigFlag(Int32)

Declaration
public void ResetConfigFlag(int flagID)
Parameters
Type Name Description
Int32 flagID
| Improve this Doc View Source

Resurrect()

Resurrects this Ped from death.

Declaration
public void Resurrect()
| Improve this Doc View Source

SetConfigFlag(Int32, Boolean)

Declaration
public void SetConfigFlag(int flagID, bool value)
Parameters
Type Name Description
Int32 flagID
Boolean value
| Improve this Doc View Source

SetIntoVehicle(Vehicle, VehicleSeat)

Declaration
public void SetIntoVehicle(Vehicle vehicle, VehicleSeat seat)
Parameters
Type Name Description
Vehicle vehicle
VehicleSeat seat
| Improve this Doc View Source

SetIsPersistentNoClearTask(Boolean)

Sets a value indicating whether this Entity is persistent. Unlike IsPersistent, calling this method does not affect assigned tasks.

Declaration
public void SetIsPersistentNoClearTask(bool value)
Parameters
Type Name Description
Boolean value

Implements