Oolite JavaScript Reference: Sun

Prototype: Entity
Subtypes: none

This class was added in Oolite test release 1.70.

The Sun class is an Entity representing a sun. A Sun has all the properties and methods of a Entity, and several others. Currently, Oolite supports at most one sun per system, accessible via the system.sun property.

Properties

hasGoneNova

This property was added in Oolite test release 1.72.

hasGoneNova : Boolean (read-only)

True if the sun has gone nova.

See Also: isGoingNova, goNova()

isGoingNova

This property was added in Oolite test release 1.72.

isGoingNova : Boolean (read-only)

True if the sun is scheduled to go nova.

See Also: hasGoneNova, goNova(), cancelNova()

radius

radius : Number (read-only)

The equatorial radius of the sun, in metres.

goNova

function setSunNova(secondsUntilNova : Number)

Sets the system’s sun to go nova after the specified time interval. Time is specified in game real time. Added in 1.72

Methods

cancelNova

This method was added in Oolite test release 1.72.

function cancelNova()

Cancels a scheduled nova, if a nova has been scheduled but not yet occurred.

See Also: hasGoneNova, isGoingNova, goNova()

goNova

This method was added in Oolite test release 1.72.

function goNova([delay : Number])

Causes the sun to explode. The optional delay parameter causes the nova to happen after a specified delay (specified in seconds in game real time).

See Also: hasGoneNova, isGoingNova, cancelNova()