OXP mission offering - Revision history

Kaks: /* How mission offering should be done with JS */

2010-07-21T12:03:30Z

‎How mission offering should be done with JS

Kaks: /* How mission offering should be done with JS */

2010-07-21T11:43:42Z

‎How mission offering should be done with JS

Eric Walch: Added a message of the old missionscreen creation being outdated and replaced with a new method.

2010-06-08T20:12:16Z

Added a message of the old missionscreen creation being outdated and replaced with a new method.

Ahruman: /* script example for missionoffering on JS */ null, not nill.

2009-10-06T19:50:43Z

‎script example for missionoffering on JS: null, not nill.

Eric Walch: updated for 1.73 situation

2009-10-06T10:21:53Z

updated for 1.73 situation

Eric Walch: corrected two typos

2009-10-06T09:49:24Z

corrected two typos

Eric Walch: Added JS example code

2009-08-22T10:10:56Z

Added JS example code

Eric Walch: Updated file

2008-02-01T21:52:02Z

Updated file

Eric Walch: /* Conditions for offering */

2008-02-01T18:06:38Z

‎Conditions for offering

Eric Walch: added GUI_SCREEN_MAIN

2008-02-01T18:05:52Z

added GUI_SCREEN_MAIN

@@ Line 83: / Line 83: @@
 = How mission offering should be done with JS =
-The method described below is only needed with Oolite 1.73 or older. Starting with Oolite 1.74 a new method for displaying a mission screen is introduced that is much easier in use and much less likely to give conflicts between different oxp's. So, when you now start creating a new script, forget the stuff below and start using the [[Oolite_JavaScript_Reference:_Mission#runScreen|new method for displaying a missionscreen]]. The code samples below is at the best useful to understand older code you might want to alter.
+Starting with Oolite 1.74 we have a new method for displaying mission screens, one that minimises the mission screen conflicts that have afflicted scripts for quite some time: [[Oolite_JavaScript_Reference:_Mission#runScreen|mission.runScreen]], please refer to that part of the documentation when writing new missions.
 Below is an example script for clash free mission offering. It should work with Oolite version 1.73 and newer.

← Older revision		Revision as of 11:43, 21 July 2010
Line 83:		Line 83:
	= How mission offering should be done with JS =		= How mission offering should be done with JS =

−	The method described below is only needed with Oolite 1.73 or older. Starting with Oolite 1.74 a new method for displaying a mission screen is introduced that is much easier in use and much less likely to give conflicts between different oxp's. So, when you now start creating a new script, forget the stuff below and start using the [[Oolite_JavaScript_Reference:_Mission\|new method for displaying a missionscreen]]. The code samples below is at the best useful to understand older code you might want to alter.	+	The method described below is only needed with Oolite 1.73 or older. Starting with Oolite 1.74 a new method for displaying a mission screen is introduced that is much easier in use and much less likely to give conflicts between different oxp's. So, when you now start creating a new script, forget the stuff below and start using the [[Oolite_JavaScript_Reference:_Mission#runScreen\|new method for displaying a missionscreen]]. The code samples below is at the best useful to understand older code you might want to alter.

← Older revision		Revision as of 20:12, 8 June 2010
Line 83:		Line 83:
	= How mission offering should be done with JS =		= How mission offering should be done with JS =

−	For java script all above applies. Just make sure you don't set up a message when there is already a Missionscreen or a Reportscreen on display. Also don't set up your missionscreen when there are valid mission choices they don't belong to you. With JS every oxp can react on an handler and when your handler code is triggered you must verify no other oxp has already reacted on that handler before you.
		+	The method described below is only needed with Oolite 1.73 or older. Starting with Oolite 1.74 a new method for displaying a mission screen is introduced that is much easier in use and much less likely to give conflicts between different oxp's. So, when you now start creating a new script, forget the stuff below and start using the [[Oolite_JavaScript_Reference:_Mission\|new method for displaying a missionscreen]]. The code samples below is at the best useful to understand older code you might want to alter.
		+
		+
		+	For java script all above about legacy scripts applies. Just make sure you don't set up a message when there is already a Missionscreen or a Reportscreen on display. Also don't set up your missionscreen when there are valid mission choices they don't belong to you. With JS every oxp can react on an handler and when your handler code is triggered you must verify no other oxp has already reacted on that handler before you.

	== script example for missionoffering on JS ==		== script example for missionoffering on JS ==

@@ Line 91: / Line 91: @@
  this.name        = "demo";
  this.author      = "eric walch";
- this.copyright   = "� 2008 eric walch.";
+ this.copyright   = "© 2008 eric walch.";
  this.description = "Empty script structure that handles population and mission offering";
  this.version     = "0.0";
@@ Line 152: / Line 152: @@
         mission.runMissionScreen("mission_text", "backgroundscreen.png", "choices_text", "ship_role", "music")
         You can transfer 5 variables at once that formerly had to set or cleared each seperately.
-        When not needed you can transfer a nill. nill's at the end can be omittet, in between must be used.
+        When not needed you can transfer a null. nulls at the end can be omitted, in between must be used.
         When you do an offer you must set a variable to tell an offer is made. It is not safe to use the main mission

@@ Line 142: / Line 142: @@
+ {
     if (guiScreen == "GUI_SCREEN_MISSION" || guiScreen == "GUI_SCREEN_REPORT") return;
- 	// there will be a "missionScreenEnded" or "guiScreenChanged" in future to react uppon.
+ 	// there will be a "missionScreenEnded" or "reportScreenEnded" in future to react uppon.
     if (missionVariables.offering || (mission.choice && mission.choice != "")) return;
  	// when "missionVariables.offering" or "mission.choice" are present it means that an other script claimed the mission_screen.

@@ Line 128: / Line 128: @@
  this.shipDockedWithStation = function(station)
+ {
-        // an other eventhandler cauld have launched the ship already when it fires for this script.
+        // an other eventhandler could have launched the ship already when it fires before this script.
         if(player.ship.docked) this.missionOffers();
+ }

@@ Line 1: / Line 1: @@
-= How mission offering should be done =
+= How mission offering should be done with Legacy script =
@@ Line 80: / Line 80: @@
 Notice that you do not need to specify the mission name in setting and clearing the missionDescription. The system automatic uses the name of the missionscript that uses this command to store the description. This also means that you can not use these two commands outside the missionscript like inside a death_action of a ship.
 The best lessons are taken by examining existing scripts.  You can download more info and a test OXP here:  [[Media:MOP-Test_1.1.zip|Mission Offering Protocol]]
 [[Category:Oolite scripting]]

@@ Line 19: / Line 19: @@
 For Oollite versions up to 1.68 that do not know the "notequal" condition or for compatibillity with those versions use:
- conditions = (gui_screen_string oneof GUI_SCREEN_MAIN , GUI_SCREEN_STATUS).
+ conditions = (gui_screen_string oneof GUI_SCREEN_MAIN, GUI_SCREEN_STATUS).
 At the end of the docking procedure the script runs immediately for one time with gui_screen_string = GUI_SCREEN_MAIN but already with status_string = STATUD_DOCKED. All following moments the script runs with as gui_screen_string the screen you are looking at. When you do nothing further this will be the  GUI_SCREEN_STATUS .  (= F5) You could also explicit check for the mission screen and put your whole action in the else line.
@@ Line 28: / Line 28: @@
  conditions = (gui_screen_string notequal GUI_SCREEN_MISSION).
 == Setting up the message ==

@@ Line 17: / Line 17: @@
 Before placing text also check if the missionscreen is not in use. (See the documents in the downloadeble package below for more info)
-For Oollite versions till 1.69/1.70 that do not know the "notequal" condition or for compatibillity with those versions use:
+For Oollite versions up to 1.68 that do not know the "notequal" condition or for compatibillity with those versions use:
- conditions = (gui_screen_string oneof GUI_SCREEN_STATUS, GUI_SCREEN_EQUIP_SHIP, GUI_SCREEN_MARKET, GUI_SCREEN_SHORT_RANGE_CHART).
+ conditions = (gui_screen_string oneof GUI_SCREEN_MAIN , GUI_SCREEN_STATUS).
  conditions = (gui_screen_string equal GUI_SCREEN_MISSION); do = (); else = (your stuff);
-But this involves an extra nested condition, so most people will probably prefer the first method. (Versions 1.7 and newer will have a not-equal option when programming in the new introduced javascript)
+But this involves an extra nested condition, so most people will probably prefer the first method. Versions 1.69 and newer will have a not-equal option.
 == Setting up the message ==