Difference between revisions of "Oolite JavaScript Reference: Entity"
m (→scanClass: added link, reworded, uniform string format) |
m (→status: reworded, uniform string format) |
||
Line 114: | Line 114: | ||
=== <code>status</code> === | === <code>status</code> === | ||
'''status''' : String (read-only) | '''status''' : String (read-only) | ||
− | The current status | + | The entity's current status. Possible values (though not an exhaustive list): |
− | * | + | * <code>"STATUS_DOCKED"</code> |
− | * | + | * <code>"STATUS_IN_FLIGHT"</code> |
− | * | + | * <code>"STATUS_WITCHSPACE_COUNTDOWN"</code> |
− | * | + | * <code>"STATUS_EXITING_WITCHSPACE"</code> |
− | * | + | * <code>"STATUS_BEING_SCOOPED"</code> |
[[Category:Oolite JavaScript Reference]] | [[Category:Oolite JavaScript Reference]] |
Revision as of 22:52, 6 October 2022
Prototype: Object
Subtypes: Planet
, Ship
, Sun
The Entity
class represents an object in the game universe. Ship
s, Station
s, Planet
s and Sun
s are types of entity. Note that these more specific types have additional properties and methods.
Contents
- 1 Stale References
- 2 Properties
- 2.1 collisionRadius
- 2.2 distanceTravelled
- 2.3 energy
- 2.4 heading
- 2.5 isDock
- 2.6 isInSpace
- 2.7 isPlanet
- 2.8 isPlayer
- 2.9 isShip
- 2.10 isStation
- 2.11 isSubEntity
- 2.12 isSun
- 2.13 isSunlit
- 2.14 isValid
- 2.15 isVisible
- 2.16 isVisualEffect
- 2.17 isWormhole
- 2.18 mass
- 2.19 maxEnergy
- 2.20 orientation
- 2.21 owner
- 2.22 position
- 2.23 scanClass
- 2.24 spawnTime
- 2.25 status
Stale References
When an entity dies or is otherwise removed from the game universe (for instance, because player jumped from the system), existing Entity
variables referring to the entity become invalid; all their properties become undefined
, and their methods do nothing. In addition to the undefined properties, this can be detected with the isValid
property.
Properties
collisionRadius
collisionRadius : Number (read-only)
The radius of the entity, in game meters. This is the radius of the spherical entity representation Oolite calculates with for non-colliding entities.
distanceTravelled
distanceTravelled : Number (read-only)
The distance the entity has travelled since being spawned, in game meters. It only tracks the distance change generated by thrust. (useful for missiles). Distance traveled by an initial velocity, like with cargo pods, is not added in this value.
energy
energy : Number (read/write)
The entity’s total energy; ranges from 0 to maxEnergy
.
heading
heading : Vector (read-only)
The heading of the entity. This is equivalent to orientation
, but ignoring the axial twist component (roll in the case of a ship).
entity.heading()
is equivalent to entity.orientation.forwardVector()
.
isDock
This property was added in Oolite test release 1.77.
isDock : Boolean (read-only)
true
if the entity is a Dock, false
otherwise.
isInSpace
This property was added in Oolite test release 1.77.
isInSpace : Boolean (read-only)
true
if the entity is currently independently in real space, false
otherwise (e.g. dead, docked, in a hold, in witchspace, etc.)
isPlanet
isPlanet : Boolean (read-only)
true
if the entity is a Planet, false
otherwise.
isPlayer
isPlayer : Boolean (read-only)
true
if the entity is the player ship, false
otherwise.
isShip
isShip : Boolean (read-only)
true
if the entity is a Ship, false
otherwise.
isStation
isStation : Boolean (read-only)
true
if the entity is a Station, false
otherwise.
isSubEntity
isSubEntity : Boolean (read-only)
true
if the entity is a subentity, false
otherwise. A subentity’s owner can be acquired through the owner
property.
isSun
isSun : Boolean (read-only)
true
if the entity is a Sun, false
otherwise.
isSunlit
This property was added in Oolite test release 1.89.
isSunlit : Boolean (read-only)
true
if the entity is a currently being lit by the sun or false
if in the shadow of another entity, like a planet or station.
isValid
isValid : Boolean (read-only)
true
if the entity is a valid entity variable, false
if it is stale.
isVisible
This property was added in Oolite test release 1.77.
isVisible : Boolean (read-only)
Determines if the entity is close enough to the player to be drawn.
isVisualEffect
This property was added in Oolite test release 1.77.
isVisualEffect : Boolean (read-only)
true
if the entity is a VisualEffect, false
otherwise.
isWormhole
This property was added in Oolite test release 1.79.
isWormhole : Boolean (read-only)
true
if the entity is a Wormhole, false
otherwise.
mass
mass : Number (read-only)
The mass of the entity. Currently, this is directly proportional to the volume.
maxEnergy
maxEnergy : Number (read-only, read/write from 1.81)
The highest permissible value of energy
.
orientation
orientation : Quaternion (read/write)
owner
owner : Entity (read-only)
The entity which owns this one. In the case of a subentity, the entity to which it is attached. In the case of a defense ship, the station it belongs to. In the case of an escort, the group leader. In the case of a missile, the ship that launched it. There may be other uses.
position
position : Vector (read/write)
scanClass
scanClass : String (read-only)
The entity's current scan class such as "CLASS_NEUTRAL"
or "CLASS_CARGO"
, etc.
In 1.77 or later, this is partially read/write for Ship entities other than the PlayerShip.
spawnTime
spawnTime : Number (read-only)
The time at which the entity came into existence.
status
status : String (read-only)
The entity's current status. Possible values (though not an exhaustive list):
"STATUS_DOCKED"
"STATUS_IN_FLIGHT"
"STATUS_WITCHSPACE_COUNTDOWN"
"STATUS_EXITING_WITCHSPACE"
"STATUS_BEING_SCOOPED"