Oolite JavaScript Reference: PlayerShip - Revision history

Phkb: /* Properties */

2020-06-29T08:05:29Z

‎Properties

Phkb at 03:26, 9 April 2019

2019-04-09T03:26:03Z

Phkb at 06:37, 18 February 2018

2018-02-18T06:37:07Z

Phkb at 00:06, 15 November 2017

2017-11-15T00:06:23Z

Phkb at 00:00, 15 November 2017

2017-11-15T00:00:58Z

Phkb at 07:08, 7 November 2017

2017-11-07T07:08:56Z

Phkb: /* compassType */

2017-10-18T05:01:07Z

‎compassType

Phkb: /* compassTarget */

2017-10-18T05:00:51Z

‎compassTarget

Phkb: /* compassMode */

2017-10-18T05:00:27Z

‎compassMode

Phkb: /* compassType */

2017-10-18T04:59:47Z

‎compassType

@@ Line 7: / Line 7: @@
 == Properties ==
 === <code>aftShield</code> ===
  '''aftShield''' : Number (read/write, nonnegative)

← Older revision		Revision as of 03:26, 9 April 2019
Line 240:		Line 240:

	'''See also''': <code>[[#targetSystem\|targetSystem]]()</code>		'''See also''': <code>[[#targetSystem\|targetSystem]]()</code>
−
−	=== <code>torusEngaged</code> ===
−	'''torusEngaged''' : Boolean(read-only)
−	Is the player ship currently using torus drive

	=== <code>price</code> ===		=== <code>price</code> ===

@@ Line 26: / Line 26: @@
  '''cargoSpaceUsed''' : Number (read-only integer)
 The ship’s current cargo, in tons.
 === <code>compassMode</code> ===
@@ Line 151: / Line 161: @@
 === <code>hyperspaceSpinTime</code> ===
 {{oolite-prop-added|1.77}}
  '''hyperspaceSpinTime''' : Number (read-only, read/write in 1.81)
 The length of the ship's hyperspace countdown.
@@ Line 157: / Line 168: @@
 === <code>infoSystem</code> ===
 {{oolite-prop-added|1.83}}
  '''infoSystem''' : Number (read/write)
 The ID of the system shown in the system (F7) screen.
@@ Line 164: / Line 175: @@
 === <code>injectorsEngaged</code> ===
 {{Oolite-prop-added|1.81}}
  '''injectorsEngaged''' : Boolean(read-only)
 Is the player ship currently using fuel injection.
@@ Line 190: / Line 202: @@
 === <code>missilesOnline</code> ===
 {{Oolite-prop-added|1.77}}
  '''missilesOnline''' : Boolean (read-only)
 True if the ship's targeting system is currently in missile targeting mode, false if it is currently in identification mode.
@@ Line 195: / Line 208: @@
 === <code>messageGuiTextColor</code> ===
 {{oolite-prop-added|1.85}}
  '''messageGuiTextColor''' : Color specifier (read/write)
 Gets/sets the color used by the message GUI component of the HUD to display text messages.
@@ Line 200: / Line 214: @@
 === <code>messageGuiTextCommsColor</code> ===
 {{oolite-prop-added|1.85}}
  '''messageGuiTextCommsColor''' : Color specifier (read/write)
 Gets/sets the color used by the message GUI component of the HUD to display comms messages.
@@ Line 205: / Line 220: @@
 === <code>multiFunctionDisplayList</code> ===
 {{Oolite-prop-added|1.81}}
  '''multiFunctionDisplayList''' : Array (read-only, strings)
 The IDs of the currently active multi-function displays
@@ Line 213: / Line 229: @@
 === <code>multiFunctionDisplays</code> ===
 {{Oolite-prop-added|1.79}}
  '''multiFunctionDisplays''' : Number (read-only, integer)
 The number of multi-function displays available on the current HUD.
@@ Line 218: / Line 235: @@
 === <code>nextSystem</code> ===
 {{Oolite-prop-added|1.85}}
  '''nextSystem''' : Integer (read-only)
 The ID of the next hyperspace system, if the player has a multi-step course plotted on the galactic chart.
@@ Line 229: / Line 247: @@
 === <code>price</code> ===
 {{Oolite-prop-added|1.77}}
  '''price''' : Number (read-only, positive integer in decicredits)
 The value the player's ship would have, including equipment, if in a perfect servicing state. The ship can be exchanged at a shipyard for 75% of this value if it really is in perfect servicing state.
@@ Line 234: / Line 253: @@
 === <code>primedEquipment</code> ===
 {{oolite-prop-added|1.85}}
  '''primedEquipment: String (read/write)
 Gets/sets the equipment key of current primed equipment item. When setting, the change will happen silently, ie. there will be no console message informing the player of the change.
@@ Line 241: / Line 261: @@
 === <code>renovationCost</code> ===
 {{Oolite-prop-added|1.79}}
  '''renovationCost''' : Number (read-only, positive integer in decicredits)
 The current price in decicredits to service the ship. Depending on the [[#serviceLevel|serviceLevel]] it may not be possible to actually purchase renovation at this time.
@@ Line 246: / Line 267: @@
 === <code>renovationMultiplier</code> ===
 {{Oolite-prop-added|1.79}}
  '''renovationMultiplier''' : Number (read-only, positive)
 The multiplier applied to the base cost of renovation (<code>renovationCost</code> already includes this multiplier) to allow for some ships being more difficult to maintain than others. The default is 1.0 - other values are set in [[Shipyard.plist#renovation_multiplier|shipyard.plist]]
@@ Line 251: / Line 273: @@
 === <code>reticleColorTarget</code> ===
 {{oolite-prop-added|1.85}}
  '''reticleColorTarget''' : Color specifier (read/write)
 Gets/sets the color used to highlight a target on the HUD.
@@ Line 258: / Line 281: @@
 === <code>reticleColorTargetSenstive</code> ===
 {{oolite-prop-added|1.85}}
  '''reticleColorTargetSensitive''' : Color specifier (read/write)
 Gets/sets the color used to highlight a target on the HUD when it is lined up (the <code>reticleTargetSensitive</code> property must be true).
@@ Line 265: / Line 289: @@
 === <code>reticleColorWormhole</code> ===
 {{oolite-prop-added|1.85}}
  '''reticleColorWormhole''' : Color specifier (read/write)
 Gets/sets the color used to highlight a wormhole on the HUD.

@@ Line 170: / Line 170: @@
  '''manifest''' : [[Oolite JavaScript Reference: Manifest|Manifest]] (read/write)
 The manifest contains all the cargo the player carries. It can be addressed as a property of playerShip as well as a class [[Oolite JavaScript Reference: Manifest|Manifest]] of its own.
 === <code>maxAftShield</code> ===

@@ Line 187: / Line 187: @@
  '''missilesOnline''' : Boolean (read-only)
 True if the ship's targeting system is currently in missile targeting mode, false if it is currently in identification mode.
 === <code>multiFunctionDisplayList</code> ===
@@ Line 233: / Line 243: @@
  '''renovationMultiplier''' : Number (read-only, positive)
 The multiplier applied to the base cost of renovation (<code>renovationCost</code> already includes this multiplier) to allow for some ships being more difficult to maintain than others. The default is 1.0 - other values are set in [[Shipyard.plist#renovation_multiplier|shipyard.plist]]
 === <code>reticleTargetSensitive</code> ===

@@ Line 200: / Line 200: @@
  '''multiFunctionDisplays''' : Number (read-only, integer)
 The number of multi-function displays available on the current HUD.
 === <code>price</code> ===
@@ Line 260: / Line 271: @@
 === <code>targetSystem</code> ===
  '''targetSystem''' : Integer (read-only, sometimes read/write in 1.77)
-The ID of the selected hyperspace target system. In 1.77, it can be written to if the player's ship is docked.
+The ID of the selected hyperspace target system. In 1.77, it can be written to if the player's ship is docked. The target system is the final destination system if the player has a multi-jump course plotted on the galactic chart.
 === <code>torusEngaged</code> ===

@@ Line 43: / Line 43: @@
 === <code>compassType</code> ===
  '''compassType''' : String (read-only in 1.84 and earlier, read/write in 1.85 and later)
-Sets or returns the current space compass type, which can be one of the following:
+Gets/sets the current space compass type, which can be one of the following:
 * OO_COMPASSTYPE_BASIC
 * OO_COMPASSTYPE_ADVANCED

@@ Line 39: / Line 39: @@
 === <code>compassTarget</code> ===
  '''compassTarget''' : Entity(read-only in 1.84 and earlier, read/write in 1.85 and later)
-Points at the entity currently targeted by the compass. When setting this value, the entity must be valid, and have a compass beacon.
+Gets/sets the entity currently targeted by the compass. When setting this value, the entity must be valid, and have a compass beacon.
 === <code>compassType</code> ===

@@ Line 29: / Line 29: @@
 === <code>compassMode</code> ===
  '''compassMode''' : String (read-only in 1.84 and earlier, read/write in 1.85 and later)
-Sets or returns the current compass mode, which can be any one of the following:
+Gets/sets the current compass mode, which can be any one of the following:
 * COMPASS_MODE_BASIC
 * COMPASS_MODE_PLANET