[This is preliminary documentation and is subject to change.]
The Object type exposes the following members.
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 | (Inherited from Entity.) |
| Delete | Deletes this instance. Any call to a non-existent instance is invalid and will cause an exception. |
| Detach | (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. |
| 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) |
| 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. |
| 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.) |
See Also