Difference between revisions of "Oolite JavaScript Reference: Dock"
(Document new Dock object) |
m (→disallowedDockingCollides: is read-write) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | '''This is a new class planned for 1.77 and may be subject to significant change before 1.77 is released.''' |
||
| − | |||
<small>'''Prototype:''' <code>[[Oolite JavaScript Reference: Ship|Ship]]</code></small><br /> |
<small>'''Prototype:''' <code>[[Oolite JavaScript Reference: Ship|Ship]]</code></small><br /> |
||
<small>'''Subtypes:''' none</small> |
<small>'''Subtypes:''' none</small> |
||
| Line 11: | Line 9: | ||
{{oolite-prop-added|1.77}} |
{{oolite-prop-added|1.77}} |
||
=== allowsDocking === |
=== allowsDocking === |
||
| − | '''allowsDocking''' : Boolean (read |
+ | '''allowsDocking''' : Boolean (read/write) |
| − | If true, this dock allows ships to dock with it, and the station's traffic control will direct them to this dock. If false, station control will not direct any ships to this dock, |
+ | If true, this dock allows ships to dock with it, and the station's traffic control will direct them to this dock. If false, station control will not direct any ships to this dock, though ships that end up there may be allowed to dock anyway, depending on the value of <code>disallowedDockingCollides</code>. |
| − | === |
+ | === allowsLaunching === |
| − | ''' |
+ | '''allowsLaunching''' : Boolean (read/write) |
| − | + | Whether or not the dock allows ships to launch from it. If all of a station's docks disallow launching, the player will still be allowed to launch from one of them. |
|
| − | If this is true, the player will be allowed to dock with this dock even if <code>allowsDocking</code> is false. NPCs that somehow end up next to this dock will also be docked in this case, though traffic control will never intentionally put them in this situation. |
||
| + | === disallowedDockingCollides === |
||
| + | '''disallowedDockingCollides''' : Boolean (read/write) |
||
| + | This property is only used if <code>allowsDocking</code> is false. In that situation, when a ship tries to dock with this dock (under normal circumstances, this will either be the player docking manually, or a ship with a customised AI) what happens depends on this property. |
||
| − | === allowsLaunching === |
||
| + | If it is false, the ship will be allowed to dock with the station anyway. If it is true, the ship will collide with the dock, and be repelled, taking damage in the process. |
||
| − | '''allowsLaunching''' : Boolean (read-only) |
||
| − | Whether or not the dock allows ships to launch from it. If all of a station's docks disallow launching, the player will still be allowed to launch from one of them. |
||
=== dockingQueueLength === |
=== dockingQueueLength === |
||
| Line 28: | Line 26: | ||
The number of ships currently queued to dock at this port by station traffic control. |
The number of ships currently queued to dock at this port by station traffic control. |
||
| − | === |
+ | === launchingQueueLength === |
| − | ''' |
+ | '''launchingQueueLength''' : Number (read-only) |
The number of ships currently queued to launch from this port by station traffic control. |
The number of ships currently queued to launch from this port by station traffic control. |
||
Latest revision as of 11:21, 15 March 2014
Prototype: Ship
Subtypes: none
The Dock class is an Entity representing a docking port on a carrier or station. A Dock has all the properties and methods of a Ship, and some others.
All Stations have at least one Dock object associated with them.
Contents
Properties
This property was added in Oolite test release 1.77.
allowsDocking
allowsDocking : Boolean (read/write)
If true, this dock allows ships to dock with it, and the station's traffic control will direct them to this dock. If false, station control will not direct any ships to this dock, though ships that end up there may be allowed to dock anyway, depending on the value of disallowedDockingCollides.
allowsLaunching
allowsLaunching : Boolean (read/write)
Whether or not the dock allows ships to launch from it. If all of a station's docks disallow launching, the player will still be allowed to launch from one of them.
disallowedDockingCollides
disallowedDockingCollides : Boolean (read/write)
This property is only used if allowsDocking is false. In that situation, when a ship tries to dock with this dock (under normal circumstances, this will either be the player docking manually, or a ship with a customised AI) what happens depends on this property.
If it is false, the ship will be allowed to dock with the station anyway. If it is true, the ship will collide with the dock, and be repelled, taking damage in the process.
dockingQueueLength
dockingQueueLength : Number (read-only)
The number of ships currently queued to dock at this port by station traffic control.
launchingQueueLength
launchingQueueLength : Number (read-only)
The number of ships currently queued to launch from this port by station traffic control.
