Difference between revisions of "Oolite JavaScript Reference: Sun"
Eric Walch (talk | contribs) (→<code>goNova</code>) |
(Moving Oolite JS reference into a subcategory of Oolite scripting.) |
||
| Line 42: | Line 42: | ||
'''See Also:''' <code>[[#hasGoneNova|hasGoneNova]]</code>, <code>[[#isGoingNova|isGoingNova]]</code>, <code>[[#cancelNova|cancelNova]]()</code> |
'''See Also:''' <code>[[#hasGoneNova|hasGoneNova]]</code>, <code>[[#isGoingNova|isGoingNova]]</code>, <code>[[#cancelNova|cancelNova]]()</code> |
||
| − | [[Category:Oolite |
+ | [[Category:Oolite JavaScript reference]] |
Revision as of 14:58, 19 June 2010
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.
Contents
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.
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()
