Ped Class

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.

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).

Gets a value indicating whether this Ped is currently climbing.

A Ped is considered climbing if performing one of the following actions.

• Climbing up.
• Vaulting.
• Stepping up.
• Stepping over.
• Climbing a ladder.

Gets a value indicating whether this instance is getting into a vehicle.

Gets a value indicating whether this Ped is currently going into cover.

Gets a value indicating whether this Ped is currently in cover.

A Ped is considered in cover if it has fully entered the cover state. It is not in cover while moving into cover.

Gets a value indicating whether this Ped is currently in cover and facing left.

A Ped is considered in cover if it has fully entered the cover state. It is not in cover while moving into cover.

Gets a value indicating whether this Ped is currently in cover and facing right.

A Ped is considered in cover if it has fully entered the cover state. It is not in cover while moving into cover.

Gets a value indicating whether this entity is currently in water.

Returns true the moment any part of the entity is touching water.

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.

Sets whether this Ped will keep tasks assigned.

Gets the metadata associated with this instance.

The value of this property can be used to store data about this instance.
Getting or setting metadata is done using the same syntax as getting or setting a property.
Internally the value is added to a dictionary with the specified property name as key.

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.

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.

Gets the speed of this Entity in meters per second.

This is equivalent of Velocity.Length().

Sets a value indicating whether this Ped will stay in its group unless explicitly removed.

If the value of this property is false, this Ped will be removed from its group if it gets farther away from its leader than the Group's [!:Rage::Group::DissolveDistance].

Deletes this instance.

Any call to a non-existent instance is invalid and will cause an exception.

If this instance is marked as persistent, makes the entity non-persistent. Non-persistent entities will be deleted from the game world during clean ups.

This is equivalent to setting IsPersistent to false.

Gets the offset to the specified world position, relative to this Entity.

This is essentially the opposite of GetOffsetPosition(Vector3)

Plays the specified ambient speech.

Sets the position of this Entity to the specified value.

Unlike Position, if the specified position is in the ground, the position will be adjusted to place the entity above it.