[This is preliminary documentation and is subject to change.]
The Object type exposes the following members.
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). |
| 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. |
| 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. |
| 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. |
| 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. |
| 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 | (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.) |
See Also