Oolite JavaScript Reference: Global - Revision history

Phkb: /* Methods */

2018-07-11T00:07:03Z

‎Methods

Phkb at 07:41, 6 August 2017

2017-08-06T07:41:53Z

Norby: /* missionVariables */

2015-12-31T16:45:12Z

‎missionVariables

Norby: setScreenBackground example fix to fit to the screen

2015-06-04T19:39:40Z

setScreenBackground example fix to fit to the screen

Cim: /* guiScreen */ extra for 1.81

2014-11-16T10:44:59Z

‎guiScreen: extra for 1.81

Cim: /* Methods */ 1.79 update

2013-11-30T16:52:06Z

‎Methods: 1.79 update

Cim: /* expandDescription */ Re-link expansion rules

2013-11-02T17:38:27Z

‎expandDescription: Re-link expansion rules

Norby: Do not use "false" in missionVariables

2013-08-05T20:40:19Z

Do not use "false" in missionVariables

Cim: /* addFrameCallback */ Fix example, extend documentation

2013-02-25T20:09:59Z

‎addFrameCallback: Fix example, extend documentation

Svengali: changed link for descriptions.plist from Misc to redrect

2013-01-12T14:14:50Z

changed link for descriptions.plist from Misc to redrect

@@ Line 144: / Line 144: @@
  function '''formatInteger'''(value : number) : String
 Converts the <code>number</code> parameter to a string formatted as an integer following any localisation rules in place.
 === <code>getScreenBackgroundForKey</code>  ===
@@ Line 195: / Line 202: @@
 '''See also:''' <code>[[#addFrameCallback|addFrameCallback()]]</code>, <code>[[#isValidFrameCallback|isValidFrameCallback()]]</code>
-=== <code>setScreenBackground</code>  ===
+=== <code>setGuiColorSettingForKey</code> ===
  function '''setScreenBackground'''(image : ''guiTextureSpecifier'')
 Temporary override that sets the background of the current gui screen to the specified image. Override is lost after the player switches screens.
@@ Line 206: / Line 213: @@
 === <code>setScreenBackgroundForKey</code>  ===
 {{oolite-method-added|1.85}}
- function '''setScreenBackgroundForKey'''(keyname : string : image : ''guiTextureSpecifier'')
+ function '''setScreenBackgroundForKey'''(keyname : string, image : ''guiTextureSpecifier'')
 Override the background for a particular keyname (referenced in the screenbackgrounds.plist file) with the specified image. Override is only for the current play-session only and does not get written out to screenbackgrounds.plist.

@@ Line 144: / Line 144: @@
  function '''formatInteger'''(value : number) : String
 Converts the <code>number</code> parameter to a string formatted as an integer following any localisation rules in place.
 === <code>isValidFrameCallback</code> ===
@@ Line 191: / Line 203: @@
 '''Example:'''
  setScreenBackground({ name: "oolite-nova-system.png", height: 480 });
 === <code>setScreenOverlay</code>  ===

← Older revision		Revision as of 16:45, 31 December 2015
Line 43:		Line 43:

	Do not use "false" in missionVariables! Will return true due to parsed as string. Use 0 and 1 if you want to store boolean information.		Do not use "false" in missionVariables! Will return true due to parsed as string. Use 0 and 1 if you want to store boolean information.
		+
		+	You can store arrays using [http://www.w3schools.com/json/ JSON] stringify and parse functions. For example:
		+	this.$MyArray = [];
		+
		+	this.startUp = function() {
		+	var s = missionVariables.$MyArray;
		+	if( s && s.length > 0 ) this.$MyArray = JSON.parse(s);
		+	}
		+
		+	this.playerWillSaveGame = function(message) {
		+	missionVariables.$MyArray = JSON.stringify(this.$MyArray);
		+	}
		+

	Mission variables can also be used in legacy scripts and in [[descriptions.plist]] string expansions, by prefixing the name with “mission_”. Example:		Mission variables can also be used in legacy scripts and in [[descriptions.plist]] string expansions, by prefixing the name with “mission_”. Example:

@@ Line 177: / Line 177: @@
 '''Example:'''
- setScreenBackground({ name: "oolite-nova-system.png", height: 512 });
+ setScreenBackground({ name: "oolite-nova-system.png", height: 480 });
 === <code>setScreenOverlay</code>  ===

← Older revision		Revision as of 10:44, 16 November 2014
Line 23:		Line 23:

	In 1.77, <code>"GUI_SCREEN_INTERFACES"</code> is added, and <code>"GUI_SCREEN_CONTRACTS"</code> is removed.		In 1.77, <code>"GUI_SCREEN_INTERFACES"</code> is added, and <code>"GUI_SCREEN_CONTRACTS"</code> is removed.
		+
		+	In 1.81, <code>"GUI_SCREEN_MARKETINFO"</code> is added.

	=== <code>manifest</code> ===		=== <code>manifest</code> ===

@@ Line 107: / Line 107: @@
 Expands a string, substituting special tokens and any key inside square brackets with the substitution rules for [[Missiontext.plist#Special_Expansions|string expansions]].
 When local key/value pairs are provided, they take precedence over any other values.
 '''Example:'''
@@ Line 114: / Line 116: @@
  function '''expandMissionText'''(textKey: String [, locals : Object (Dictionary)]) : String
 Load a string specified by <code>textKey</code> from [[missiontext.plist]], then perform <code>[[#expandDescription|expandDescription()]]</code>-type substitutions on it, and also replace “\n” with line breaks. The <code>local</code> parameter works as with <code>[[#expandDescription|expandDescription()]]</code>.
 '''Example:'''

@@ Line 105: / Line 105: @@
 === <code>expandDescription</code>  ===
  function '''expandDescription'''(description : String [, locals : Object (Dictionary)]) : String
-Expands a string, substituting special tokens and any key inside square brackets with the substitution rules for [[Methods#Communications|Communications]].
+Expands a string, substituting special tokens and any key inside square brackets with the substitution rules for [[Missiontext.plist#Special_Expansions|string expansions]].
 When local key/value pairs are provided, they take precedence over any other values.
 '''Example:'''
  expandDescription("My ball is [my_color].", { my_color: "red" });
 === <code>expandMissionText</code>  ===

@@ Line 39: / Line 39: @@
  missionVariables.exampleVar = 42;
  let x = missionVariables.exampleVar; // x is now the number 42
 Mission variables can also be used in legacy scripts and in [[descriptions.plist]] string expansions, by prefixing the name with “mission_”. Example:

@@ Line 83: / Line 83: @@
 === <code>addFrameCallback</code> ===
  function '''addFrameCallback'''(callback : Function) : ''TrackingID''
-Registers a ''frame callback'' which will be invoked every frame, after entity updates but before rendering. This can be used to implement animations. The return value is a ''tracking ID'' which may be passed to <code>[[#removeFrameCallback|removeFrameCallback()]]</code>; the type and meaning of the tracking ID is unspecified and may change at any time. Frame callbacks are automatically removed when the game resets (for instance, when the player dies), but not at any other time.
+Registers a ''frame callback'' which will be invoked every frame, after entity updates but before rendering. This can be used to implement animations, to apply gradual changes in ship state, to build large data structures without risking reaching processing time limits by trying to do it all at once, or to watch variables which need a same-frame response to changes. The return value is a ''tracking ID'' which may be passed to <code>[[#removeFrameCallback|removeFrameCallback()]]</code>; the type and meaning of the tracking ID is unspecified and may change at any time. Frame callbacks are automatically removed when the game resets (for instance, when the player dies), but not at any other time.
 The callback is passed one parameter, <code>delta</code>, which is the time since the last frame (in [[Time_scales in Oolite|game clock time]]). Frame callbacks fire even when the game is paused, in which case <code>delta</code> is 0.
@@ Line 89: / Line 89: @@
 '''Example:'''
  var sum = 0;
- this.fcb = addFrameCallback(function (delta)
+ this.$fcb = addFrameCallback(function (delta)
+ {
      sum += delta;
      log("Time elapsed: " + sum + " (delta: " + delta + ")");
+ });
-'''See also:''' <code>[[#removeFrameCallback|removeFrameCallback()]]</code>, <code>[[#isValidFrameCallback|isValidFrameCallback()]]</code>
+'''See also:''' <code>[[#removeFrameCallback|removeFrameCallback()]]</code>, <code>[[#isValidFrameCallback|isValidFrameCallback()]]</code>, and for repeated events with a longer repeat interval, use [[Oolite_JavaScript_Reference:_Timer|Timers]] instead.
 === <code>displayNameForCommodity</code>  ===

@@ Line 40: / Line 40: @@
  let x = missionVariables.exampleVar; // x is now the number 42
-Mission variables can also be used in legacy scripts and in [[Misc_plists|descriptions.plist]] string expansions, by prefixing the name with “mission_”. Example:
+Mission variables can also be used in legacy scripts and in [[descriptions.plist]] string expansions, by prefixing the name with “mission_”. Example:
  expandDescription("My variable is [mission_exampleVar].")