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