Difference between revisions of "Oolite JavaScript Reference: Sun"
(Name property) |
m (→isGoingNova: uniform boolean format) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 7: | Line 7: | ||
=== <code>hasGoneNova</code> === | === <code>hasGoneNova</code> === | ||
'''hasGoneNova''' : Boolean (read-only) | '''hasGoneNova''' : Boolean (read-only) | ||
| − | + | <code>true</code> if the sun has gone nova. | |
'''See Also:''' <code>[[#isGoingNova|isGoingNova]]</code>, <code>[[#goNova|goNova]]()</code> | '''See Also:''' <code>[[#isGoingNova|isGoingNova]]</code>, <code>[[#goNova|goNova]]()</code> | ||
| Line 13: | Line 13: | ||
=== <code>isGoingNova</code> === | === <code>isGoingNova</code> === | ||
'''isGoingNova''' : Boolean (read-only) | '''isGoingNova''' : Boolean (read-only) | ||
| − | + | <code>true</code> if the sun is scheduled to go nova. | |
'''See Also:''' <code>[[#hasGoneNova|hasGoneNova]]</code>, <code>[[#goNova|goNova]]()</code>, <code>[[#cancelNova|cancelNova]]()</code> | '''See Also:''' <code>[[#hasGoneNova|hasGoneNova]]</code>, <code>[[#goNova|goNova]]()</code>, <code>[[#cancelNova|cancelNova]]()</code> | ||
Revision as of 05:20, 15 October 2022
Prototype: Entity
Subtypes: none
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
hasGoneNova : Boolean (read-only)
true if the sun has gone nova.
See Also: isGoingNova, goNova()
isGoingNova
isGoingNova : Boolean (read-only)
true if the sun is scheduled to go nova.
See Also: hasGoneNova, goNova(), cancelNova()
name
This property was added in Oolite test release 1.79.
name : String (read-only)
The name of the sun, as set by the sun_name property in planetinfo.plist
radius
radius : Number (read-only)
The equatorial radius of the sun, in metres.
Methods
cancelNova
function cancelNova()
Cancels a scheduled nova, if a nova has been scheduled but not yet occurred.
See Also: hasGoneNova, isGoingNova, goNova()
goNova
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()
