[This is preliminary documentation and is subject to change.]
The Ped type exposes the following members.
Name | Description | |
---|---|---|
AbovePosition |
Gets a position directly above this Entity.
(Inherited from Entity.) | |
Accuracy |
Gets or sets a value indicating how well this instance aims.
| |
Alertness | ||
AngularVelocity |
Gets or sets the rotational velocity of this entity.
(Inherited from Entity.) | |
Armor | ||
BelowPosition |
Gets a position directly below this Entity.
(Inherited from Entity.) | |
BlockPermanentEvents | ||
CanAttackFriendlies | ||
CanBeDamaged |
Gets or sets a value indicating whether this entity can be damaged.
(Inherited from Entity.) | |
CanBeKnockedOffBikes | ||
CanBePulledOutOfVehicles | ||
CanBeShotInVehicles |
Sets a value indicating whether this Ped is able to take damage from gun fire while in a vehicle.
| |
CanBeTargetted |
Sets a value indicating whether this Ped can be targetted by players.
| |
CanDrownInVehicles |
Sets a value indicating whether this Ped is able to drown while in a vehicle. The value of this property has no influence on CanDrownOutsideVehicles.
| |
CanDrownOutsideVehicles |
Sets a value indicating whether this Ped is able to drown while in water, outside a vehicle. The value of this property has no influence on CanDrownInVehicles.
| |
CanFlyThroughWindshields | ||
CanOnlyBeDamagedByPlayer |
Gets a value indicating whether this instance can only be damaged by a player.
| |
CanPlayAmbientAnimations | ||
CanPlayGestureAnimations | ||
CanPlayVisemeAnimations | ||
CanRagdoll |
Gets or sets a value indicating whether this Ped can ragdoll.
| |
CollisionIgnoredEntity |
Gets or sets the Entity this entity currently ignores collisions from.
(Inherited from Entity.) | |
CombatTarget | ||
CreatedByTheCallingPlugin |
Gets a value indicating whether this instance was created by the calling plugin.
(Inherited from Entity.) | |
CurrentVehicle | ||
DecisionMaker | ||
DiesInstantlyInWater | ||
Direction |
Gets or sets the direction of this instance.
(Inherited from Entity.) | |
DropsCurrentWeaponOnDeath | ||
FatalInjuryHealthThreshold |
Gets or sets the fatal injury health threshold for this ped. A ped is considered dead when its health drops below this value.
| |
FiringPattern |
Sets the firing pattern used by this Ped in fire fights.
| |
ForwardVector |
Gets the forward vector of this instance.
(Inherited from Entity.) | |
FrontPosition |
Gets a position directly in front of this Entity.
(Inherited from Entity.) | |
Group |
Gets the group this Ped is currently in.
| |
Handle |
Gets the handle of this instance. Used to identify the instance within its pool.
(Inherited from Entity.) | |
HasBeenDamagedByAnyObject |
Gets or sets a value indicating whether this entity has been damaged by any Object.
(Inherited from Entity.) | |
HasBeenDamagedByAnyPed |
Gets or sets a value indicating whether this entity has been damaged by any Ped.
(Inherited from Entity.) | |
HasBeenDamagedByAnyVehicle |
Gets or sets a value indicating whether this entity has been damaged by any Vehicle.
(Inherited from Entity.) | |
Heading |
Gets or sets the heading of this instance in degrees.
(Inherited from Entity.) | |
Health |
Gets or sets the health of this instance.
(Inherited from Entity.) | |
HearingRange | ||
Height |
Gets the height of this Entity.
(Inherited from Entity.) | |
HeightAboveGround | Gets this entity's distance from the ground in 1D on the Z-axis. The distance is measured from the entity's origin to the surface below the entity (Surfaces include roofs of buildings). | |
InjuryHealthThreshold |
Gets or sets the injury health threshold for this ped. A ped is considered injured when its health drops below this value.
| |
Inventory | ||
Invincible | Obsolete.
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.) | |
IsAiming |
Gets a value indicating whether this Ped is aiming.
| |
IsAimingFromCover |
Gets a value indicating whether this Ped is aiming from cover.
| |
IsAlive |
Gets a value indicating whether this instance is alive.
(Inherited from Entity.) | |
IsAnySpeechPlaying | ||
IsArmIkEnabled | ||
IsBailingOutOfVehicle |
Gets a value indicating whether this Ped is bailing out of a vehicle.
| |
IsBeingJacked | ||
IsBeingStealthKilled |
Gets a value indicating whether this Ped is currently being stealth killed.
| |
IsBulletProof |
Gets or sets a value indicating whether this entity can take damage from bullets.
(Inherited from Entity.) | |
IsClimbing | ||
IsCollisionEnabled |
Gets or sets a value indicating whether collision is enabled for this entity.
(Inherited from Entity.) | |
IsCollisionProof |
Gets or sets a value indicating whether this entity can take damage from collisions.
(Inherited from Entity.) | |
IsCuffed | ||
IsCurrentWeaponSilenced | ||
IsDead |
Gets a value indicating whether this instance is dead.
(Inherited from Entity.) | |
IsDiving |
Gets a value indicating whether this Ped is currently diving.
| |
IsDoingDriveby |
Gets a value indicating whether this Ped is aiming from a vehicle.
| |
IsExplosionProof |
Gets or sets a value indicating whether this entity can take damage from explosions.
(Inherited from Entity.) | |
IsFalling |
Gets a value indicating whether this Ped is currently falling.
| |
IsFatallyInjured | Obsolete.
Gets a value indicating whether this ped's health is below its fatally injured threshold.
| |
IsFemale |
Gets a value indicating whether this Ped is a female.
| |
IsFireProof |
Gets or sets a value indicating whether this entity can take damage from fire.
(Inherited from Entity.) | |
IsFleeing |
Gets a value indicating whether this Ped is currently fleeing.
| |
IsGettingIntoVehicle | Gets a value indicating whether this instance is getting into a vehicle. | |
IsGettingUp |
Gets a value indicating whether this Ped is getting up.
| |
IsGoingIntoCover | Gets a value indicating whether this Ped is currently going into cover. | |
IsGravityDisabled |
Gets or sets a value indicating whether gravity is disabled for this entity.
(Inherited from Entity.) | |
IsHangingOnToVehicle | ||
IsHeadIkEnabled | ||
IsHuman |
Gets a value indicating whether this Ped is a human.
| |
IsInAir | (Inherited from Entity.) | |
IsInAirVehicle |
Gets a value indicating whether this Ped is in an air vehicle.
| |
IsInAnyPoliceVehicle |
Gets a value indicating whether this Ped is in a police vehicle.
| |
IsInBoat |
Gets a value indicating whether this Ped is in a boat.
| |
IsInCombat | ||
IsInCover | ||
IsInCoverFacingLeft | ||
IsInCoverFacingRight | ||
IsInHelicopter |
Gets a value indicating whether this Ped is in a helicopter.
| |
IsInjured |
Gets a value indicating whether this ped's health is below its injured threshold.
| |
IsInMeleeCombat | ||
IsInParachuteFreeFall |
Gets a value indicating whether this Ped is in a parachute free fall.
| |
IsInPlane |
Gets a value indicating whether this Ped is in a plane.
| |
IsInSeaVehicle |
Gets a value indicating whether this Ped is in a vehicle operating on or under water.
| |
IsInStealthMode | ||
IsInSubmersible |
Gets a value indicating whether this Ped is in a submersible.
| |
IsInTaxi |
Gets a value indicating whether this Ped is in a taxi, passenger or otherwise.
| |
IsInvincible |
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.) | |
IsInWater | Gets a value indicating whether this entity is currently in water. Returns true the moment any part of the entity is touching water. | |
IsInWrithe | ||
IsJacking | ||
IsJumping |
Gets a value indicating whether this Ped is currently jumping.
| |
IsLegIkEnabled | ||
IsLocalPlayer |
Gets a value indicating whether this instance is the local player's current Ped.
| |
IsMale |
Gets a value indicating whether this Ped is a male.
| |
IsMeleeProof |
Gets or sets a value indicating whether this entity can take damage from melee attacks.
(Inherited from Entity.) | |
IsOnBike |
Gets a value indicating whether this Ped is on a bike.
| |
IsOnFire |
Gets or sets a value indicating whether this Entity is on fire.
(Inherited from Entity.) | |
IsOnFoot |
Gets a value indicating whether this Ped is on foot.
| |
IsOnScreen |
Gets a value indicating whether this instance is on the screen.
(Inherited from Entity.) | |
IsPainAudioEnabled |
Sets a value indicating whether pain audio is enabled for this instance.
| |
IsPassenger |
Gets a value indicating whether this Ped is currently on a non-driver seat in a vehicle.
| |
IsPerformingStealthKill |
Gets a value indicating whether this Ped is currently performing a stealth kill.
| |
IsPersistent |
Gets or sets a value indicating whether this instance is persistent within the game world. Persistent instances will not be removed automatically during clean ups.
(Inherited from Entity.) | |
IsPlantingBomb |
Gets a value indicating whether this Ped is currently planting a bomb.
| |
IsPlayer |
Gets a value indicating whether this instance is the any player's current Ped.
| |
IsPositionFrozen |
Sets a value indicating whether the position of this entity is frozen.
(Inherited from Entity.) | |
IsRagdoll |
Gets or sets a value indicating whether this Ped is currently ragdolled.
| |
IsRecordingCollisions |
Gets or sets a value indicating whether this entity is recording collisions.
(Inherited from Entity.) | |
IsReloading |
Gets a value indicating whether this Ped is reloading.
| |
IsRendered |
Gets a value indicating whether this instance is currently being rendered.
(Inherited from Entity.) | |
IsRingtonePlaying | ||
IsRunning |
Gets a value indicating whether this Ped is running.
| |
IsShooting |
Gets a value indicating whether this instance is currently firing a weapon.
| |
IsSprinting |
Gets a value indicating whether this Ped is sprinting.
| |
IsStill |
Gets a value indicating whether this Ped is not moving.
| |
IsStopped |
Gets a value indicating whether this instance is currently standing still.
| |
IsStunned | ||
IsSwimming |
Gets a value indicating whether this Ped is currently swimming.
| |
IsTorsoIkEnabled | ||
IsUpsideDown |
Gets or sets a value indicating whether this entity is upside down.
(Inherited from Entity.) | |
IsVaulting |
Gets a value indicating whether this Ped is vaulting over an obstacle.
| |
IsVisible | Gets or sets a value indicating whether this instance is currently visible within the game world. Invisible instances will still be processed but will not be rendered. | |
IsWalking |
Gets a value indicating whether this Ped is walking.
| |
IsWeaponReadyToShoot | ||
IsWearingHelmet |
Gets a value indicating whether this Ped is currently wearing a helmet.
| |
Jacker | ||
JackingTarget | ||
KeepTasks | Sets whether this Ped will keep tasks assigned. | |
LastDamageBone | ||
LastEuphoriaMessageName |
Gets the name of the Euphoria message that was last dispatched to this Ped.
| |
LastVehicle |
Gets the last Vehicle this ped was in.
| |
LeftPosition |
Gets a position directly to the left of this Entity.
(Inherited from Entity.) | |
Length |
Gets the length of this Entity.
(Inherited from Entity.) | |
MaxHealth |
Gets or sets the maximum health of this instance.
(Inherited from Entity.) | |
MeleeTarget | ||
MemoryAddress |
Gets the memory address of this instance.
(Inherited from Entity.) | |
Metadata | Gets the metadata associated with this instance.
The value of this property can be used to store data about this instance. | |
MinimumGroundTimeForStungun | ||
Model |
Gets or sets the Model of this instance.
(Inherited from Entity.) | |
Money | ||
MovementAnimationSet |
Gets or sets the AnimationSet used by this Ped for movement.
| |
NeedsCollision | Gets a value indicating whether this instance needs collision. Entities not marked explicitly to need collision will still get collision, however, if other entities need collision, entities not marked as needing collision may lose it in favor of those. | |
Opacity |
Gets or sets the opacity of this instance.
(Inherited from Entity.) | |
Orientation |
Gets or sets the orientation of this instance.
(Inherited from Entity.) | |
ParachuteLandingType |
Gets the parachute landing type of this Ped.
| |
ParachuteState |
Gets the parachute state of this Ped.
| |
Position |
Gets or sets the position of this instance.
(Inherited from Entity.) | |
Quaternion | Obsolete.
Gets or sets the quaternion of this instance.
(Inherited from Entity.) | |
RearPosition |
Gets a position directly behind this Entity.
(Inherited from Entity.) | |
RelationshipGroup | Gets or sets the relationship group of this instance. Relationship groups indicate the acquaintance between different types of Peds. For instance, by default CIVMALE and CIVFEMALE are set to respect each other; however, this behaviour can be changed. CIVMALE could be set to hate CIVFEMALE, and CIVFEMALE could be set to hate CIVMALE, and all civilians would start fighting each other on side, males vs females. (Granted that they're in those respective groups, as males could certainly be added to the CIVFEMALE group. Groups can also have different acquaintances between each other. For instance, imagine three new groups: DEVELOPER, CUSTOMER and PIRATE, where Peds in the DEVELOPER relationship group hate Peds in the PIRATE group and like (not respect) Peds in the CUSTOMER group. Peds in the PIRATE group like the Peds in the DEVELOPER group, and are neutral towards people in the CUSTOMER group. Peds in the CUSTOMER group like Peds in the DEVELOPER group and dislike Peds in the PIRATE group. Any Ped in the DEVELOPER group will attack Peds in the PIRATE group on sight, but Peds in the PIRATE group won't attack Peds in the DEVELOPER group because they like them. | |
RightPosition |
Gets a position directly to the right of this Entity.
(Inherited from Entity.) | |
RightVector |
Gets the right vector of this instance.
(Inherited from Entity.) | |
Rotation |
Gets or sets the rotation of this instance.
(Inherited from Entity.) | |
SeatIndex |
Gets the index of the seat this Ped is currently on.
| |
SeatIndexTryingToEnter |
Gets the index of the seat this Ped is currently trying to enter.
| |
Speed | (Inherited from Entity.) | |
StaysInGroups | ||
StaysInVehiclesWhenJacked | ||
SubmersionLevel |
Gets a value indicating how submersed this entity is.
(Inherited from Entity.) | |
Tasks | ||
UpVector |
Gets the up vector of this instance.
(Inherited from Entity.) | |
VehicleTryingToEnter | ||
Velocity |
Gets or sets the velocity of this entity.
(Inherited from Entity.) | |
VisionRange | ||
VisualFieldMaximumHorizontalAngle | ||
VisualFieldMaximumVerticalAngle | ||
VisualFieldMinimumHorizontalAngle | ||
VisualFieldMinimumVerticalAngle | ||
Voice |
Sets the voice of this Ped.
| |
Width |
Gets the width of this Entity.
(Inherited from Entity.) | |
WillGetOutOfUpsideDownVehiclesAutomatically |