Oolite JavaScript Reference: World script event handlers - Revision history

Milo: minor elaboration

2020-06-24T12:50:58Z

minor elaboration

2020-06-24T11:58:30Z

playerStartedAutoPilot is called with an argument

2019-05-02T00:37:03Z

‎playerBoughtNewShip

2019-05-02T00:35:57Z

‎playerWillReplaceShip

2019-05-02T00:35:20Z

‎playerReplacedShip

2019-05-02T00:34:47Z

‎playerWillBuyNewShip

2019-05-02T00:33:39Z

‎playerBoughtNewShip

2019-05-01T22:56:41Z

2019-05-01T22:41:59Z

2019-05-01T22:38:36Z

@@ Line 96: / Line 96: @@
 ==== <code>shipLaunchedFromStation</code> ====
-The <code>shipLaunchedFromStation</code> handler is called at the end of the launch tunnel effect.
+The <code>shipLaunchedFromStation</code> handler is called at the end of the launch tunnel effect. The argument passed to the handler function is the station entity from which the ship was launched.
- this.shipLaunchedFromStation = function(station)
+ this.shipLaunchedFromStation = function(stationLaunchedFrom)
+ {
       // Your code here
+ }
 At this moment "ship.dockedStation == null", "ship.docked == false", "ship.status == STATUS_IN_FLIGHT".

@@ Line 106: / Line 106: @@
 ==== <code>playerStartedAutoPilot</code> ====
-The <code>playerStartedAutoPilot</code> handler is called when the player starts autopilot docking. It is not called for the instantaneous dock command.
+The <code>playerStartedAutoPilot</code> handler is called when the player starts autopilot docking. It is not called for the instantaneous dock command. The handler is called with an argument containing the station entity that is the docking target.
- this.playerStartedAutoPilot = function()
+ this.playerStartedAutoPilot = function(stationForDocking)
+ {
       // Your code here
+ }
 ==== <code>playerCancelledAutoPilot</code> ====

@@ Line 572: / Line 572: @@
 The 'price' parameter is added from 1.81 onwards. It is the cost of the ship (not counting any trade-in value of the player's old ship) in credits, or zero for changes using [[Oolite JavaScript Reference: Player#replaceShip|<code>player.replaceShip</code>]]
-'''Note:''' In a future release of Oolite, <code>playerBoughtNewShip</code> will no longer be fired when the ship is replaced using the [[Oolite JavaScript Reference: Player#replaceShip|<code>player.replaceShip</code>]] function. Instead, the <code>[[#playerReplacedShip|playerReplacedShip]]</code> event should be used.
+'''Note:''' In a future release of Oolite, <code>playerBoughtNewShip</code> will no longer be fired when the ship is replaced using the [[Oolite JavaScript Reference: Player#replaceShip|<code>player.replaceShip</code>]] function. Instead, the <code>[[#playerReplacedShip|playerReplacedShip]]</code> event should be used. At the moment, both events (<code>playerBoughtNewShip</code> and <code>playerReplacedShip</code>) will fire.
 '''See also:''' <code>[[#playerWillBuyNewShip|playerWillBuyNewShip]]</code>

@@ Line 668: / Line 668: @@
+ }
-dataKey is the shipdata.plist <code>dataKey</code> for the ship being purchased.
+<code>dataKey</code> is the shipdata.plist <code>dataKey</code> for the ship being purchased.
 === Other ===

@@ Line 595: / Line 595: @@
       // Your code here
+ }
 ==== <code>playerSoldCargo</code> ====

@@ Line 635: / Line 635: @@
+ }
-dataKey is the shipdata.plist <code>dataKey</code> for the ship being purchased.
+<code>dataKey</code> is the shipdata.plist <code>dataKey</code> for the ship being purchased.
-shipyard is a dictionary object containing details about the ship being purchased, with information similar to the following:
+<code>shipyard</code> is a dictionary object containing details about the ship being purchased, with information similar to the following:
+ {
     short_description: "Python: Plus Galactic Hyperdrive. Extra Energy Unit. Docking Computers. E.C.M. System. Forward weapon upgraded to military laser. Price 215 000 ₢.",
@@ Line 650: / Line 650: @@
+ }
-price is the amount being paid the for ship.
+<code>price</code> is the amount being paid the for ship.
-tradeIn is the trade in value of the current ship.
+<code>tradeIn</code> is the trade in value of the current ship.
 ==== <code>playerWillReplaceShip</code> ====

← Older revision		Revision as of 00:33, 2 May 2019
Line 573:		Line 573:

	'''Note:''' In a future release of Oolite, <code>playerBoughtNewShip</code> will no longer be fired when the ship is replaced using the [[Oolite JavaScript Reference: Player#replaceShip\|<code>player.replaceShip</code>]] function. Instead, the <code>[[#playerReplacedShip\|playerReplacedShip]]</code> event should be used.		'''Note:''' In a future release of Oolite, <code>playerBoughtNewShip</code> will no longer be fired when the ship is replaced using the [[Oolite JavaScript Reference: Player#replaceShip\|<code>player.replaceShip</code>]] function. Instead, the <code>[[#playerReplacedShip\|playerReplacedShip]]</code> event should be used.
		+
		+	'''See also:''' <code>[[#playerWillBuyNewShip\|playerWillBuyNewShip]]</code>

	==== <code>playerChangedPrimedEquipment</code> ====		==== <code>playerChangedPrimedEquipment</code> ====

@@ Line 554: / Line 554: @@
 The <code>playerBoughtEquipment</code> handler is called when equipment is bought at the outfit screen.
- this.playerBoughtEquipment = function(equipment)
+ this.playerBoughtEquipment = function(equipment, paid)
+ {
       // Your code here
+ }
 ==== <code>playerBoughtNewShip</code> ====

@@ Line 626: / Line 626: @@
 The <code>playerWillBuyNewShip</code> handler is called just before a new ship is bought. May be needed to re-evaluate the old equipment as buying a new ship does not trigger equipment removal.
- this.playerWillBuyNewShip = function(shipKey, shipyard, price, tradeIn)
+ this.playerWillBuyNewShip = function(dataKey, shipyard, price, tradeIn)
+ {
       // Your code here
+ }
-shipKey is the shipdata key for the ship being purchased.
+dataKey is the shipdata.plist <code>dataKey</code> for the ship being purchased.
 shipyard is a dictionary object containing details about the ship being purchased, with information similar to the following:
@@ Line 655: / Line 655: @@
 The <code>playerWillReplaceShip</code> handler is called just before a ship is replaced using the [[Oolite JavaScript Reference: Player#replaceShip|<code>player.replaceShip</code>]] function. May be needed to re-evaluate the old equipment as buying a new ship does not trigger equipment removal.
- this.playerWillReplaceShip = function(shipKey)
+ this.playerWillReplaceShip = function(dataKey)
+ {
       // Your code here
+ }
-shipKey is the shipdata key for the ship being purchased.
+dataKey is the shipdata.plist <code>dataKey</code> for the ship being purchased.

@@ Line 568: / Line 568: @@
+ }
-The 'price' parameter is added from 1.81 onwards. It is the cost of the ship (not counting any trade-in value of the player's old ship) in credits, or zero for changes using [[Oolite JavaScript Reference: Player#replaceShip|player.replaceShip]]
+The 'price' parameter is added from 1.81 onwards. It is the cost of the ship (not counting any trade-in value of the player's old ship) in credits, or zero for changes using [[Oolite JavaScript Reference: Player#replaceShip|<code>player.replaceShip</code>]]
 ==== <code>playerChangedPrimedEquipment</code> ====
@@ Line 576: / Line 576: @@
  this.playerChangedPrimedEquipment = function(equipmentKey)
+ {
       // Your code here
@@ Line 608: / Line 618: @@
       // Your code here
+ }
 === Other ===