Oolite JavaScript Reference: Dock - Revision history

Cim: /* disallowedDockingCollides */ is read-write

2014-03-15T10:21:32Z

‎disallowedDockingCollides: is read-write

Cim: Remove 1.77 header

2013-12-18T16:59:30Z

Remove 1.77 header

Cim: /* launchQueueLength */ Fix name

2013-06-23T08:58:08Z

‎launchQueueLength: Fix name

Cim: /* allowsDocking */ note change

2012-07-26T06:12:53Z

‎allowsDocking: note change

Cim: Property rename

2012-07-26T06:11:36Z

Property rename

Cim: allowDocking/Launching read-write

2012-07-14T11:29:51Z

allowDocking/Launching read-write

Cim: Document new Dock object

2012-07-13T10:50:39Z

Document new Dock object

New page

'''This is a new class planned for 1.77 and may be subject to significant change before 1.77 is released.'''

'''Prototype:''' <code>[[Oolite JavaScript Reference: Ship|Ship]]</code> 
'''Subtypes:''' none

The '''<code>Dock</code>''' class is an <code>[[Oolite JavaScript Reference: Entity|Entity]]</code> representing a docking port on a carrier or station. A <code>Dock</code> has all the properties and methods of a <code>[[Oolite JavaScript Reference: Ship|Ship]]</code>, and some others.

All <code> [[Oolite JavaScript Reference: Station|Station]]</code>s have at least one Dock object associated with them.

== Properties ==
{{oolite-prop-added|1.77}}
=== allowsDocking ===
'''allowsDocking''' : Boolean (read-only)
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, and ships attempting to dock will bounce off, taking damage.

=== allowsPlayerDocking ===
'''allowsPlayerDocking''' : Boolean (read-only)
If this is false, the player will not be allowed to dock with this dock. If <code>allowsDocking</code> is true, then NPCs will be able to dock here.

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.

=== allowsLaunching ===
'''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''' : Number (read-only)
The number of ships currently queued to dock at this port by station traffic control.

=== launchQueueLength ===
'''launchQueueLength''' : Number (read-only)
The number of ships currently queued to launch from this port by station traffic control.

[[Category:Oolite JavaScript Reference]]

@@ Line 17: / Line 17: @@
 === disallowedDockingCollides ===
- '''disallowedDockingCollides''' : Boolean (read-only)
+ '''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.

← Older revision		Revision as of 16:59, 18 December 2013
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 28: / Line 28: @@
 The number of ships currently queued to dock at this port by station traffic control.
-=== launchQueueLength ===
+=== launchingQueueLength ===
- '''launchQueueLength''' : Number (read-only)
+ '''launchingQueueLength''' : Number (read-only)
 The number of ships currently queued to launch from this port by station traffic control.

@@ Line 12: / Line 12: @@
 === 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, and ships attempting to dock will bounce off, taking damage.
+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 ===

@@ Line 13: / Line 13: @@
  '''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, and ships attempting to dock will bounce off, taking damage.
 === 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.
 === dockingQueueLength ===