Difference between revisions of "Oolite JavaScript Reference: Station"
From Elite Wiki
(Changed future-scripting tag to added-in-1.70, updated links.) |
(Documented hasNPCTraffic property.) |
||
| Line 3: | Line 3: | ||
{{Oolite-class-added|1.70}} | {{Oolite-class-added|1.70}} | ||
| − | The '''<code>Station</code>''' class is an <code>[[Oolite JavaScript Reference: Entity|Entity]]</code> representing a station or carrier (i.e., a ship with a docking port). A <code>Station</code> has all the properties and methods of a <code> [[Oolite JavaScript Reference: Ship|Ship]]</code>, and | + | The '''<code>Station</code>''' class is an <code>[[Oolite JavaScript Reference: Entity|Entity]]</code> representing a station or carrier (i.e., a ship with a docking port). A <code>Station</code> has all the properties and methods of a <code> [[Oolite JavaScript Reference: Ship|Ship]]</code>, and some others. |
== Properties == | == Properties == | ||
| + | === <code>hasNPCTraffic</code> === | ||
| + | '''isMainStation''' : Boolean (read/write) | ||
| + | If <code>true</code>, the station has associated non-player traffic, such as shuttles, patrol ships and scavengers. Corresponds to the <code>has_npc_traffic</code> ''[[shipdata.plist#has_npc_traffic|shipdata.plist]]'' key. | ||
| + | |||
=== <code>isMainStation</code> === | === <code>isMainStation</code> === | ||
| − | isMainStation | + | '''isMainStation''' : Boolean (read-only) |
<code>true</code> if the station is the main station of the system, <code>false</code> otherwise. | <code>true</code> if the station is the main station of the system, <code>false</code> otherwise. | ||
[[Category:Oolite scripting]] | [[Category:Oolite scripting]] | ||
Revision as of 11:32, 6 December 2007
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.
Properties
hasNPCTraffic
isMainStation : 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.