Difference between revisions of "Oolite JavaScript Reference: Sun"
m (Oolite/Development/Scripting/Class/Sun moved to Oolite JavaScript Reference: Sun: No longer draft.) |
m (→isGoingNova: uniform boolean format) |
||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
<small>'''Prototype:''' <code>[[Oolite JavaScript Reference: Entity|Entity]]</code></small><br /> | <small>'''Prototype:''' <code>[[Oolite JavaScript Reference: Entity|Entity]]</code></small><br /> | ||
| − | <small>'''Subtypes:''' none | + | <small>'''Subtypes:''' none</small> |
| − | + | The '''<code>Sun</code>''' class is an <code>[[Oolite JavaScript Reference: Entity|Entity]]</code> representing a sun. A <code>Sun</code> has all the properties and methods of a <code>Entity</code>, and several others. Currently, Oolite supports at most one sun per system, accessible via the <code>[[Oolite JavaScript Reference: System|system]].[[Oolite JavaScript Reference: System#sun|sun]]</code> property. | |
| + | |||
| + | == Properties == | ||
| + | === <code>hasGoneNova</code> === | ||
| + | '''hasGoneNova''' : Boolean (read-only) | ||
| + | <code>true</code> if the sun has gone nova. | ||
| + | |||
| + | '''See Also:''' <code>[[#isGoingNova|isGoingNova]]</code>, <code>[[#goNova|goNova]]()</code> | ||
| + | |||
| + | === <code>isGoingNova</code> === | ||
| + | '''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> | |
| + | |||
| + | === <code>name</code> === | ||
| + | {{oolite-prop-added|1.79}} | ||
| + | '''name''' : String (read-only) | ||
| + | The name of the sun, as set by the <code>sun_name</code> property in [[planetinfo.plist]] | ||
| − | === radius === | + | === <code>radius</code> === |
'''radius''' : Number (read-only) | '''radius''' : Number (read-only) | ||
The equatorial radius of the sun, in metres. | The equatorial radius of the sun, in metres. | ||
| − | [[Category:Oolite | + | |
| + | |||
| + | == Methods == | ||
| + | === <code>cancelNova</code> === | ||
| + | function '''cancelNova'''() | ||
| + | Cancels a scheduled nova, if a nova has been scheduled but not yet occurred. | ||
| + | |||
| + | '''See Also:''' <code>[[#hasGoneNova|hasGoneNova]]</code>, <code>[[#isGoingNova|isGoingNova]]</code>, <code>[[#goNova|goNova]]()</code> | ||
| + | |||
| + | === <code>goNova</code> === | ||
| + | function '''goNova'''([delay : Number]) | ||
| + | Causes the sun to explode. The optional <code>delay</code> parameter causes the nova to happen after a specified delay (specified in seconds in [[Time scales in Oolite#Game real time|game real time]]). | ||
| + | |||
| + | '''See Also:''' <code>[[#hasGoneNova|hasGoneNova]]</code>, <code>[[#isGoingNova|isGoingNova]]</code>, <code>[[#cancelNova|cancelNova]]()</code> | ||
| + | |||
| + | [[Category:Oolite JavaScript Reference]] | ||
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()
