Object Class

RAGE Plugin Hook Documentation

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

Represents an object in the game world.

Inheritance Hierarchy

SystemObject
  RageEntity
    RageObject
      RageWeapon

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

Syntax

C++

Copy

[SerializableAttribute]
public class Object : Entity

<SerializableAttribute>
Public Class Object
	Inherits Entity

[SerializableAttribute]
public ref class Object : public Entity

The Object type exposes the following members.

Constructors

	Name	Description
	Object(PoolHandle)	Initializes a new instance of the Object class.
	Object(Model, Vector3)	Initializes a new instance of the Object class.
	Object(Model, Vector3, Single)	Initializes a new instance of the Object class.

Top

Properties

	Name	Description
	AbovePosition	Gets a position directly above this Entity. (Inherited from Entity.)
	AngularVelocity	Gets or sets the rotational velocity of this entity. (Inherited from Entity.)
	BelowPosition	Gets a position directly below this Entity. (Inherited from Entity.)
	CanBeDamaged	Gets or sets a value indicating whether this entity can be damaged. (Inherited from Entity.)
	CollisionIgnoredEntity	Gets or sets the Entity this entity currently ignores collisions from. (Inherited from Entity.)
	CreatedByTheCallingPlugin	Gets a value indicating whether this instance was created by the calling plugin. (Inherited from Entity.)
	Direction	Gets or sets the direction of this instance. (Inherited from Entity.)
	ForwardVector	Gets the forward vector of this instance. (Inherited from Entity.)
	FrontPosition	Gets a position directly in front of this Entity. (Inherited from Entity.)
	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.)
	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). (Inherited from Entity.)
	Invincible	Obsolete. Sets a value indicating whether this instance is invincible. (Inherited from Entity.)
	IsAlive	Gets a value indicating whether this instance is alive. (Inherited from Entity.)
	IsBulletProof	Gets or sets a value indicating whether this entity can take damage from bullets. (Inherited from Entity.)
	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.)
	IsDead	Gets a value indicating whether this instance is dead. (Inherited from Entity.)
	IsExplosionProof	Gets or sets a value indicating whether this entity can take damage from explosions. (Inherited from Entity.)
	IsFireProof	Gets or sets a value indicating whether this entity can take damage from fire. (Inherited from Entity.)
	IsGravityDisabled	Gets or sets a value indicating whether gravity is disabled for this entity. (Inherited from Entity.)
	IsInAir	(Inherited from Entity.)
	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. (Inherited from Entity.)
	IsMeleeProof	Gets or sets a value indicating whether this entity can take damage from melee attacks. (Inherited from Entity.)
	IsOnFire	Gets or sets a value indicating whether this Entity is on fire. (Inherited from Entity.)
	IsOnScreen	Gets a value indicating whether this instance is on the screen. (Inherited from Entity.)
	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.)
	IsPositionFrozen	Sets a value indicating whether the position of this entity is frozen. (Inherited from Entity.)
	IsRecordingCollisions	Gets or sets a value indicating whether this entity is recording collisions. (Inherited from Entity.)
	IsRendered	Gets a value indicating whether this instance is currently being rendered. (Inherited from Entity.)
	IsUpsideDown	Gets or sets a value indicating whether this entity is upside down. (Inherited from Entity.)
	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. (Inherited from Entity.)
	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.)
	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. 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. (Inherited from Entity.)
	Model	Gets or sets the Model of this instance. (Inherited from Entity.)
	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. (Inherited from Entity.)
	Opacity	Gets or sets the opacity of this instance. (Inherited from Entity.)
	Orientation	Gets or sets the orientation of this instance. (Inherited from Entity.)
	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.)
	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.)
	Speed	Gets the speed of this Entity in meters per second. This is equivalent of Velocity.Length(). (Inherited from Entity.)
	SubmersionLevel	Gets a value indicating how submersed this entity is. (Inherited from Entity.)
	UpVector	Gets the up vector of this instance. (Inherited from Entity.)
	Velocity	Gets or sets the velocity of this entity. (Inherited from Entity.)
	Width	Gets the width of this Entity. (Inherited from Entity.)

Top

Methods

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

Top

Reference

Rage Namespace