Oolite JavaScript Reference: Ship script event handlers - Revision history

Cholmondely: Added Links

2021-10-24T13:38:35Z

Added Links

2020-06-20T02:40:24Z

add information about damage type for shipTakingDamage

2018-01-25T02:06:29Z

‎shipCloakDeactivated

2018-01-25T02:02:06Z

2018-01-10T23:47:00Z

2018-01-10T23:41:53Z

‎shipHitByECM

2018-01-10T23:40:15Z

‎stationWithdrewDockingClearance

2018-01-10T23:40:02Z

‎shipWitchspaceBlocked

2018-01-10T23:39:44Z

‎defenseTargetDestroyed

2018-01-10T23:39:24Z

‎shipWitchspaceBlocked

← Older revision		Revision as of 13:38, 24 October 2021
Line 852:		Line 852:

	'''See also:''' [[Oolite JavaScript Reference: World script event handlers\|world script event handlers]]		'''See also:''' [[Oolite JavaScript Reference: World script event handlers\|world script event handlers]]
		+
		+	----
		+	== Links ==
		+	*[http://www.aegidian.org/bb/viewtopic.php?f=4&t=3865 distant effects of a ship's mass or energy?] - analysis of '''collisions''' at vast distance back in 2007.

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

@@ Line 395: / Line 395: @@
 The <code>shipTakingDamage</code> handler is called when a ship sustains damage.<br>
-It transfers the <code>amount</code> of damage, <code>who</code> caused the damage and the <code>type</code> of damage.
+It transfers the <code>amount</code> of damage, <code>who</code> caused the damage and a string indicating the <code>type</code> of damage:
 For the player ship, only damage not absorbed by the shields will appear in <code>amount</code>, but the handler will be called anyway with zero as the amount if the shields absorb all the damage.

@@ Line 280: / Line 280: @@
 The <code>shipCloakDeactivated</code> handler is called whenever the script's target ship deactivates its cloaking device. No parameters are required for this handler.
-  this.shipCloakDectivated = function()
+  this.shipCloakDeactivated = function()
+  {
      // Your code here

@@ Line 210: / Line 210: @@
 ==== <code>shipAttackedOther</code> ====
  this.shipAttackedOther = function(other)
@@ Line 264: / Line 266: @@
 ==== <code>shipCloakActivated</code> ====
-The <code>shipCloakActivated</code> handler is called whenever the script's target ship activates its cloaking device. No parameters are required for this handler (added in test version 1.74).
+The <code>shipCloakActivated</code> handler is called whenever the script's target ship activates its cloaking device. No parameters are required for this handler.
   this.shipCloakActivated = function()
@@ Line 273: / Line 276: @@
 ==== <code>shipCloakDeactivated</code> ====
-The <code>shipCloakDeactivated</code> handler is called whenever the script's target ship deactivates its cloaking device. No parameters are required for this handler (added in test version 1.74).
+The <code>shipCloakDeactivated</code> handler is called whenever the script's target ship deactivates its cloaking device. No parameters are required for this handler.
   this.shipCloakDectivated = function()

@@ Line 320: / Line 320: @@
 ==== <code>shipHitByECM</code> ====
-The <code>shipHitByECM</code> handler is called when a ship receives a ECM pulse. <code>pulsesRemaining</code> contains the number of pulses that still have to be send by the sending ship. When a ship activates his ecm, he will send 4 pulses with 0.5 seconds interval and increasing range.: 6400 --> 12800 --> 19200 --> 25600. (Handler added in test version 1.71)
+The <code>shipHitByECM</code> handler is called when a ship receives a ECM pulse. <code>pulsesRemaining</code> contains the number of pulses that still have to be send by the sending ship. When a ship activates his ecm, he will send 4 pulses with 0.5 seconds interval and increasing range.: 6400 --> 12800 --> 19200 --> 25600.
  this.shipHitByECM = function(pulsesRemaining)

@@ Line 53: / Line 53: @@
 ==== <code>stationWithdrewDockingClearance</code> ====
-{{oolite-method-added|1.79}}<br/>
+{{oolite-method-added|1.79}}
 The <code>stationWithdrewDockingClearance</code> handler is received when the station the ship is trying to dock with unexpectedly withdraws clearance (e.g. if <code>station.abortAllDockings</code> is called).

@@ Line 92: / Line 92: @@
 ==== <code>shipWitchspaceBlocked</code> ====
-{{oolite-method-added|1.79}}<br/>
+{{oolite-method-added|1.79}}
 The <code>shipWitchspaceBlocked</code> handler is called when a ship is prevented from entering witchspace by the presence of a nearby large mass. The blocking object is passed as a parameter

@@ Line 180: / Line 180: @@
 ==== <code>defenseTargetDestroyed</code> ====
 {{oolite-method-added|1.79}}
 The <code>defenseTargetDestroyed</code> handler is sent when a defense (i.e. secondary) target is destroyed. A reference to the destroyed ship (which will become invalid shortly) is passed as a parameter.