Oolite JavaScript Reference: Mission - Revision history

Milo: /* runScreen */ fix link

2020-06-29T18:24:34Z

‎runScreen: fix link

Milo: added examples for mission.setInstructions

2020-06-22T01:28:14Z

added examples for mission.setInstructions

Phkb: /* runScreen special backgrounds (1.77 or later only) */

2018-02-07T23:45:10Z

‎runScreen special backgrounds (1.77 or later only)

Phkb: /* runScreen */

2018-01-05T00:09:38Z

‎runScreen

Phkb: /* runScreen */

2018-01-05T00:08:01Z

‎runScreen

Phkb at 00:05, 5 January 2018

2018-01-05T00:05:27Z

Phkb: /* runScreen */

2018-01-05T00:05:02Z

‎runScreen

Phkb at 00:00, 5 January 2018

2018-01-05T00:00:33Z

Phkb: /* runScreen */

2018-01-04T23:58:29Z

‎runScreen

Diagoras: /* runScreen callbacks */

2015-10-12T10:14:26Z

‎runScreen callbacks

@@ Line 91: / Line 91: @@
 * <code>messageKey : String</code> (Key in [[missiontext.plist]])
 * <code>spinModel: Boolean</code> (If <code>false</code>, the model is shown from the top with no automatic animation.)
 * <code>choicesKey : String</code> (Key in [[missiontext.plist]])
 * <code>initialChoicesKey : String</code> ({{oolite-prop-added|1.77}}, the key from <code>choicesKey</code> which is initially selected)

← Older revision		Revision as of 01:28, 22 June 2020
Line 231:		Line 231:

	If this version is used, the first array element will be a heading on the Manifest screen, and the remaining elements will be entered underneath it, rather than being entered under the "Missions" heading.		If this version is used, the first array element will be a heading on the Manifest screen, and the remaining elements will be entered underneath it, rather than being entered under the "Missions" heading.
		+
		+	'''Example''': <code>mission.setInstructions(["Ship Companion:",expandMissionText("myoxp_currentpet"),...]);</code> will display Ship Companion: in yellow text on the F5F5 screen, and beneath it will show the [[String expansion\|expanded]] value of the key "myoxp_currentpet" from the [[missiontext.plist]] associated with the calling world script. If not called from a world script, the worldScriptName (this.name from the script) must be provided also: <code>mission.setInstructions(["Ship Companion:",expandMissionText("myoxp_currentpet"),...], "myoxp's script name");</code>
		+
		+	Note that the line or lines to be added must be enclosed in square brackets, comma separated. Also note the optional use of expandMissionText to retrieve text from [[missiontext.plist]]. It is also possible to construct the array before calling setInstructions, for example:<pre>
		+	if(myoxp_petslist.length == 0) {
		+	mission.setInstructions(null); // clear any text previously displayed by this world script on the F5F5 screen
		+	} else {
		+	var textArray = [];
		+	textArray.push("Ship Companion" + (myoxp_petslist.length > 1 ? "s:" : ":")); // "Ship Companion:" or "Ship Companions:" if more than one
		+	var i = myoxp_petslist.length - 1; // pointer to last entry in myoxp_petslist
		+	while(i--) { // for each pet in the list, starting from the bottom (probably newest to oldest)
		+	textArray.push(myoxp_petslist[i].name); // add the name of the pet to the text we will show on the F5F5 screen
		+	}
		+	mission.setInstructions(textArray); // our pets list will now be visible on the F5F5 screen until further notice (the next time we call setInstructions or one of its variants, it will replace this)
		+	}
		+	</pre>

	'''See also:''' <code>[[#setInstructionsKey\|setInstructionsKey()]]</code>		'''See also:''' <code>[[#setInstructionsKey\|setInstructionsKey()]]</code>

@@ Line 159: / Line 159: @@
 * <code>LONG_RANGE_CHART_QUICKEST</code>: As LONG_RANGE_CHART, but if the player has a working [[Advanced Navigational Array]] then the quickest route to their current destination system will be displayed.
-In 1.87 or later, 'backgroundSpecial' has these addition special string values:
+In 1.87 or later, 'backgroundSpecial' has these additional special string values:
 * <code>SHORT_RANGE_CHART_SHORTEST</code>: As SHORT_RANGE_CHART, but if the player has a working [[Advanced Navigational Array]] then the shortest (fewest jumps, not necessarily shortest distance) route to their current destination system will be displayed.
 * <code>SHORT_RANGE_CHART_QUICKEST</code>: As SHORT_RANGE_CHART, but if the player has a working [[Advanced Navigational Array]] then the quickest route to their current destination system will be displayed.

@@ Line 85: / Line 85: @@
 * <code>overlay : ''guiTextureSpecifier''</code> (name of an image used as overlay)
 * <code>background : ''guiTextureSpecifier''</code> (name of a picture used as background)
-* <code>backgroundSpecial: String</code> (1.77 or later, special background layer)
+* <code>backgroundSpecial: String</code> ({{oolite-prop-added|1.77}}, special background layer)
 * <code>model : String</code> (Role of a ship that will be shown as rotating ship)
 * <code>modelPersonality : Int</code> ({{oolite-prop-added|1.77}}, the entityPersonality assigned to the <code>model</code>. If unspecified, or in 1.76 or earlier, a random personality is used)

@@ Line 87: / Line 87: @@
 * <code>backgroundSpecial: String</code> (1.77 or later, special background layer)
 * <code>model : String</code> (Role of a ship that will be shown as rotating ship)
-* <code>modelPersonality : Int</code> (1.77 or later, the entityPersonality assigned to the <code>model</code>. If unspecified, or in 1.76 or earlier, a random personality is used)
+* <code>modelPersonality : Int</code> ({{oolite-prop-added|1.77}}, the entityPersonality assigned to the <code>model</code>. If unspecified, or in 1.76 or earlier, a random personality is used)
 * <code>message : String</code>
 * <code>messageKey : String</code> (Key in [[missiontext.plist]])
 * <code>spinModel: Boolean</code> (If <code>false</code>, the model is shown from the top with no automatic animation.)
-* <code>[[Oolite JavaScript Reference: Mission#Advanced choices (1.77 or later only)|choices]]: Object</code> (1.77 or later. Object describing choices)
+* <code>[[Oolite JavaScript Reference: Mission#Advanced choices ({{oolite-prop-added|1.77}})|choices]]: Object</code> (1.77 or later. Object describing choices)
 * <code>choicesKey : String</code> (Key in [[missiontext.plist]])
-* <code>initialChoicesKey : String</code> (1.77 or later, the key from <code>choicesKey</code> which is initially selected)
+* <code>initialChoicesKey : String</code> ({{oolite-prop-added|1.77}}, the key from <code>choicesKey</code> which is initially selected)
-* <code>allowInterrupt : Boolean</code> (1.77 or later. If <code>true</code> (default: false), the mission screen can be interrupted with function keys, which does not call the callback function. Mainly intended for interfaces.)
+* <code>allowInterrupt : Boolean</code> ({{oolite-prop-added|1.77}}. If <code>true</code> (default: false), the mission screen can be interrupted with function keys, which does not call the callback function. Mainly intended for interfaces.)
-* <code>exitScreen : ''guiScreen''</code> (1.77 or later, a GUI screen to exit on. If omitted, an invalid value is given, or the player is not docked, this will revert to "GUI_SCREEN_STATUS". Not all GUI screens are selectable for this: only those reachable with function keys F3 to F8)
+* <code>exitScreen : ''guiScreen''</code> ({{oolite-prop-added|1.77}}, a GUI screen to exit on. If omitted, an invalid value is given, or the player is not docked, this will revert to "GUI_SCREEN_STATUS". Not all GUI screens are selectable for this: only those reachable with function keys F3 to F8)
-* <code>screenID : String</code> (1.77 or later, an optional string which can be read later from <code>[[#screenID|mission.screenID]]</code>)
+* <code>screenID : String</code> ({{oolite-prop-added|1.77}}, an optional string which can be read later from <code>[[#screenID|mission.screenID]]</code>)
-* <code>textEntry : Boolean</code> (1.79 or later, if it's true, then you get the text prompt and 'choices' and 'choicesKey' are ignored. Whatever's typed there gets passed as the parameter to the callback function. The [https://github.com/OoliteProject/oolite/blob/master/Resources/Scripts/oolite-registership.js ship registry code] has a simple example.)
+* <code>textEntry : Boolean</code> ({{oolite-prop-added|1.79}}, if it's true, then you get the text prompt and 'choices' and 'choicesKey' are ignored. Whatever's typed there gets passed as the parameter to the callback function. The [https://github.com/OoliteProject/oolite/blob/master/Resources/Scripts/oolite-registership.js ship registry code] has a simple example.)
 * <code>customChartZoom : decimal</code> ({{oolite-prop-added|1.87}}, zoom level of the 'CUSTOM_CHART' backgroundSpecial map)
 * <code>customChartCentre: Vector3D</code> ({{oolite-prop-added|1.87}}, centre position of the 'CUSTOM_CHART' backgroundSpecial map, using the internal coordinate system. The z component is always zero. Discouraged in favour of customChartCentreInLY)

← Older revision		Revision as of 00:05, 5 January 2018
Line 253:		Line 253:


−	~~[[Category:Updated JavaScript features in Oolite 1.87]]~~ [[Category:Oolite JavaScript Reference]]	+	[[Category:Oolite JavaScript Reference]]

@@ Line 98: / Line 98: @@
 * <code>screenID : String</code> (1.77 or later, an optional string which can be read later from <code>[[#screenID|mission.screenID]]</code>)
 * <code>textEntry : Boolean</code> (1.79 or later, if it's true, then you get the text prompt and 'choices' and 'choicesKey' are ignored. Whatever's typed there gets passed as the parameter to the callback function. The [https://github.com/OoliteProject/oolite/blob/master/Resources/Scripts/oolite-registership.js ship registry code] has a simple example.)
-* <code>customChartZoom : decimal</code> (1.87 or later, zoom level of the 'CUSTOM_CHART' backgroundSpecial map)
+* <code>customChartZoom : decimal</code> ({{oolite-prop-added|1.87}}, zoom level of the 'CUSTOM_CHART' backgroundSpecial map)
-* <code>customChartCentre: Vector3D</code> (1.87 or later, centre position of the 'CUSTOM_CHART' backgroundSpecial map, using the internal coordinate system. The z component is always zero. Discouraged in favour of customChartCentreInLY)
+* <code>customChartCentre: Vector3D</code> ({{oolite-prop-added|1.87}}, centre position of the 'CUSTOM_CHART' backgroundSpecial map, using the internal coordinate system. The z component is always zero. Discouraged in favour of customChartCentreInLY)
-* <code>customChartCentreLY: Vector3D</code> (1.87 or later, centre position of the 'CUSTOM_CHART' backgroundSpecial map, in LY. e.g. for Lave: (8, 34.6, 0). The z component is always zero.)
+* <code>customChartCentreLY: Vector3D</code> ({{oolite-prop-added|1.87}}, centre position of the 'CUSTOM_CHART' backgroundSpecial map, in LY. e.g. for Lave: (8, 34.6, 0). The z component is always zero.)
 Some of these are mutually exclusive; for instance, “title” overrides “titleKey”. See [[Oolite JavaScript Reference: Global#setScreenBackground|setScreenBackground()]] for a discussion of ''guiTextureSpecifier''.

← Older revision		Revision as of 00:00, 5 January 2018
Line 253:		Line 253:


−	[[Category:Oolite JavaScript Reference]]	+	[[Category:Updated JavaScript features in Oolite 1.87]] [[Category:Oolite JavaScript Reference]]

@@ Line 148: / Line 148: @@
 This form is more complicated, and the ordering is less intuitive. However, it does allow you to make complex decisions about the parameters in code, and writing the callback out of line can be preferable if it’s long. It is recommended that you start out with the first approach, but keep in mind that there are other options if it becomes too limiting.
-In 1.77, if <code>allowInterrupt</code> is set to true, it is possible that the callback function will not be called. It should therefore only be set for mission screens which can safely be interrupted without the callback. Regardless of this setting, all mission screens may be interrupted by the player launching from the station, and this possibility should be considered.
+In 1.77, if <code>allowInterrupt</code> is set to true, it is possible that the callback function will not be called. It should therefore only be set for mission screens which can safely be interrupted without the callback. Regardless of this setting, all mission screens may be interrupted by the player launching from the station, and this possibility should be considered (in such case callback function will be called with <code>null</code> argument).
 ==== runScreen special backgrounds (1.77 or later only) ====