Building Methods

RAGE Plugin Hook Documentation

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

The Building type exposes the following members.

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