Oolite JavaScript Reference: Player - Revision history

Cholmondely: Tweaks

2026-05-01T04:05:50Z

Tweaks

Wildeblood: /* audioMessage */

2026-04-02T05:07:38Z

‎audioMessage

Cholmondely: /* Some OXP items */ Added disclaimer

2026-03-13T10:49:03Z

‎Some OXP items: Added disclaimer

Cholmondely: /* consoleMessage */ Added note about distance from Jaguar Company versions page

2025-12-15T09:15:51Z

‎consoleMessage: Added note about distance from Jaguar Company versions page

Phkb at 00:42, 18 August 2025

2025-08-18T00:42:00Z

Wildeblood: /* Some OXP items */

2025-07-27T05:42:44Z

‎Some OXP items

Phkb: Updating BB links

2024-02-29T02:19:06Z

Updating BB links

Cholmondely: /* addMessageToArrivalReport */ Added link

2024-01-16T11:18:18Z

‎addMessageToArrivalReport: Added link

Phkb: /* escapePodRescueTime */

2023-09-19T09:37:41Z

‎escapePodRescueTime

Cholmondely: Added some OXP items (LitF & Random Hits)

2023-03-04T21:16:32Z

Added some OXP items (LitF & Random Hits)

@@ Line 217: / Line 217: @@
 == Some OXP items ==
-This listing does not include matter from the [[GalCop Missions]] OXP, [[Library OXP]], et cetera, et cetera.
+This listing does not include matter from the [[GalCop Missions]] OXP, [[Library OXP]], [[Feudal States]] OXP, et cetera, et cetera.
 === <code>missionVariables.random_hits_criminal_hate_score</code> ===
 Added by [[Random Hits OXP]] - seems to be (to this dumb pilot) a measure of the extent to which criminals wish to attack the player
@@ Line 253: / Line 253: @@
 :if (sta <= -75) { desc = "loyal with criminals"; }
 :if (sta <= -200) { desc = "respectful of the laws of the criminal underworld";
 [[Category:Oolite JavaScript Reference]]

@@ Line 121: / Line 121: @@
 === <code>audioMessage</code> ===
 {{oolite-method-added|1.84}}
 Reads out an audio message without displaying anything on the screen. The Spoken Messages option must be on.

@@ Line 216: / Line 216: @@
 == Some OXP items ==
 === <code>missionVariables.random_hits_criminal_hate_score</code> ===
 Added by [[Random Hits OXP]] - seems to be (to this dumb pilot) a measure of the extent to which criminals wish to attack the player

@@ Line 138: / Line 138: @@
   function '''consoleMessage'''(message : String [, duration: Number])
 Displays the specified message as a console message, that is, as a message on the HUD. The optional <code>duration</code> parameter determines how long the message should be displayed before fading out. It is clamped to the range [1, 10]. If no duration is specified, 3 seconds will be used.
 '''See also''': [https://bb.oolite.space/viewtopic.php?f=4&t=10880 Formatting text msgs on a HUD] (2011)

@@ Line 118: / Line 118: @@
 '''See also''': <code>[[Oolite JavaScript Reference: Station#suppressArrivalReports|station.suppressArrivalReports]]</code>, [https://bb.oolite.space/viewtopic.php?f=4&t=12519 Arrival Reports] (2012)
 === <code>commsMessage</code> ===
@@ Line 124: / Line 131: @@
 '''Example:'''
-  player.commsMessage("Hello, cruel universe.", 6)
+  player.commsMessage("Hello, cruel universe.", 6);
 NB, this <code>commsMessage()</code> is a method of the <code>player</code> object.  <code>player.ship</code> can also have a <code>[[Oolite_JavaScript_Reference:_Ship#commsMessage|commsMessage()]]</code> method, but that belongs to the ship and has a different second parameter.
 *[https://bb.oolite.space/viewtopic.php?f=4&t=10880 Formatting text msgs on a HUD] (2011)
@@ Line 178: / Line 185: @@
 '''See also:''' <code>[[#passengerReputation|passengerReputation]]</code>, <code>[[#decreasePassengerReputation|decreasePassengerReputation()]]</code>
 === <code>setEscapePodDestination</code> ===
@@ Line 190: / Line 206: @@
 '''See also:''' <code>[[#roleWeights|roleWeights]]</code>
-=== <code>replaceShip</code> ===
+=== <code>stopAudioMessage</code> ===
-{{Oolite-method-added|1.77}}
+{{oolite-method-added|1.84}}
- function '''replaceShip'''(dataKey [, personality])
+Stops the currently playing audio message.
-<code>personality</code> is optional, and can be between 0 and 32767. The new ship is given that specific [[Oolite_JavaScript_Reference:_Ship#entityPersonality|entityPersonality]], which for some ships may affect its appearance with shaders.
+'''Example:'''
 == Some OXP items ==

← Older revision		Revision as of 05:42, 27 July 2025
Line 237:		Line 237:

	[[Category:Oolite JavaScript Reference]]		[[Category:Oolite JavaScript Reference]]
		+
		+	== AI version ==
		+	See also: [[Oolite JavaScript Reference: Player (AI Readable Version)]]

@@ Line 65: / Line 65: @@
   '''legalStatus''' : String (read-only)
 A string mainly for display purposes describing the player’s legal status based on <code>[[#bounty|bounty]]</code>. In English, this is one of <code>"Clean"</code> (bounty = 0), <code>"Offender"</code> (0 < bounty ≤ 50) or <code>"Fugitive"</code>, but note that it can be localized.<br>
-See [http://aegidian.org/bb/viewtopic.php?p=30692#p30692 this] - and several later posts - for more detail. '''setLegalStatus: <number>''' works in legacy script - it might also work in Javascript! <br>
+See [https://bb.oolite.space/viewtopic.php?p=30692#p30692 this] - and several later posts - for more detail. '''setLegalStatus: <number>''' works in legacy script - it might also work in Javascript! <br>
 See [[Bounty]] for a (partial?) list of OXPs affecting this.
@@ Line 117: / Line 117: @@
 Adds a message to the arrival report shown immediately after docking. Oolite puts its own stuff on the list immediately after [[Oolite JavaScript Reference: World script event handlers#shipWillDockWithStation|shipWillDockWithStation]] so this is a good moment to add the messages when you know what station will be docked.  [[Oolite JavaScript Reference: World script event handlers#shipDockedWithStation|shipDockedWithStation]] may also be used.  Messages added while in flight or during shipWillDockWithStation will be above Oolite's own arrival messages.  Those added during shipDockedWithStation will be below Oolite's own arrival messages.
-'''See also''': <code>[[Oolite JavaScript Reference: Station#suppressArrivalReports|station.suppressArrivalReports]]</code>, [http://www.aegidian.org/bb/viewtopic.php?f=4&t=12519 Arrival Reports] (2012)
+'''See also''': <code>[[Oolite JavaScript Reference: Station#suppressArrivalReports|station.suppressArrivalReports]]</code>, [https://bb.oolite.space/viewtopic.php?f=4&t=12519 Arrival Reports] (2012)
 === <code>commsMessage</code> ===
@@ Line 126: / Line 126: @@
   player.commsMessage("Hello, cruel universe.", 6)
 NB, this <code>commsMessage()</code> is a method of the <code>player</code> object.  <code>player.ship</code> can also have a <code>[[Oolite_JavaScript_Reference:_Ship#commsMessage|commsMessage()]]</code> method, but that belongs to the ship and has a different second parameter.
-*[http://aegidian.org/bb/viewtopic.php?f=4&t=10880 Formatting text msgs on a HUD] (2011)
+*[https://bb.oolite.space/viewtopic.php?f=4&t=10880 Formatting text msgs on a HUD] (2011)
 === <code>consoleMessage</code> ===
@@ Line 132: / Line 132: @@
 Displays the specified message as a console message, that is, as a message on the HUD. The optional <code>duration</code> parameter determines how long the message should be displayed before fading out. It is clamped to the range [1, 10]. If no duration is specified, 3 seconds will be used.
-'''See also''': [http://aegidian.org/bb/viewtopic.php?f=4&t=10880 Formatting text msgs on a HUD] (2011)
+'''See also''': [https://bb.oolite.space/viewtopic.php?f=4&t=10880 Formatting text msgs on a HUD] (2011)
 === <code>decreaseContractReputation</code> ===

@@ Line 58: / Line 58: @@
 === <code>escapePodRescueTime</code> ===
 {{oolite-prop-added|1.89}}
-  '''escapePodRescueTime''' : Number (read-write decimal)
+  '''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 add up to eight days to the clock.
 Negative numbers will be ignored (and default calculation will apply).

← Older revision		Revision as of 21:16, 4 March 2023
Line 198:		Line 198:

	<code>personality</code> is optional, and can be between 0 and 32767. The new ship is given that specific [[Oolite_JavaScript_Reference:_Ship#entityPersonality\|entityPersonality]], which for some ships may affect its appearance with shaders.		<code>personality</code> is optional, and can be between 0 and 32767. The new ship is given that specific [[Oolite_JavaScript_Reference:_Ship#entityPersonality\|entityPersonality]], which for some ships may affect its appearance with shaders.
		+
		+	== Some OXP items ==
		+	=== <code>missionVariables.random_hits_criminal_hate_score</code> ===
		+	Added by [[Random Hits OXP]] - seems to be (to this dumb pilot) a measure of the extent to which criminals wish to attack the player
		+	:if (hate < 5) rank = "an innocent fighter"
		+	:else if (hate < 25) rank = "an annoyance"
		+	:else if (hate < 50) rank = "a "+expandDescription("[random_hits_notwelcome_para3e]")+" pilot"
		+	:else if (hate < 70) rank = "a target that must be "+expandDescription("[random_hits_complete2]")
		+	:else if (hate < 90) rank = "on their top ten hit list of "+expandDescription("[random_hits_notwelcome_para3e]")+" pilots"
		+
		+	=== <code>_litf.LITF_cmdStats.health</code> ===
		+	Added by [[Life in the Frontier]] - a health rating (wounds, bruises ''etc''.)
		+
		+	=== <code>_litf.LITF_cmdStats.sickness</code> ===
		+	Added by [[Life in the Frontier]] - a sickness rating
		+
		+	=== <code>_litf.LITF_cmdStats.strength</code> ===
		+	Added by [[Life in the Frontier]] - a strength rating (physical shape, fitness)
		+
		+	=== <code>_litf.LITF_cmdStats.reputation</code> ===
		+	Added by [[Life in the Frontier]] - a reputation rating (from unknown to legendary)
		+
		+	=== <code>_litf.LITF_cmdStats.stance</code> ===
		+	Added by [[Life in the Frontier]] - a political rating
		+
		+	:if (sta == 0) { desc = "absolutely neutral"; }
		+	:if (sta < 5 && sta > -5) { desc = "generally neutral"; }
		+
		+	:if (sta >= 5) { desc = "sympathetic with GalCop"; }
		+	:if (sta >= 25) { desc = "friendly with GalCop"; }
		+	:if (sta >= 75) { desc = "loyal with GalCop"; }
		+	:if (sta >= 200) { desc = "sworn to act along the rules of GalCop"; }
		+
		+	:if (sta <= -5) { desc = "sympathetic with criminals"; }
		+	:if (sta <= -25) { desc = "friendly with criminals"; }
		+	:if (sta <= -75) { desc = "loyal with criminals"; }
		+	:if (sta <= -200) { desc = "respectful of the laws of the criminal underworld";

	[[Category:Oolite JavaScript Reference]]		[[Category:Oolite JavaScript Reference]]