Difference between revisions of "Oolite JavaScript Reference: Station"
Eric Walch (talk | contribs) (Added launchShipWithRole) |
Eric Walch (talk | contribs) (Added alert level to station) |
||
| Line 6: | Line 6: | ||
== Properties == | == Properties == | ||
| + | === <code>alertCondition</code> === | ||
| + | {{Oolite-class-added|1.72}} | ||
| + | '''alertCondition''' : Number (read/write, integer) | ||
| + | Returns the current alert condition. 1 = Green, 2 = Yellow, 3 = Red. | ||
| + | |||
=== <code>hasNPCTraffic</code> === | === <code>hasNPCTraffic</code> === | ||
'''hasNPCTraffic''' : Boolean (read/write) | '''hasNPCTraffic''' : Boolean (read/write) | ||
Revision as of 08:57, 24 November 2009
Prototype: Ship
This class was added in Oolite test release 1.70.
The Station class is an Entity representing a station or carrier (i.e., a ship with a docking port). A Station has all the properties and methods of a Ship, and some others.
Contents
Properties
alertCondition
This class was added in Oolite test release 1.72.
alertCondition : Number (read/write, integer)
Returns the current alert condition. 1 = Green, 2 = Yellow, 3 = Red.
hasNPCTraffic
hasNPCTraffic : Boolean (read/write)
If true, the station has associated non-player traffic, such as shuttles, patrol ships and scavengers. Corresponds to the has_npc_traffic shipdata.plist key.
isMainStation
isMainStation : Boolean (read-only)
true if the station is the main station of the system, false otherwise.
requiresDockingClearance
requiresDockingClearance : Boolean (read/write)
true if the station requires docking clearance, false otherwise.
Methods
This property was added in Oolite test release 1.73.
dockPlayer
dockPlayer() : Boolean
This method docks the player at the specified station. Returns false if docking fails, otherwise true.
This property was added in Oolite test release 1.74.
launchShipWithRole
launchShipWithRole(role : string) : Ship
This method adds a ship with given role to the launching queue at the specified station. Returns the entity of the chosen ship.
