Oolite JavaScript Reference: SystemInfo

Prototype: Object

SystemInfo objects provide information about a specific system. SystemInfos can be retrieved for any system in the current galaxy, but not systems in other galaxies. If you keep a reference to a SystemInfo object after the player goes to a different galaxy, attempts to read properties of the stored SystemInfo will cause an exception.

In interstellar space, system.info refers to a temporary SystemInfo object whose properties cannot be written to. Attempting to read properties of such a temporary SystemInfo after leaving interstellar space will raise an exception.

Properties

coordinates : Vector3D (read-only)

The coordinates of the system in light years. e.g. for Lave: (8, 34.6, 0). The z component is always zero.

The upper left corner has the coordinate (0, 0, 0). Going right increases the x value while going down on the map increases the y value.

Example:

System.infoForSystem(galaxyNumber, 7).coordinates

returns the coordinates of the system with an ID number of 7 in the current galaxy. In the first galaxy that would be the coordinates for Lave: (8, 34.6, 0).

galaxyID

galaxyID : Number (read-only nonnegative integer)

The ID number of the galaxy.

internalCoordinates

internalCoordinates : Vector3D (read-only)

Discouraged in favour of coordinates.
The coordinate of the system in the internal coordinate system.

systemID

systemID : Number (read-only nonnegative integer)

The ID number of the system.

More properties

In addition to the properties above, you can access many other system properties, using the same keys as planetinfo.plist.

Example:

system.info.description = "This is a dull planet."

sets the description of the current planet to “This is a dull planet.”

Modified properties are permanent and are stored in saved game. Changes made by scripts override those in planetinfo.plist. Set a property to null to restore the planetinfo.plist value, or the default.

Methods

distanceToSystem

function distanceToSystem(system : SystemInfo) : Number

Returns the distance in light years to another SystemInfo.

Example:

System.infoForSystem(galaxyNumber, 7).distanceToSystem(System.infoForSystem(galaxyNumber, 8))

If galaxyNumber is 0, this returns 92.8.

routeToSystem

function routeToSystem(system : SystemInfo [, "OPTIMIZED_BY_JUMPS" | "OPTIMIZED_BY_TIME"] ) : Object

Returns a dictionary containing the route information to another SystemInfo. The dictionary contains the array of system IDs that belong to the route found, the distance and the time corresponding to said route. Takes the optional parameter "OPTIMIZED_BY_JUMPS" (default) or "OPTIMIZED_BY_TIME" to calculate least number of jumps or fastest transit time routes respectively.

Example:

var myRoute = System.infoForSystem(galaxyNumber, 7).routeToSystem(System.infoForSystem(galaxyNumber, 8))
myRoute.route
myRoute.distance
myRoute.time

returns:

7,129,227,73,89,222,29,42,131,62,150,36,28,16,185,86,138,51,8  (the route)
96.40  (distance of added jumps)
530.40 (travelled time)

systemsInRange

function systemsInRange([range : Number]) : Array

Returns an array of SystemInfos in range (default: 7) from the given system.

Note: will not produce correct results if used in interstellar space.

Example:

system.info.systemsInRange(5);

See also: SystemInfo.systemsInRange() (which always provides results relative to the current system).

Static methods

filteredSystems

function filteredSystems(this : Object, predicate : Function) : Array of SystemInfo

A list of the SystemInfos for which predicate returns true.

Example:

// This is the actual implementation of systemsInRange().
SystemInfo.prototype.systemsInRange = function systemsInRange(range) 
{ 
   if (range === undefined) 
   { 
       range = 7; 
   } 
   
   return SystemInfo.filteredSystems(this, function(other) 
   { 
       return (other.systemID !== this.systemID) && (this.distanceToSystem(other) <= range); 
   }); 
}