Oolite JavaScript Reference: Planet

From Elite Wiki
Revision as of 15:39, 8 October 2007 by Ahruman (talk | contribs)

Prototype: Entity
Subtypes: none

This page documents a planned future Oolite scripting feature. It is presented as a basis for discussion or to help developers organize their thoughts. The functionality presented may end up taking a radically different form, or may not become available at all.

The Planet class is an Entity representing a celestial body. Just as a Ship may in fact be an asteroid, a Planet may be the sun. A Planet has all the properties and methods of a Entity, and several others.

Properties

isMainPlanet

isMainPlanet : Boolean (read-only)

true if the entity is the main planet of the current system, false otherwise.

isSun

isSun : Boolean (read-only)

true if the entity is the sun of the current system, false otherwise.

hasAtmosphere

hasAtmosphere : Boolean (read-only)

true if the entity has an atmosphere, false otherwise. The sun and planets created with the System.addMoon() method (or corresponding legacy scripting method) have no atmosphere, other planets do.

radius

radius : Number (read-only)

The equatorial radius of the planet, in metres.

Retrieved from "http://backup.witchspacewiki.org/index.php?title=Oolite_JavaScript_Reference:_Planet&oldid=7988"