Oolite JavaScript Reference: Player - Revision history

Hiran: /* ship */

2021-07-11T20:19:13Z

‎ship

Hiran at 20:18, 11 July 2021

2021-07-11T20:18:07Z

Phkb: /* escapePodRescueTime */

2020-07-20T12:52:30Z

‎escapePodRescueTime

Phkb at 12:51, 20 July 2020

2020-07-20T12:51:47Z

Phkb at 12:47, 20 July 2020

2020-07-20T12:47:21Z

Phkb at 22:42, 1 May 2019

2019-05-01T22:42:30Z

Phkb: /* setEscapePodDestination */

2017-03-13T03:33:36Z

‎setEscapePodDestination

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

2016-01-16T20:49:18Z

Page moved. No need for _ in links.

Cim: /* credits */ fix type

2014-12-22T14:36:56Z

‎credits: fix type

Cim: /* Methods */ endScenario

2014-03-29T21:08:26Z

‎Methods: endScenario

@@ Line 103: / Line 103: @@
 === <code>ship</code> ===
- '''ship''' : Ship
+ '''ship''' : [[Oolite_JavaScript_Reference:_Ship | Ship]]
 The player’s ship

@@ Line 101: / Line 101: @@
  '''score''' : Number (read/write, integer)
 The player’s score; nominally the number of kills the player has made, although some missions award additional points.
 === <code>trumbleCount</code> ===

@@ Line 59: / Line 59: @@
 {{oolite-prop-added|1.89}}
  '''escapePodRescueTime''' : Number (read-write decimal)
-Number of seconds that will be added to the clock when the player uses an escape pod and is rescued. Default value is 0 (zero), which will utilise the default time calculation that can be up to eight days later.
+Number of seconds that will be added to the clock when the player uses an escape pod and is rescued. Default value is 0 (zero), which will utilise the default time calculation that can add up to eight days to the clock.
 Negative numbers will be ignored (and default calculation will apply).

@@ Line 57: / Line 57: @@
 === <code>escapePodRescueTime</code> ===
 {{oolite-prop-added|1.89}}
 Number of seconds that will be added to the clock when the player uses an escape pod and is rescued. Default value is 0 (zero), which will utilise the default time calculation that can be up to eight days later.
 Negative numbers will be ignored (and default calculation will apply).

@@ Line 55: / Line 55: @@
 * <code>"DOCKING_CLEARANCE_STATUS_GRANTED"</code>
 * <code>"DOCKING_CLEARANCE_STATUS_TIMING_OUT"</code>
 === <code>legalStatus</code> ===

@@ Line 173: / Line 173: @@
 {{Oolite-method-added|1.77}}
  function '''replaceShip'''(dataKey [, personality])
-This method can only be called while the player is docked at a station. It discards the player's current ship (including all cargo, passenger contracts, and equipment), and replaces it with the ship defined by the shipyard.plist entry <code>dataKey</code> (obviously the key must also be defined in shipyard.plist as a valid player ship). The new ship will have all standard equipment for a ship of that type, and any equipment from the previous ship which was [[Oolite JavaScript Reference: EquipmentInfo#isPortableBetweenShips|isPortableBetweenShips]]. While this may not necessarily be a ship purchase, the [[Oolite JavaScript Reference: World script event handlers#playerBoughtNewShip|playerBoughtNewShip]] will fire to notify other scripts of the change.
+This method can only be called while the player is docked at a station. It discards the player's current ship (including all cargo, passenger contracts, and equipment), and replaces it with the ship defined by the shipyard.plist entry <code>dataKey</code> (obviously the key must also be defined in shipyard.plist as a valid player ship). The new ship will have all standard equipment for a ship of that type, and any equipment from the previous ship which was [[Oolite JavaScript Reference: EquipmentInfo#isPortableBetweenShips|isPortableBetweenShips]]. While this may not necessarily be a ship purchase, the [[Oolite JavaScript Reference: World script event handlers#playerBoughtNewShip|playerBoughtNewShip]] will fire to notify other scripts of the change, although this event is being deprecated in favour of [[Oolite JavaScript Reference: World script event handlers#playerReplacedShip|playerReplacedShip]], which was added in Oolite Test Release 1.89.
 If the dataKey was not defined in both shipdata.plist and shipyard.plist, or the player is in flight, this method does nothing.

@@ Line 161: / Line 161: @@
 === <code>setEscapePodDestination</code> ===
  function '''setEscapePodDestination'''(destination)
-This method can only be called after the player has launched an escape pod – for example, from the <code>escapePodSequenceOver()</code> event handler. It determines where the player will end up. <code>destination</code> may be any carrier/station entity, or the string <code>"NEARBY_SYSTEM"</code>, or <code>null</code>. If it is <code>"NEARBY_SYSTEM"</code>, the player will end up at the main station in a random nearby system. If it is <code>null</code>, the player will die of life support failure. (<code>null</code> is the default in interstellar space.)
+This method can only be called after the player has launched an escape pod – for example, from the [[Oolite_JavaScript_Reference:_World_script_event_handlers#escapePodSequenceOver|<code>escapePodSequenceOver()</code>]] event handler. It determines where the player will end up. <code>destination</code> may be any carrier/station entity, or the string <code>"NEARBY_SYSTEM"</code>, or <code>null</code>. If it is <code>"NEARBY_SYSTEM"</code>, the player will end up at the main station in a random nearby system. If it is <code>null</code>, the player will die of life support failure. (<code>null</code> is the default in interstellar space.)
 === <code>setPlayerRole</code> ===

@@ Line 44: / Line 44: @@
 === <code>credits</code> ===
- '''credits''' : Number (read/write, integer)
+ '''credits''' : Number (read/write, float)
-The amount of money the player has.
+The amount of money the player has, in credits.
 === <code>dockingClearanceStatus</code> ===

← Older revision		Revision as of 21:08, 29 March 2014
Line 132:		Line 132:

	'''See also:''' <code>[[#passengerReputation\|passengerReputation]]</code>, <code>[[#increasePassengerReputation\|increasePassengerReputation()]]</code>		'''See also:''' <code>[[#passengerReputation\|passengerReputation]]</code>, <code>[[#increasePassengerReputation\|increasePassengerReputation()]]</code>
		+
		+	=== <code>endScenario</code> ===
		+	{{oolite-method-added\|1.79}}
		+	function '''endScenario'''(key : String)
		+	End the current game immediately and return to the start game screen. Returns true if it succeeds (though this will shortly be irrelevant), and false if it fails, which it will do if the key passed in is not the same as the [[scenarios.plist\|scenario key]] in the current game scenario. If the current game scenario has no scenario key, this method will always fail.
		+
		+	There is no way to find out what, if any, the current scenario key is. If you are calling this function, you should be doing so in a context where you already know what it is.

	=== <code>increaseContractReputation</code> ===		=== <code>increaseContractReputation</code> ===