Oolite JavaScript Reference: Station - Revision history

Tsoj: /* shipyard */ fixed small javascript mistake

2021-02-16T21:17:26Z

‎shipyard: fixed small javascript mistake

2019-04-19T07:01:49Z

2016-12-08T17:32:15Z

canDockShip

2014-12-08T20:03:15Z

‎market: 1.81 updates

2014-12-01T17:26:03Z

‎allegiance: clarify

2013-10-05T10:56:13Z

‎market: 1.79 change

2013-10-04T20:21:23Z

1.79 methods and properties for Station

2013-01-14T18:04:45Z

‎Properties: Add roll to Station too

2012-12-29T09:04:54Z

Updated market info

2012-11-12T16:27:36Z

‎setInterface: fix syntax

@@ Line 144: / Line 144: @@
 Example:
- var ship_count = system.mainStation.shipyard.count;
+ var ship_count = system.mainStation.shipyard.length;
  var key = system.mainStation.shipyard[0].shipdata_key;

@@ Line 125: / Line 125: @@
 For stations, this can be set to any value between -2 and +2 to adjust their roll rate. The default is 0.4, or the value specified by the <code>station_roll</code> key in shipdata.plist. (Note that the <code>station_roll</code> property is for historical reasons in right-angles/second, not radians/second, so the reported value of <code>station.roll</code> will not be numerically equal to the shipdata.plist <code>station_roll</code> property)
 === <code>suppressArrivalReports</code> ===
@@ Line 142: / Line 163: @@
  '''abortDockingForShip(ship)'''
 Removes docking clearance from the specified ship if it is currently waiting to dock.
 === <code>canDockShip</code> ===
@@ Line 190: / Line 230: @@
  '''launchShuttle()''' : Ship
 This method adds a ship with a shuttle role to the launching queue at the specified station. Returns the entity of the chosen ship.
 === <code>setInterface</code> ===

@@ Line 129: / Line 129: @@
  '''suppressArrivalReports''' : Boolean (read/write)
 If set to <code>true</code>, arrival reports are not shown when the player docks with the station.
 == Methods ==
@@ Line 141: / Line 142: @@
  '''abortDockingForShip(ship)'''
 Removes docking clearance from the specified ship if it is currently waiting to dock.
 === <code>dockPlayer</code> ===

← Older revision		Revision as of 20:03, 8 December 2014
Line 91:		Line 91:

	In 1.79 or later there is also a "legalPenalty" entry describing the export bounty applied per unit for this cargo at main stations.		In 1.79 or later there is also a "legalPenalty" entry describing the export bounty applied per unit for this cargo at main stations.
		+
		+	In 1.81 or later the format of this object's properties changes to the following, and the number of properties on the object reflects the contents of [[trade-goods.plist]] rather than [[commodities.plist]]
		+	{
		+	quantity_random: "0.04",
		+	key: "food",
		+	trumble_opinion: "1.0",
		+	quantity: 16,
		+	quantity_average: "13.5",
		+	classes: ["oolite-consumer", "oolite-edible", "oolite-farming"],
		+	price_random: "0.04",
		+	quantity_unit: "0",
		+	price_economic: "0.55",
		+	peak_export: "7",
		+	legality_import: "0",
		+	name: "[commodity-name food]",
		+	sort_order: "100",
		+	peak_import: "0",
		+	legality_export: "0",
		+	quantity_economic: "0.52",
		+	price_average: "50",
		+	price: 38
		+	}

	=== <code>requiresDockingClearance</code> ===		=== <code>requiresDockingClearance</code> ===

@@ Line 19: / Line 19: @@
 * '''chaotic''' : anyone will be allowed to dock here
 * '''thargoid''' : this station is controlled by the Thargoids and is hostile to all Cooperative ships
-* '''private''' : this station will refuse docking except to specifically authorised ships
+* '''private''' : this station will refuse docking except to specifically authorised ships. Core Oolite AIs will assume that any station with an unrecognised allegiance is equivalent to private.
 * '''restricted''' : this station will refuse docking to and probably fire upon all unauthorised ships
 Stations without an allegiance specified when they are created will have a guess made dependent on their legal status, armament and scan class.

@@ Line 89: / Line 89: @@
+ }
 <code>price</code> is measured in decicredits, and <code>quantity</code> in the units determined by <code>quantityUnit</code>.
 === <code>requiresDockingClearance</code> ===

@@ Line 8: / Line 8: @@
  '''alertCondition''' : Number (read/write, integer)
 Returns the current alert condition. 1 = Green, 2 = Yellow, 3 = Red.
 === <code>allowsAutoDocking</code> ===
@@ Line 93: / Line 107: @@
 == Methods ==
 === <code>dockPlayer</code> ===
  '''dockPlayer()''' : Boolean
@@ Line 100: / Line 125: @@
  '''launchDefenseShip()''' : Ship
 This method adds a ship with a role defined in the ship key "defense_ship_role" or a specific ship defined with a ship key "defense_ship",  to the launching queue at the specified station. When no defense ships are defined it selects one from the police or interceptors. All ships launch with a primary role of "defense_ship". Returns the entity of the chosen ship. This method aborts all dockings for an immediate launch.
 === <code>launchMiner</code> ===

@@ Line 79: / Line 79: @@
  '''requiresDockingClearance''' : Boolean (read/write)
 <code>true</code> if the station requires docking clearance, <code>false</code> otherwise.
 === <code>suppressArrivalReports</code> ===

@@ Line 147: / Line 147: @@
  station.setInterface("my-oxp-example2",null);
-=== <code>setPrice</code> ===
+=== <code>setMarketPrice</code> ===
 {{oolite-method-added|1.77}}
- '''setPrice(commodity : String, price : Number)'''
+ '''setMarketPrice(commodity : String, price : Number)'''
 Set the price of the specified commodity in the local station market to the given value. For example:
- station.setPrice("food",38);
+ station.setMarketPrice("food",38);
 The price is in decicredits, and must be between 0 and 1020 decicredits.
-=== <code>setQuantity</code> ===
+=== <code>setMarketQuantity</code> ===
 {{oolite-method-added|1.77}}
- '''setQuantity(commodity : String, quantity : Number)'''
+ '''setMarketQuantity(commodity : String, quantity : Number)'''
 Set the quantity of the specified commodity in the local station market to the given value. For example:
- station.setQuantity("machinery",15);
+ station.setMarketQuantity("machinery",15);
 The quantity is in units, and must be between 0 and 127 units.

@@ Line 138: / Line 138: @@
 For example:
  station.setInterface("my-oxp-example1",{
-   title: "Example title";
+   title: "Example title",
-   category: "Examples";
+   category: "Examples",
-   summary: "This is an example interface definition. Further information is available.";
+   summary: "This is an example interface definition. Further information is available.",
-   callback: this._furtherExampleInformation.bind(this);
+   callback: this._furtherExampleInformation.bind(this)
  });
 or
  // the player has accepted the mission, so remove the interface
  station.setInterface("my-oxp-example2",null);
 === <code>setPrice</code> ===