[This is preliminary documentation and is subject to change.]
The Entity type exposes the following members.
Name | Description | |
---|---|---|
AbovePosition |
Gets a position directly above this Entity.
| |
AngularVelocity |
Gets or sets the rotational velocity of this entity.
| |
BelowPosition |
Gets a position directly below this Entity.
| |
CanBeDamaged |
Gets or sets a value indicating whether this entity can be damaged.
| |
CollisionIgnoredEntity |
Gets or sets the Entity this entity currently ignores collisions from.
| |
CreatedByTheCallingPlugin |
Gets a value indicating whether this instance was created by the calling plugin.
| |
Direction |
Gets or sets the direction of this instance.
| |
ForwardVector |
Gets the forward vector of this instance.
| |
FrontPosition |
Gets a position directly in front of this Entity.
| |
Handle |
Gets the handle of this instance. Used to identify the instance within its pool.
| |
HasBeenDamagedByAnyObject |
Gets or sets a value indicating whether this entity has been damaged by any Object.
| |
HasBeenDamagedByAnyPed |
Gets or sets a value indicating whether this entity has been damaged by any Ped.
| |
HasBeenDamagedByAnyVehicle |
Gets or sets a value indicating whether this entity has been damaged by any Vehicle.
| |
Heading |
Gets or sets the heading of this instance in degrees.
| |
Health |
Gets or sets the health of this instance.
| |
Height |
Gets the height of this 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.
| |
IsAlive |
Gets a value indicating whether this instance is alive.
| |
IsBulletProof |
Gets or sets a value indicating whether this entity can take damage from bullets.
| |
IsCollisionEnabled |
Gets or sets a value indicating whether collision is enabled for this entity.
| |
IsCollisionProof |
Gets or sets a value indicating whether this entity can take damage from collisions.
| |
IsDead |
Gets a value indicating whether this instance is dead.
| |
IsExplosionProof |
Gets or sets a value indicating whether this entity can take damage from explosions.
| |
IsFireProof |
Gets or sets a value indicating whether this entity can take damage from fire.
| |
IsGravityDisabled |
Gets or sets a value indicating whether gravity is disabled for this entity.
| |
IsInAir | ||
IsInvincible |
Sets a value indicating whether this instance is invincible.
| |
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.
| |
IsOnFire |
Gets or sets a value indicating whether this Entity is on fire.
| |
IsOnScreen |
Gets a value indicating whether this instance is on the screen.
| |
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.
| |
IsPositionFrozen |
Sets a value indicating whether the position of this entity is frozen.
| |
IsRecordingCollisions |
Gets or sets a value indicating whether this entity is recording collisions.
| |
IsRendered |
Gets a value indicating whether this instance is currently being rendered.
| |
IsUpsideDown |
Gets or sets a value indicating whether this entity is upside down.
| |
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.
| |
Length |
Gets the length of this Entity.
| |
MaxHealth |
Gets or sets the maximum health of this instance.
| |
MemoryAddress |
Gets the memory address of this instance.
| |
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.
| |
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.
| |
Orientation |
Gets or sets the orientation of this instance.
| |
Position |
Gets or sets the position of this instance.
| |
Quaternion | Obsolete.
Gets or sets the quaternion of this instance.
| |
RearPosition |
Gets a position directly behind this Entity.
| |
RightPosition |
Gets a position directly to the right of this Entity.
| |
RightVector |
Gets the right vector of this instance.
| |
Rotation |
Gets or sets the rotation of this instance.
| |
Speed | ||
SubmersionLevel |
Gets a value indicating how submersed this entity is.
| |
UpVector |
Gets the up vector of this instance.
| |
Velocity |
Gets or sets the velocity of this entity.
| |
Width |
Gets the width of this Entity.
|