Building ClassRAGE Plugin Hook Documentation

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

Represents a building in the game world.
Inheritance Hierarchy

SystemObject
  RageEntity
    RageBuilding

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

[SerializableAttribute]
public sealed class Building : Entity

The Building type exposes the following members.

Properties

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

(Inherited from Entity.)
Public propertyInvincible Obsolete.
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.)
Public propertyIsAlive
Gets a value indicating whether this instance is alive.
(Inherited from Entity.)
Public propertyIsBulletProof
Gets or sets a value indicating whether this entity can take damage from bullets.
(Inherited from Entity.)
Public propertyIsCollisionEnabled
Gets or sets a value indicating whether collision is enabled for this entity.
(Inherited from Entity.)
Public propertyIsCollisionProof
Gets or sets a value indicating whether this entity can take damage from collisions.
(Inherited from Entity.)
Public propertyIsDead
Gets a value indicating whether this instance is dead.
(Inherited from Entity.)
Public propertyIsExplosionProof
Gets or sets a value indicating whether this entity can take damage from explosions.
(Inherited from Entity.)
Public propertyIsFireProof
Gets or sets a value indicating whether this entity can take damage from fire.
(Inherited from Entity.)
Public propertyIsGravityDisabled
Gets or sets a value indicating whether gravity is disabled for this entity.
(Inherited from Entity.)
Public propertyIsInAir (Inherited from Entity.)
Public propertyIsInvincible
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.)
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.

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

(Inherited from Entity.)
Public propertyLeftPosition
Gets a position directly to the left of this Entity.
(Inherited from Entity.)
Public propertyLength
Gets the length of this Entity.
(Inherited from Entity.)
Public propertyMaxHealth
Gets or sets the maximum health of this instance.
(Inherited from Entity.)
Public propertyMemoryAddress
Gets the memory address of this instance.
(Inherited from Entity.)
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.

(Inherited from Entity.)
Public propertyModel
Gets or sets the Model of this instance.
(Inherited from Entity.)
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.

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

Gets the speed of this Entity in meters per second.

This is equivalent of Velocity.Length().

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

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

Deletes this instance.

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

(Inherited from Entity.)
Public methodDetach
Detaches this Entity from whichever Entity it's currently attached to.
(Inherited from Entity.)
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.

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

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

This is essentially the opposite of GetOffsetPosition(Vector3)

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

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

Reference