Difference between revisions of "Oolite JavaScript Reference: Planet"

From Elite Wiki
(Added radius reference values)
m (radius)
Line 18: Line 18:
 
  '''radius''' : Number (read-only)
 
  '''radius''' : Number (read-only)
 
The equatorial radius of the planet, in metres.<br>
 
The equatorial radius of the planet, in metres.<br>
For reference: Radii of planets generated by Oolite vary between 28160 and 69120 meters. This value if shown on the F7 screen as: 2816 km until 6912 km.
+
For reference: Radii of main planets generated by Oolite vary between 28160 and 69120 meters. This value if shown on the F7 screen as: 2816 km until 6912 km. (note the discrepancy of a factor 100)
  
 
== Methods ==
 
== Methods ==

Revision as of 09:26, 23 July 2009

Prototype: Entity
Subtypes: none

This class was added in Oolite test release 1.70.

The Planet class is an Entity representing a planet or moon. 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.

hasAtmosphere

hasAtmosphere : Boolean (read-only)

true if the entity has an atmosphere, false otherwise. 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.
For reference: Radii of main planets generated by Oolite vary between 28160 and 69120 meters. This value if shown on the F7 screen as: 2816 km until 6912 km. (note the discrepancy of a factor 100)

Methods

setTexture

function setTexture(texture: String)

This method was added in Oolite test release 1.71.

Uses the texture file (must be a .png) as texture for the planet. This function only works when called during the shipWillExitWitchspace and shipWillLaunchFromStation events.