Entity ClassRAGE 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.47.1037.9935)
Syntax

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

The Entity type exposes the following members.

Properties

  NameDescription
Public propertyAbovePosition
Gets a position directly above this Entity.
Public propertyAngularVelocity
Gets or sets the rotational velocity of this entity.
Public propertyBelowPosition
Gets a position directly below this Entity.
Public propertyCanBeDamaged
Gets or sets a value indicating whether this entity can be damaged.
Public propertyCollisionIgnoredEntity
Gets or sets the Entity this entity currently ignores collisions from.
Public propertyCreatedByTheCallingPlugin
Gets a value indicating whether this instance was created by the calling plugin.
Public propertyDirection
Gets or sets the direction of this instance.
Public propertyForwardVector
Gets the forward vector of this instance.
Public propertyFrontPosition
Gets a position directly in front of this Entity.
Public propertyHandle
Gets the handle of this instance. Used to identify the instance within its pool.
Public propertyHasBeenDamagedByAnyObject
Gets or sets a value indicating whether this entity has been damaged by any Object.
Public propertyHasBeenDamagedByAnyPed
Gets or sets a value indicating whether this entity has been damaged by any Ped.
Public propertyHasBeenDamagedByAnyVehicle
Gets or sets a value indicating whether this entity has been damaged by any Vehicle.
Public propertyHeading
Gets or sets the heading of this instance in degrees.
Public propertyHealth
Gets or sets the health of this instance.
Public propertyHeight
Gets the height of this Entity.
Public propertyHeightAboveGround

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

Public propertyInvincible Obsolete.
Sets a value indicating whether this instance is invincible.
Public propertyIsAlive
Gets a value indicating whether this instance is alive.
Public propertyIsBulletProof
Gets or sets a value indicating whether this entity can take damage from bullets.
Public propertyIsCollisionEnabled
Gets or sets a value indicating whether collision is enabled for this entity.
Public propertyIsCollisionProof
Gets or sets a value indicating whether this entity can take damage from collisions.
Public propertyIsDead
Gets a value indicating whether this instance is dead.
Public propertyIsExplosionProof
Gets or sets a value indicating whether this entity can take damage from explosions.
Public propertyIsFireProof
Gets or sets a value indicating whether this entity can take damage from fire.
Public propertyIsGravityDisabled
Gets or sets a value indicating whether gravity is disabled for this entity.
Public propertyIsInAir
Public propertyIsInvincible
Sets a value indicating whether this instance is invincible.
Public propertyIsInWater

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

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

Public propertyIsMeleeProof
Gets or sets a value indicating whether this entity can take damage from melee attacks.
Public propertyIsOnFire
Gets or sets a value indicating whether this Entity is on fire.
Public propertyIsOnScreen
Gets a value indicating whether this instance is on the screen.
Public propertyIsPersistent
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.
Public propertyIsPositionFrozen
Sets a value indicating whether the position of this entity is frozen.
Public propertyIsRecordingCollisions
Gets or sets a value indicating whether this entity is recording collisions.
Public propertyIsRendered
Gets a value indicating whether this instance is currently being rendered.
Public propertyIsUpsideDown
Gets or sets a value indicating whether this entity is upside down.
Public propertyIsVisible

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.

Public propertyLeftPosition
Gets a position directly to the left of this Entity.
Public propertyLength
Gets the length of this Entity.
Public propertyMaxHealth
Gets or sets the maximum health of this instance.
Public propertyMemoryAddress
Gets the memory address of this instance.
Public propertyCode exampleMetadata

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.

Public propertyModel
Gets or sets the Model of this instance.
Public propertyNeedsCollision

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.

Public propertyOpacity
Gets or sets the opacity of this instance.
Public propertyOrientation
Gets or sets the orientation of this instance.
Public propertyPosition
Gets or sets the position of this instance.
Public propertyQuaternion Obsolete.
Gets or sets the quaternion of this instance.
Public propertyRearPosition
Gets a position directly behind this Entity.
Public propertyRightPosition
Gets a position directly to the right of this Entity.
Public propertyRightVector
Gets the right vector of this instance.
Public propertyRotation
Gets or sets the rotation of this instance.
Public propertySpeed

Gets the speed of this Entity in meters per second.

This is equivalent of Velocity.Length().

Public propertySubmersionLevel
Gets a value indicating how submersed this entity is.
Public propertyUpVector
Gets the up vector of this instance.
Public propertyVelocity
Gets or sets the velocity of this entity.
Public propertyWidth
Gets the width of this Entity.
Top
Methods

  NameDescription
Public methodApplyForce
Applies force to this instance.
Public methodAttachBlip
Creates a new Blip and attaches it to this instance.
Public methodAttachTo
Attaches Entity to another Entity.
Public methodDelete

Deletes this instance.

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

Public methodDetach
Detaches this Entity from whichever Entity it's currently attached to.
Public methodDismiss

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.

Public methodDistanceTo(ISpatial)
Gets the distance from this instance to the specified ISpatial instance.
Public methodDistanceTo(Vector3)
Gets the distance from this instance to the specified position.
Public methodDistanceTo2D(ISpatial)
Gets the distance from this instance to the specified ISpatial instance.
Public methodDistanceTo2D(Vector3)
Gets the distance from this instance to the specified position.
Public methodEquals(Entity)
Indicates whether the current instance is equal to another instance of the same type.
Public methodEquals(IHandleable)
Indicates whether the current IHandleable is equal to another IHandleable.
Public methodFace(ISpatial)
Sets the orientation of this instance to face the specified ISpatial.
Public methodFace(Vector3)
Sets the orientation of this instance to face the specified position.
Public methodGetAttachedBlip
Gets the first Blip attached to this instance.
Public methodGetAttachedBlips
Gets all Blips attached to this instance.
Public methodGetBoneAxes(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.
Public methodGetBoneAxes(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.
Public methodGetBoneIndex
Gets the index of a bone of this Entity, given the bone's name.
Public methodGetBoneOrientation(Int32)
Gets the orientation of the specified bone.
Public methodGetBoneOrientation(String)
Gets the orientation of the specified bone.
Public methodGetBonePosition(Int32)
Gets the position of the specified bone, in world space.
Public methodGetBonePosition(String)
Gets the position of the specified bone, in world space.
Public methodGetBoneRotation(Int32)
Gets the rotation of the specified bone.
Public methodGetBoneRotation(String)
Gets the rotation of the specified bone.
Public methodGetLastCollision(Vector3)
Gets the last collision of this entity.
Public methodGetLastCollision(Vector3, Vector3)
Gets the last collision of this entity.
Public methodGetLastCollision(Vector3, Vector3, String)
Gets the last collision of this entity.
Public methodCode exampleGetOffsetPosition
Gets a position offset relative to this instance, based on the instance's position and direction.
Public methodGetOffsetPositionFront
Gets a position that is the specified offset towards the entity's front.
Public methodGetOffsetPositionRight
Gets a position that is the specified offset towards the entity's right.
Public methodGetOffsetPositionUp
Gets a position that is the specified offset towards the entity's top.
Public methodGetPositionOffset

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

This is essentially the opposite of GetOffsetPosition(Vector3)

Public methodHasBeenDamagedBy
Determines whether this entity has been damaged by the specified entity.
Public methodHasBone(Int32)
Determines whether this Entity has the specified bone.
Public methodHasBone(String)
Determines whether this Entity has the specified bone.
Public methodIsTouching
Determines whether this entity is touching the specified entity.
Public methodIsValid
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.
Public methodMakePersistent
Makes this entity persistent.
Public methodSetPositionWithSnap

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.

Public methodSetPositionX
Sets X-component of the Position of this entity.
Public methodSetPositionY
Sets Y-component of the Position of this entity.
Public methodSetPositionZ
Sets Z-component of the Position of this entity.
Public methodSetQuaternionW
Sets W-component of the Quaternion of this entity.
Public methodSetQuaternionX
Sets X-component of the Quaternion of this entity.
Public methodSetQuaternionY
Sets Y-component of the Quaternion of this entity.
Public methodSetQuaternionZ
Sets Z-component of the Quaternion of this entity.
Public methodSetRotationPitch
Sets Pitch-component of the Rotation of this entity.
Public methodSetRotationRoll
Sets Roll-component of the Rotation of this entity.
Public methodSetRotationYaw
Sets Yaw-component of the Rotation of this entity.
Public methodTravelDistanceTo(ISpatial)
Gets the distance from this instance to the specified ISpatial instance, if using the road system.
Public methodTravelDistanceTo(Vector3)
Gets the distance from this instance to the specified position, if using the road system.
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Public operatorStatic member(Entity to Boolean)
Public operatorStatic memberInequality
Top
See Also

Reference