Oolite JavaScript Reference: Mission - Revision history

Wildeblood: /* displayModel */ spelling

2025-05-04T06:34:02Z

‎displayModel: spelling

Phkb: Updating BB links

2024-02-29T02:18:58Z

Updating BB links

Cholmondely: /* runScreen */ Added link to "Screenbackgrounds.plist"

2024-02-08T01:01:11Z

‎runScreen: Added link to "Screenbackgrounds.plist"

Cholmondely: /* Links */ Added and tweaked

2024-01-16T10:59:38Z

‎Links: Added and tweaked

Phkb: /* runScreen */

2023-12-14T01:20:16Z

‎runScreen

Cholmondely: Added Links

2023-01-18T23:22:54Z

Added Links

Massively Locked: uniform string format, added links (x3) & anchor

2022-11-07T17:43:00Z

uniform string format, added links (x3) & anchor

Massively Locked: /* setInstructions */ uniform string format, deleted redundant link

2022-11-03T23:28:20Z

‎setInstructions: uniform string format, deleted redundant link

Massively Locked: /* unmarkSystem */ fixed syntax, uniform string format, added link & deleted redundant link

2022-11-03T23:19:33Z

‎unmarkSystem: fixed syntax, uniform string format, added link & deleted redundant link

Massively Locked: /* markSystem */ uniform string format (x9), added link

2022-11-03T22:41:58Z

‎markSystem: uniform string format (x9), added link

@@ Line 8: / Line 8: @@
 === <code>displayModel</code> ===
   '''displayModel''' : {{oojsclass|Ship}}
-If currently running a mission screen with a <code>model</code>, the ship entity used to display the model. This can be animated by setting its position and orientation from a [[Oolite JavaScript Reference: Global#addFrameCallback|frame callback]]. Uses role to identify ship, so be sure to use a unique role if you want a specific ship to be showed.
+If currently running a mission screen with a <code>model</code>, the ship entity used to display the model. This can be animated by setting its position and orientation from a [[Oolite JavaScript Reference: Global#addFrameCallback|frame callback]]. Uses role to identify ship, so be sure to use a unique role if you want a specific ship to be shown.
 === <code>exitScreen</code> ===

@@ Line 318: / Line 318: @@
 *[[Mission variable]]
 *[[Mission screen]]
-*[http://www.aegidian.org/bb/viewtopic.php?f=4&t=12042 Order of mission texts on the F5F5 manifest screen] (2012)
+*[https://bb.oolite.space/viewtopic.php?f=4&t=12042 Order of mission texts on the F5F5 manifest screen] (2012)
 *For ideas, see here: [https://thealexandrian.net/gamemastery-101 Gamemastery 101] - try the "Three Clue Rule" for example.

← Older revision		Revision as of 01:01, 8 February 2024
Line 106:		Line 106:

	There are 21 lines available for display of the message and choices combined. (In 1.77, this is extended to 27 lines if the player's HUD is hidden)		There are 21 lines available for display of the message and choices combined. (In 1.77, this is extended to 27 lines if the player's HUD is hidden)
		+
		+	'''See also:''' [[Screenbackgrounds.plist]]

	==== runScreen callbacks ====		==== runScreen callbacks ====

@@ Line 312: / Line 312: @@
 == Links ==
 *[[Missiontext.plist]]
 *[[OXP mission offering]]
 *[[Mission variable]]
 *[[Mission screen]]
-*[[Script.oos]] - possible reason for really old missions no longer working (pre- v.1.70)
+*[http://www.aegidian.org/bb/viewtopic.php?f=4&t=12042 Order of mission texts on the F5F5 manifest screen] (2012)
 *For ideas, see here: [https://thealexandrian.net/gamemastery-101 Gamemastery 101] - try the "Three Clue Rule" for example.
 [[Category:Oolite JavaScript Reference]]

@@ Line 101: / Line 101: @@
 * <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> ({{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''.
@@ Line 208: / Line 210: @@
 In 1.77, the behaviour for choices which have no text is slightly changed. These will now leave a blank and unselectable line in the option list.
 ==== Safe usage of runScreen ====

← Older revision		Revision as of 23:22, 18 January 2023
Line 270:		Line 270:

	'''See also:''' <code>[[#markedSystems\|markedSystems]]</code>		'''See also:''' <code>[[#markedSystems\|markedSystems]]</code>
		+
		+	== Links ==
		+	*[[Oolite Missions ]] - reference: summaries of other missions
		+	*[[List of Planets used in OXPs]] - reference to see which systems are used by other oxp's
		+	*[[Missiontext.plist]]
		+	*[[OXP mission offering]]
		+	*[[Mission variable]]
		+	*[[Mission screen]]
		+	*[[Script.oos]] - possible reason for really old missions no longer working (pre- v.1.70)
		+
		+	*For ideas, see here: [https://thealexandrian.net/gamemastery-101 Gamemastery 101] - try the "Three Clue Rule" for example.


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

@@ Line 14: / Line 14: @@
   '''exitScreen''' : [[Oolite JavaScript Reference: Global#guiScreen|guiScreen]] (read/write)
-This can be used to set a new exit screen for the current mission screen. Outside of a callback function, the value of this is meaningless, and setting it has no useful effect.
+This can be used to set a new [[#xtScrn|exit screen]] for the current mission screen. Outside of a callback function, the value of this is meaningless, and setting it has no useful effect.
 === <code>markedSystems</code> ===
@@ Line 95: / Line 95: @@
 * <code>initialChoicesKey : String</code> ({{oolite-prop-added|1.77}}, the key from <code>choicesKey</code> which is initially selected)
 * <code>allowInterrupt : Boolean</code> ({{oolite-prop-added|1.77}}. If <code>true</code> (default: <code>false</code>), the mission screen can be interrupted with function keys, which does not call the callback function. Mainly intended for interfaces.)
-* <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)
+* <span id="xtScrn"><code>exitScreen</span>: [[Oolite JavaScript Reference: Global#guiScreen|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 <code>"GUI_SCREEN_STATUS"</code> (F5). Not all GUI screens are selectable for this: only those reachable with function keys F3 to F8.  This property can be changed with <code>[[#exitScreen|exitScreen]]</code>)
 * <span id="scrnID"><code>screenID : String</code></span> ({{oolite-prop-added|1.77}}, an optional string which can be read later from <code>[[#screenID|mission.screenID]]</code>)
 * <code>textEntry : Boolean</code> ({{oolite-prop-added|1.79}}, if it's <code>true</code>, 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.)

@@ Line 224: / Line 224: @@
 When not called from within a world script, the name of a world script must be specified so that Oolite knows which script the message belongs to. Clear the message by calling <code>setInstructions(null)</code>.
-Note: the "\n" token does not provide a line break (verified in v1.9).
+Note: the <code>"\n"</code> token does not provide a line break (verified in v1.9).
 It is recommended that <code>setInstructions()</code> is used only when you need to customise the text for a specific scenario. For static text, use <code>[[#setInstructionsKey|setInstructionsKey()]]</code> instead.
@@ Line 251: / Line 251: @@
+   }
    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>
 === <code>setInstructionsKey</code> ===

@@ Line 264: / Line 264: @@
 === <code>unmarkSystem</code> ===
-  function '''unmarkSystem'''(systemNumbers : Number)
+  function '''unmarkSystem'''(systemNumbers : Number) : Boolean
-Remove a mark set with <code>[[#markSystem|markSystem()]]</code>. Multiple systems may be unmarked at once, as in <code>mission.unmarkSystem(4, 54, 222)</code>.
+Remove a mark set with <code>[[#markSystem|markSystem()]]</code>. Multiple systems may be unmarked at once, as in <code>mission.<wbr>unmarkSystem<wbr>(4, 54, 222)</code>.
 In 1.76 and earlier versions, any script can unmark a system, regardless of which script marked it or how many times it was previously marked.
-In 1.77, each marker has a name, and if a system has multiple markers each marker must be removed separately. Parameters in 1.77 may be numbers or objects. Numbers remove the "__oolite_<wbr>legacy_<wbr>destinations" markers. Objects are the same format as in <code>markSystem</code> and remove the marker of the corresponding name (the marker style options are ignored when unmarking). In 1.77, this method will return <code>true</code> if all requested markers existed and were removed, or <code>false</code> if any of the requested markers did not exist.
+In 1.77, each marker has a name, and if a system has multiple markers each marker must be removed separately. Parameters in 1.77 may be numbers or objects. Numbers remove the <code>"__oolite_<wbr>legacy_<wbr>destinations"</code> markers. Objects are the same format as in <code>markSystem()</code> and remove the marker of the corresponding name (the marker style options are ignored when unmarking). In 1.77, this method will return <code>true</code> if all requested markers existed and were removed, or <code>false</code> if any of the requested markers did not exist.
-'''See also:''' <code>[[#markSystem|markSystem()]]</code>
+'''See also:''' <code>[[#markedSystems|markedSystems]]</code>
 [[Category:Oolite JavaScript Reference]]

@@ Line 51: / Line 51: @@
 In 1.77 or later, the parameters may be objects instead of numbers. This allows control over the marker's appearance, and allows multiple markers to be placed on the same system. The object takes the following parameters:
 * <code>system</code> : The system ID. This is the only required parameter.
-* <code>name</code> : A string identifying the group this marker belongs to (which may be the script's name, or something more specific). If omitted, which is not recommended, this defaults to "__oolite_legacy_destinations" which is also used for marking with numbers and marking carried out by legacy scripts.
+* <code>name</code> : A string identifying the group this marker belongs to (which may be the script's name, or something more specific). If omitted, which is not recommended, this defaults to <code>"__oolite_<wbr>legacy_<wbr>destinations"</code> which is also used for marking with numbers and marking carried out by legacy scripts.
-* <code>markerColor</code> : A string specifying a colour. e.g. "redColor" or "1.0 0.5 0.0". If omitted, "redColor" will be used.
+* <code>markerColor</code> : A string specifying a colour. e.g. <code>"redColor"</code> or <code>"1.0 0.5 0.0"</code>. If omitted, <code>"redColor"</code> will be used.
-* <code>markerScale</code> : A number between 0.5 and 2.0 specifying the relative size of the marker. Defaults to 1.0.
+* <code>markerScale</code> : A number between <code>0.5</code> and <code>2.0</code> specifying the relative size of the marker. Defaults to <code>1.0</code>.
-* <code>markerShape</code> : A string describing the shape of the marker. Valid values are MARKER_X, MARKER_PLUS, MARKER_SQUARE and MARKER_DIAMOND. If this value is invalid or omitted, MARKER_X will be used.
+* <code>markerShape</code> : A string describing the shape of the marker. Valid values are <code>"MARKER_X"</code>, <code>"MARKER_PLUS"</code>, <code>"MARKER_SQUARE"</code> and <code>"MARKER_DIAMOND"</code>. If this value is invalid or omitted, <code>"MARKER_X"</code> will be used.
 Multiple markers may be placed on the same system, provided that they have different names. If a marker with the same system and name already exists, it will be replaced.
@@ Line 66: / Line 66: @@
   });
-'''See also:''' <code>[[#unmarkSystem|unmarkSystem()]]</code>
+'''See also:''' [[#unmarkSystem|<code>unmarkSystem()</code>]], [[#markedSystems|<code>markedSystems</code>]]
 === <code>runShipLibrary</code> ===