Handling OXP Dependencies with JavaScript - Revision history

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

2016-01-16T20:31:34Z

Page moved. No need for _ in links.

PG1 at 08:39, 3 December 2010

2010-12-03T08:39:59Z

PG1 at 16:47, 7 November 2010

2010-11-07T16:47:53Z

PG1 at 16:44, 7 November 2010

2010-11-07T16:44:32Z

PG1 at 11:18, 7 November 2010

2010-11-07T11:18:13Z

PG1: /* Solution */

2010-11-07T01:11:50Z

‎Solution

PG1 at 00:59, 7 November 2010

2010-11-07T00:59:47Z

PG1: /* Solution */

2010-11-07T00:52:44Z

‎Solution

PG1: /* Solution */

2010-11-06T22:38:33Z

‎Solution

PG1: /* Solution */

2010-11-06T22:37:28Z

‎Solution

@@ Line 93: / Line 93: @@
 }</pre>
-Choose the appropriate names for the eventName (see [[Oolite_JavaScript_Reference:_ship_script_event_handlers|Ship Script Event Handlers]] or [[Oolite_JavaScript_Reference:_world_script_event_handlers|World Script Event Handlers]]), eventTimer and funcToRun, and now many seconds to wait (secondsToWait) before it launches (usually about 1 second).
+Choose the appropriate names for the eventName (see [[Oolite JavaScript Reference: Ship script event handlers|Ship Script Event Handlers]] or [[Oolite JavaScript Reference: World script event handlers|World Script Event Handlers]]), eventTimer and funcToRun, and now many seconds to wait (secondsToWait) before it launches (usually about 1 second).
 == See Also ==

@@ Line 77: / Line 77: @@
 ===The Issue===
-There are also times when you will want for a particular event the code from your OXP to run after the code from another OXP. The method chosen aboved for loading can not be used for events as deleting the function will mean the event code will work once and the next time the event is triggered there is no code to call. This issue therefore requires another solution.
+There are also times when you will want for a particular event the code from your OXP to run after the code from another OXP. The method chosen above for loading can not be used for events as deleting the function will mean the event code will work once and the next time the event is triggered there is no code to call. This issue therefore requires another solution.
 ===Solution===

@@ Line 49: / Line 49: @@
       function runOtherStartUp(s) {
 	if (worldScripts[s].startUp) worldScripts[s].startUp(); // Call the other startUp.
-	if (worldScripts[s].startUp) delete worldScripts[s].startUp; // Make sure the other startUp is deleted as it may not be written using this template.
+	if (worldScripts[s].startUp) delete worldScripts[s].startUp; // Make sure the other startUp is deleted as it may not be written using
       };
@@ Line 58: / Line 58: @@
       // Test for existence of an OXP that isn't required but effects the way this OXP works.
       this.Oxp_X_Script_Exists = !!worldScripts["Oxp_X_Script"];  // Repeat for other similar OXP script checks.
-      // Please note that the two not (!) operators here work by have one convert the existence of the script object into a boolean which has its true/false status the wrong way round for our needs and then the other swaps the boolean's status to way we need it.
+      // Please note that the two not (!) operators here work by have one convert the existence of the script object into a boolean which has

@@ Line 1: / Line 1: @@
 One of the common issues with OXP development is that many OXPs are dependent on the existence of other OXPs. If they only need to exist side by side this isn't a big problem and the player only has to make sure all necessary OXPs are installed.  If you need another OXP to be initialised first (have it's startUp function called first) you will run into a problem.  An example of this would be if say your OXP added a station above some moons in a range of systems. If your OXP ran before the OXP(s) that created the moons then it may place the stations differently or not at all compared to if it ran later or last.
@@ Line 5: / Line 7: @@
 This problem arises because Oolite does not guarantee the order in which the OXPs are loaded. Some version do load in alphabetical order but that isn't true across the board.  There have been solutions to this problem by either running the initialisation code from a timer or from a screen change event instead of the startUp function but these methods are not good for multiple dependency chain issues and in the case of screen change events do not always trigger. Since version 1.74 of Oolite there has been a much simpler solution.
-== Solution ==
+=== Solution ===
 Oolite 1.74 removed the automatic calling of OXPs' reset functions (making this.reset redundant) and reloads all functions from the cache when the player dies before calling all the OXPs' startUp functions.
@@ Line 31: / Line 33: @@
 Well that's the theory, so here is what a OXP template using this idea should look like in practice:
-<pre>this.name           = "Oxp_A";
+<pre>this.name           = "Oxp_A_Script";
 this.author         = "Author";
 this.copyright      = "Copyright Info"
@@ Line 43: / Line 45: @@
       delete this.startUp; // Must be done straight away to prevent loops. It doesn't stop this function from working.
-         worldScripts.Oxp_Old.startUp(); // Calls Oxp_Old.startUp as it is required to load before your Oxp_A.
+	if (worldScripts[s].startUp) delete worldScripts[s].startUp; // Make sure the other startUp is deleted as it may not be written using this template.
-         delete worldScripts.Oxp_Old.startUp; // You do this as Oxp_Old can't.
+      };
-−
-      // Repeat above for each old OXP that this OXP depends on.
+      // calling each dependency:
       // Test for existence of an OXP that isn't required but effects the way this OXP works.
       log(this.name + " " + this.version +" loaded."); // This goes last so the load messages appear in a sensible order.
@@ Line 72: / Line 65: @@
+}
-// The rest of OXP goes here</pre>
+// The rest of OXP script goes here</pre>
 Replace the OXP names, repeat the sections and fill the rest of the code as needed.
 == See Also ==

@@ Line 3: / Line 3: @@
 One of the common issues with OXP development is that many OXPs are dependent on the existence of other OXPs. If they only need to exist side by side this isn't a big problem and the player only has to make sure all necessary OXPs are installed.  If you need another OXP to be initialised first (have it's startUp function called first) you will run into a problem.  An example of this would be if say your OXP added a station above some moons in a range of systems. If your OXP ran before the OXP(s) that created the moons then it may place the stations differently or not at all compared to if it ran later or last.
-This problem arises because Oolite does not guarantee the order in which the OXPs are loaded. Some version do load in alphabetical order but that isn't true across the board.  There have been solutions to this problem by either running the initialisation code from a timer or from a screen change event instead of the startUp function but these methods are not good for multiple dependency issues and in the case of screen change events do not always trigger. Since version 1.74 of Oolite there has been a much simpler solution.
+This problem arises because Oolite does not guarantee the order in which the OXPs are loaded. Some version do load in alphabetical order but that isn't true across the board.  There have been solutions to this problem by either running the initialisation code from a timer or from a screen change event instead of the startUp function but these methods are not good for multiple dependency chain issues and in the case of screen change events do not always trigger. Since version 1.74 of Oolite there has been a much simpler solution.
 == Solution ==

@@ Line 33: / Line 33: @@
 <pre>this.name           = "Oxp_A";
 this.author         = "Author";
-this.copyright      = "license";
+this.copyright      = "Copyright Info"
 this.description    = "Some Description";
 this.version        = "1.0";

← Older revision		Revision as of 00:59, 7 November 2010
Line 74:		Line 74:

	Replace the OXP names, repeat the sections and fill the rest of the code as needed.		Replace the OXP names, repeat the sections and fill the rest of the code as needed.
		+
		+	== See Also ==
		+	* [[Scripting Oolite with JavaScript]]
		+
		+	[[Category:Oolite scripting]]

@@ Line 67: / Line 67: @@
       // Do Oxp_A's initialisation stuff here as required.
-      log(this.name + " " + this.version +" loaded."); // This goes last so the load messages appear the sensible order.
+      log(this.name + " " + this.version +" loaded."); // This goes last so the load messages appear in a sensible order.
+}

@@ Line 65: / Line 65: @@
       // Repeat above for other similar OXP checks.
-      // Do initialisation stuff here as required
+      // Do Oxp_A's initialisation stuff here as required.
       log(this.name + " " + this.version +" loaded."); // This goes last so the load messages appear the sensible order.