Oolite JavaScript Reference: Ship - Revision history

Hiran at 20:21, 11 July 2021

2021-07-11T20:21:52Z

Norby: /* cargoList */

2016-08-22T10:09:41Z

‎cargoList

Debresser: Page moved. No need for _ in links.

2016-01-16T20:37:23Z

Page moved. No need for _ in links.

Debresser: Use capitals.

2016-01-16T20:24:25Z

Use capitals.

Norby: /* crew */

2015-10-21T14:09:37Z

‎crew

Norby: /* setCrew */

2015-10-21T14:05:00Z

‎setCrew

Norby: /* beaconLabel */

2015-10-11T23:11:51Z

‎beaconLabel

Cim: /* weaponPosition* */ 1.83 format change

2015-08-23T19:59:11Z

‎weaponPosition*: 1.83 format change

Cim: /* equipmentStatus */ 1.81 notes

2015-07-09T17:07:20Z

‎equipmentStatus: 1.81 notes

Cim: /* entityPersonality */ writable in 1.81

2015-04-25T13:43:43Z

‎entityPersonality: writable in 1.81

@@ Line 213: / Line 213: @@
  '''displayName''' : String (read/write, read-only for player)
 The name of the ship as seen by the player. By default in 1.78 or earlier it is the same as <code>[[#name|name]]</code>. In 1.79 or later it is a combination of [[#shipClassName|shipClassName]] and [[#shipUniqueName|shipUniqueName]]
 === <code>dockingInstructions</code> ===

@@ Line 100: / Line 100: @@
  '''cargoList''' : Array (read-only)
 A list of the ship's current cargo, grouped by cargo type. For the player ship, this is equivalent to <code>player.ship.manifest.list</code>
 === <code>cargoSpaceCapacity</code> ===

@@ Line 60: / Line 60: @@
 The ship's current alert condition (Docked = 0, Green = 1, Yellow = 2, Red = 3). Non-Station non-Player ships are generally only found at condition Yellow or Red.
-'''See also:''' [[Oolite_JavaScript_Reference:_Station#alertCondition|station.alertCondition]]
+'''See also:''' [[Oolite JavaScript Reference: Station#alertCondition|station.alertCondition]]
 === <code>autoAI</code> ===
@@ Line 94: / Line 94: @@
 The bounty on the ship.
-In 1.77, changes to the bounty are given a reason. If you change this directly, the reason sent to [[Oolite_JavaScript_Reference:_ship_script_event_handlers#shipBountyChanged|shipBountyChanged]] will be "scripted". To set a different reason, use [[#setBounty|setBounty]] instead.
+In 1.77, changes to the bounty are given a reason. If you change this directly, the reason sent to [[Oolite JavaScript Reference: Ship script event handlers#shipBountyChanged|shipBountyChanged]] will be "scripted". To set a different reason, use [[#setBounty|setBounty]] instead.
 === <code>cargoList</code> ===
@@ Line 240: / Line 240: @@
 === <code>equipment</code> ===
- '''equipment''' : Array of [[Oolite_JavaScript_Reference:_EquipmentInfo|EquipmentInfo ]] (read-only)
+ '''equipment''' : Array of [[Oolite JavaScript Reference: EquipmentInfo|EquipmentInfo]] (read-only)
 The equipment a ship is carrying.
@@ Line 261: / Line 261: @@
 {{Oolite-prop-added|1.79}}
  '''exhausts''' : Array (read-only)
-An array of the ship's [[Oolite_JavaScript_Reference:_ExhaustPlume|ExhaustPlume]] subentities.
+An array of the ship's [[Oolite JavaScript Reference: ExhaustPlume|ExhaustPlume]] subentities.
 === <code>extraCargo</code> ===
@@ Line 271: / Line 271: @@
 {{Oolite-prop-added|1.79}}
  '''flashers''' : Array (read-only)
-An array of the ship's [[Oolite_JavaScript_Reference:_Flasher|Flasher]] subentities.
+An array of the ship's [[Oolite JavaScript Reference: Flasher|Flasher]] subentities.
 === <code>forwardWeapon</code> ===
@@ Line 859: / Line 859: @@
 Runs a fast scanner check and returns the results. At most 32 objects within scanner range will be returned. If the <code>poweredOnly</code> parameter is present and set to true, then only powered objects will be returned (i.e. ships with a scan class other than CLASS_CARGO or CLASS_ROCK).
-This method is usually considerably quicker than [[Oolite_JavaScript_Reference:_System#filteredEntities|system.filteredEntities()]] and similar methods, with little loss of accuracy, though it is still advisable to cache the result for a while before re-scanning.
+This method is usually considerably quicker than [[Oolite JavaScript Reference: System#filteredEntities|system.filteredEntities()]] and similar methods, with little loss of accuracy, though it is still advisable to cache the result for a while before re-scanning.
 === <code>clearDefenseTargets</code>===
@@ Line 1,176: / Line 1,176: @@
 {{oolite-method-added|1.77}}
  function '''setBounty'''(bounty : Number, reason : String)
-Sets the ship's bounty to the new value. <code>reason</code> will be sent to [[Oolite_JavaScript_Reference:_ship_script_event_handlers#shipBountyChanged|shipBountyChanged()]].
+Sets the ship's bounty to the new value. <code>reason</code> will be sent to [[Oolite JavaScript Reference: Ship script event handlers#shipBountyChanged|shipBountyChanged()]].
 '''See also:''' <code>[[#bounty|bounty]]</code>
@@ Line 1,205: / Line 1,205: @@
 You can therefore set a random seed or role to get particular behaviour, and use the other keys to override it.
-At the moment this function only sets the first crew member (the pilot of the ship) in [[Oolite_JavaScript_Reference:_Ship#crew|crew]][0] .
+At the moment this function only sets the first crew member (the pilot of the ship) in [[Oolite JavaScript Reference: Ship#crew|crew]][0] .
 === <code>setEquipmentStatus</code> ===

@@ Line 1,109: / Line 1,109: @@
 === <code>remove</code> ===
  function '''remove'''([suppressDeathEvent : Boolean])
-Immediately removes the ship from the universe. Works on all ships except the player, including the main station.<br>It generates a [[Oolite JavaScript Reference: ship script event handlers#shipRemoved|this.shipRemoved(suppressDeathEvent)]] event. By default it will also trigger a [[Oolite JavaScript Reference: ship script event handlers#shipDied|this.shipDied()]] event, unless <code>suppressDeathEvent</code> is true.
+Immediately removes the ship from the universe. Works on all ships except the player, including the main station.<br>It generates a [[Oolite JavaScript Reference: Ship script event handlers#shipRemoved|this.shipRemoved(suppressDeathEvent)]] event. By default it will also trigger a [[Oolite JavaScript Reference: Ship script event handlers#shipDied|this.shipDied()]] event, unless <code>suppressDeathEvent</code> is true.
 '''See also:''' <code>[[#explode|explode()]]</code>

@@ Line 146: / Line 146: @@
 {{oolite-prop-added|1.79}}
  '''crew''' : Array (read-only)
-An array containing the ship's crew. Each crew member is represented as a dictionary. Note that in current Oolite versions ships only have a single crew member defined.
+An array containing the ship's crew. Each crew member is represented as a dictionary:
 === <code>cruiseSpeed</code> ===

@@ Line 80: / Line 80: @@
 === <code>beaconLabel</code> ===
 {{oolite-prop-added|1.79}}
- '''beaconLabel''' : String (read/write)
+ '''beaconLabel''' : String (read/write, read-only for player)
 A full label for the beacon. This is useful where the beacon code and the full beacon label do not begin with the same letter.

@@ Line 748: / Line 748: @@
  '''weaponPositionPort''' : Vector (read-only)
  '''weaponPositionStarboard''' : Vector (read-only)
 The position relative to the ship at which the appropriate laser beam will start. These properties do not imply that the ship has or can have any such weapon.
 === <code>weaponRange</code> ===

@@ Line 906: / Line 906: @@
 === <code>equipmentStatus</code> ===
- function '''equipmentStatus'''(equipmentType : [[Oolite JavaScript Reference: EquipmentInfo#Equipment Expressions|equipmentInfoExpression]]) : String
+ function '''equipmentStatus'''(equipmentType : [[Oolite JavaScript Reference: EquipmentInfo#Equipment Expressions|equipmentInfoExpression]] [, multiple : Boolean]) : String or Object
 Tests whether the specified type of equipment is installed, and whether it is functioning. Returns one of the following strings: <code>"EQUIPMENT_OK"</code>, <code>"EQUIPMENT_DAMAGED"</code>, <code>"EQUIPMENT_UNAVAILABLE"</code> or <code>"EQUIPMENT_UNKNOWN"</code>.
 '''See also:''' <code>[[#setEquipmentStatus|setEquipmentStatus()]]</code>

@@ Line 222: / Line 222: @@
 === <code>entityPersonality</code> ===
- '''entityPersonality''' : Number (read-only integer)
+ '''entityPersonality''' : Number (read-only integer, read/write in 1.81 onwards)
 A random number in the range 0..32767 which is generated when the ship is created. Equivalent to the <code>entityPersonalityInt</code> [[Shaders in Oolite: uniforms#Ship|uniform binding]].
 === <code>equipment</code> ===