Entity Class

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

Represents an entity in the game world.

Inheritance Hierarchy

SystemObject
  RageEntity
    RageBuilding
    RageCamera
    RageObject
    RagePed
    RageVehicle

Namespace: Rage
Assembly: RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)

Syntax

C++

Copy

[SerializableAttribute]
public abstract class Entity : IHandleable, 
	IAddressable, ISpatial, IRotatable, IDeletable, IPersistable, 
	IRenderable, IVisual

<SerializableAttribute>
Public MustInherit Class Entity
	Implements IHandleable, IAddressable, ISpatial, IRotatable, 
	IDeletable, IPersistable, IRenderable, IVisual

[SerializableAttribute]
public ref class Entity abstract : IHandleable, 
	IAddressable, ISpatial, IRotatable, IDeletable, IPersistable, 
	IRenderable, IVisual

The Entity type exposes the following members.

Properties

	Name	Description
	AbovePosition	Gets a position directly above this Entity.
	AngularVelocity	Gets or sets the rotational velocity of this entity.
	BelowPosition	Gets a position directly below this Entity.
	CanBeDamaged	Gets or sets a value indicating whether this entity can be damaged.
	CollisionIgnoredEntity	Gets or sets the Entity this entity currently ignores collisions from.
	CreatedByTheCallingPlugin	Gets a value indicating whether this instance was created by the calling plugin.
	Direction	Gets or sets the direction of this instance.
	ForwardVector	Gets the forward vector of this instance.
	FrontPosition	Gets a position directly in front of this Entity.
	Handle	Gets the handle of this instance. Used to identify the instance within its pool.
	HasBeenDamagedByAnyObject	Gets or sets a value indicating whether this entity has been damaged by any Object.
	HasBeenDamagedByAnyPed	Gets or sets a value indicating whether this entity has been damaged by any Ped.
	HasBeenDamagedByAnyVehicle	Gets or sets a value indicating whether this entity has been damaged by any Vehicle.
	Heading	Gets or sets the heading of this instance in degrees.
	Health	Gets or sets the health of this instance.
	Height	Gets the height of this 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).
	Invincible	Obsolete. Sets a value indicating whether this instance is invincible.
	IsAlive	Gets a value indicating whether this instance is alive.
	IsBulletProof	Gets or sets a value indicating whether this entity can take damage from bullets.
	IsCollisionEnabled	Gets or sets a value indicating whether collision is enabled for this entity.
	IsCollisionProof	Gets or sets a value indicating whether this entity can take damage from collisions.
	IsDead	Gets a value indicating whether this instance is dead.
	IsExplosionProof	Gets or sets a value indicating whether this entity can take damage from explosions.
	IsFireProof	Gets or sets a value indicating whether this entity can take damage from fire.
	IsGravityDisabled	Gets or sets a value indicating whether gravity is disabled for this entity.
	IsInAir
	IsInvincible	Sets a value indicating whether this instance is invincible.
	IsInWater	Gets a value indicating whether this entity is currently in water. Returns true the moment any part of the entity is touching water.
	IsMeleeProof	Gets or sets a value indicating whether this entity can take damage from melee attacks.
	IsOnFire	Gets or sets a value indicating whether this Entity is on fire.
	IsOnScreen	Gets a value indicating whether this instance is on the screen.
	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.
	IsPositionFrozen	Sets a value indicating whether the position of this entity is frozen.
	IsRecordingCollisions	Gets or sets a value indicating whether this entity is recording collisions.
	IsRendered	Gets a value indicating whether this instance is currently being rendered.
	IsUpsideDown	Gets or sets a value indicating whether this entity is upside down.
	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.
	LeftPosition	Gets a position directly to the left of this Entity.
	Length	Gets the length of this Entity.
	MaxHealth	Gets or sets the maximum health of this instance.
	MemoryAddress	Gets the memory address of this instance.
	Metadata	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.
	Model	Gets or sets the Model of this instance.
	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.
	Orientation	Gets or sets the orientation of this instance.
	Position	Gets or sets the position of this instance.
	Quaternion	Obsolete. Gets or sets the quaternion of this instance.
	RearPosition	Gets a position directly behind this Entity.
	RightPosition	Gets a position directly to the right of this Entity.
	RightVector	Gets the right vector of this instance.
	Rotation	Gets or sets the rotation of this instance.
	Speed	Gets the speed of this Entity in meters per second. This is equivalent of Velocity.Length().
	SubmersionLevel	Gets a value indicating how submersed this entity is.
	UpVector	Gets the up vector of this instance.
	Velocity	Gets or sets the velocity of this entity.
	Width	Gets the width of this Entity.

Top

Methods

	Name	Description
	ApplyForce	Applies force to this instance.
	AttachBlip	Creates a new Blip and attaches it to this instance.
	AttachTo	Attaches Entity to another Entity.
	Delete	Deletes this instance. Any call to a non-existent instance is invalid and will cause an exception.
	Detach	Detaches this Entity from whichever Entity it's currently attached to.
	Dismiss	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.
	DistanceTo(ISpatial)	Gets the distance from this instance to the specified ISpatial instance.
	DistanceTo(Vector3)	Gets the distance from this instance to the specified position.
	DistanceTo2D(ISpatial)	Gets the distance from this instance to the specified ISpatial instance.
	DistanceTo2D(Vector3)	Gets the distance from this instance to the specified position.
	Equals(Entity)	Indicates whether the current instance is equal to another instance of the same type.
	Equals(IHandleable)	Indicates whether the current IHandleable is equal to another IHandleable.
	Face(ISpatial)	Sets the orientation of this instance to face the specified ISpatial.
	Face(Vector3)	Sets the orientation of this instance to face the specified position.
	GetAttachedBlip	Gets the first Blip attached to this instance.
	GetAttachedBlips	Gets all Blips attached to this instance.
	GetBoneAxes(Int32, Vector3, Vector3, Vector3)	Gets the axes of the specified bone. That is, three vectors pointing right, forward and up, relative to the bone's orientation.
	GetBoneAxes(String, Vector3, Vector3, Vector3)	Gets the axes of the specified bone. That is, three vectors pointing right, forward and up, relative to the bone's orientation.
	GetBoneIndex	Gets the index of a bone of this Entity, given the bone's name.
	GetBoneOrientation(Int32)	Gets the orientation of the specified bone.
	GetBoneOrientation(String)	Gets the orientation of the specified bone.
	GetBonePosition(Int32)	Gets the position of the specified bone, in world space.
	GetBonePosition(String)	Gets the position of the specified bone, in world space.
	GetBoneRotation(Int32)	Gets the rotation of the specified bone.
	GetBoneRotation(String)	Gets the rotation of the specified bone.
	GetLastCollision(Vector3)	Gets the last collision of this entity.
	GetLastCollision(Vector3, Vector3)	Gets the last collision of this entity.
	GetLastCollision(Vector3, Vector3, String)	Gets the last collision of this entity.
	GetOffsetPosition	Gets a position offset relative to this instance, based on the instance's position and direction.
	GetOffsetPositionFront	Gets a position that is the specified offset towards the entity's front.
	GetOffsetPositionRight	Gets a position that is the specified offset towards the entity's right.
	GetOffsetPositionUp	Gets a position that is the specified offset towards the entity's top.
	GetPositionOffset	Gets the offset to the specified world position, relative to this Entity. This is essentially the opposite of GetOffsetPosition(Vector3)
	HasBeenDamagedBy	Determines whether this entity has been damaged by the specified entity.
	HasBone(Int32)	Determines whether this Entity has the specified bone.
	HasBone(String)	Determines whether this Entity has the specified bone.
	IsTouching	Determines whether this entity is touching the specified entity.
	IsValid	Determines whether this instance still represents an existing entity within the game world. Calls to an invalid instance is illegal and will result in an exception.
	MakePersistent	Makes this entity persistent.
	SetPositionWithSnap	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.
	SetPositionX	Sets X-component of the Position of this entity.
	SetPositionY	Sets Y-component of the Position of this entity.
	SetPositionZ	Sets Z-component of the Position of this entity.
	SetQuaternionW	Sets W-component of the Quaternion of this entity.
	SetQuaternionX	Sets X-component of the Quaternion of this entity.
	SetQuaternionY	Sets Y-component of the Quaternion of this entity.
	SetQuaternionZ	Sets Z-component of the Quaternion of this entity.
	SetRotationPitch	Sets Pitch-component of the Rotation of this entity.
	SetRotationRoll	Sets Roll-component of the Rotation of this entity.
	SetRotationYaw	Sets Yaw-component of the Rotation of this entity.
	TravelDistanceTo(ISpatial)	Gets the distance from this instance to the specified ISpatial instance, if using the road system.
	TravelDistanceTo(Vector3)	Gets the distance from this instance to the specified position, if using the road system.

Top

Operators

	Name	Description
	Equality
	(Entity to Boolean)
	Inequality

Top

Reference