Oolite JavaScript Reference: Entity - Revision history

Hiran: /* status */

2021-07-04T22:32:02Z

‎status

2021-07-04T22:31:42Z

‎status

2020-06-23T06:23:20Z

2015-12-12T16:12:29Z

‎owner: This should be mentioned

2014-09-21T19:32:19Z

‎maxEnergy: 1.81 update

2013-07-08T10:28:22Z

Added property in v 1.79: isWormhole

2012-12-28T19:35:26Z

isInSpace

2012-09-08T08:30:18Z

‎Properties: isVisualEffect

2012-07-13T10:52:06Z

‎Properties: isDock

2012-06-20T21:13:01Z

distanceTravelled: updated with thrust info

@@ Line 114: / Line 114: @@
 === <code>status</code> ===
  '''status''' : String (read-only)
-The current status of the entity. Possible values (though not an exhaustive list:
+The current status of the entity. Possible values (though not an exhaustive list):
 * STATUS_IN_FLIGHT
 * STATUS_BEING_SCOOPED

@@ Line 114: / Line 114: @@
 === <code>status</code> ===
  '''status''' : String (read-only)
-The current status of the entity (such as “STATUS_IN_FLIGHT” and “STATUS_BEING_SCOOPED”).
+The current status of the entity. Possible values (though not an exhaustive list:
 [[Category:Oolite JavaScript Reference]]

@@ Line 59: / Line 59: @@
  '''isSun''' : Boolean (read-only)
 <code>true</code> if the entity is a [[Oolite JavaScript Reference: Sun|Sun]], <code>false</code> otherwise.
 === <code>isValid</code> ===

@@ Line 92: / Line 92: @@
 === <code>owner</code> ===
  '''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 a missile, the ship that launched it. There may be other uses.
+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.
 === <code>position</code> ===

@@ Line 84: / Line 84: @@
 === <code>maxEnergy</code> ===
- '''maxEnergy''' : Number (read-only)
+ '''maxEnergy''' : Number (read-only, read/write from 1.81)
 The highest permissible value of <code>[[#energy|energy]]</code>.

@@ Line 73: / Line 73: @@
  '''isVisualEffect''' : Boolean (read-only)
 <code>true</code> if the entity is a [[Oolite JavaScript Reference: VisualEffect|VisualEffect]], <code>false</code> otherwise.
 === <code>mass</code> ===

@@ Line 30: / Line 30: @@
  '''isDock''' : Boolean (read-only)
 <code>true</code> if the entity is a [[Oolite JavaScript Reference: Dock|Dock]], <code>false</code> otherwise.
 === <code>isPlanet</code> ===

@@ Line 63: / Line 63: @@
  '''isVisible''' : Boolean (read-only)
 Determines if the entity is close enough to the player to be drawn.
 === <code>mass</code> ===

← Older revision		Revision as of 10:52, 13 July 2012
Line 25:		Line 25:

	<code>entity.heading()</code> is equivalent to <code>entity.[[#orientation\|orientation]].[[Oolite JavaScript Reference: Quaternion#forwardVector\|forwardVector]]()</code>.		<code>entity.heading()</code> is equivalent to <code>entity.[[#orientation\|orientation]].[[Oolite JavaScript Reference: Quaternion#forwardVector\|forwardVector]]()</code>.
		+
		+	=== <code>isDock</code> ===
		+	{{oolite-prop-added\|1.77}}
		+	'''isDock''' : Boolean (read-only)
		+	<code>true</code> if the entity is a [[Oolite JavaScript Reference: Dock\|Dock]], <code>false</code> otherwise.

	=== <code>isPlanet</code> ===		=== <code>isPlanet</code> ===

@@ Line 14: / Line 14: @@
 === <code>distanceTravelled</code> ===
  '''distanceTravelled''' : Number (read-only)
-The distance the entity has travelled since being spawned, in game meters.
+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.
 === <code>energy</code> ===