Difference between revisions of "Oolite JavaScript Reference: Wormhole"
(Added in v1.79: Wormhole entity with properties arrivalTime, destination, expiryTime and origin.) |
m (Property type fixes.) |
||
| Line 10: | Line 10: | ||
{{Oolite-prop-added|1.79}} | {{Oolite-prop-added|1.79}} | ||
'''arrivalTime''' : Number (read-only) | '''arrivalTime''' : Number (read-only) | ||
| − | The game real time in seconds when the player will arrive to the other system if fly into the Wormhole. More info can be found in [[Time_scales_in_Oolite]]. | + | The game real time in seconds when the player will arrive to the other system if fly into the Wormhole. More info can be found in [[Time_scales_in_Oolite|Time scales in Oolite]]. |
=== <code>destination</code> === | === <code>destination</code> === | ||
{{Oolite-prop-added|1.79}} | {{Oolite-prop-added|1.79}} | ||
| − | '''destination''' : | + | '''destination''' : Number (read-only) |
| − | The | + | The [[Oolite JavaScript Reference: System#ID|ID]] of the destination [[Oolite JavaScript Reference: System|System]]. |
=== <code>expiryTime</code> === | === <code>expiryTime</code> === | ||
{{Oolite-prop-added|1.79}} | {{Oolite-prop-added|1.79}} | ||
'''expiryTime''' : Number (read-only) | '''expiryTime''' : Number (read-only) | ||
| − | The Wormhole will collapse | + | The [[Time_scales_in_Oolite#Game_real_time|game real time]] in seconds when the Wormhole will collapse. |
=== <code>origin</code> === | === <code>origin</code> === | ||
{{Oolite-prop-added|1.79}} | {{Oolite-prop-added|1.79}} | ||
| − | '''origin''' : | + | '''origin''' : Number (read/write) |
| − | The | + | The [[Oolite JavaScript Reference: System#ID|ID]] of the [[Oolite JavaScript Reference: System|System]] where the Wormhole originally opened. |
| − | In v1.79 always equal with the current [[Oolite JavaScript Reference: System|System]] due to available for the entry Wormholes only. | + | In v1.79 always equal with the ID of the current [[Oolite JavaScript Reference: System|System]] due to available for the entry Wormholes only. |
[[Category:Oolite JavaScript Reference]] | [[Category:Oolite JavaScript Reference]] | ||
Revision as of 14:12, 8 July 2013
Prototype: Entity
Subtypes: none
The Wormhole class is an Entity representing an opened gate to another System. A Wormhole has all the properties and methods of a Entity, and several others.
In v1.79 available for the entry Wormholes only.
Properties
arrivalTime
This property was added in Oolite test release 1.79.
arrivalTime : Number (read-only)
The game real time in seconds when the player will arrive to the other system if fly into the Wormhole. More info can be found in Time scales in Oolite.
destination
This property was added in Oolite test release 1.79.
destination : Number (read-only)
The ID of the destination System.
expiryTime
This property was added in Oolite test release 1.79.
expiryTime : Number (read-only)
The game real time in seconds when the Wormhole will collapse.
origin
This property was added in Oolite test release 1.79.
origin : Number (read/write)
The ID of the System where the Wormhole originally opened.
In v1.79 always equal with the ID of the current System due to available for the entry Wormholes only.
