Difference between revisions of "Oolite JavaScript Reference: Oolite"

From Elite Wiki
Jump to: navigation, search
m (gameSettings)
(Added in v1.79: oolite.gameSettings.keyConfig)
Line 11: Line 11:
 
  autosave : Boolean
 
  autosave : Boolean
 
  gameWindow : Object (see below)
 
  gameWindow : Object (see below)
 +
keyConfig : Object (see below)
 
  musicMode : String ("MUSIC_OFF", "MUSIC_ON", or "MUSIC_ITUNES")
 
  musicMode : String ("MUSIC_OFF", "MUSIC_ON", or "MUSIC_ITUNES")
 
  procedurallyTexturedPlanets : Boolean
 
  procedurallyTexturedPlanets : Boolean
Line 18: Line 19:
 
  wireframeGraphics : Boolean
 
  wireframeGraphics : Boolean
  
the gameWindow property contains the following properties:
+
The gameWindow property contains the following properties:
 
  height : Number
 
  height : Number
 
  width : Number
 
  width : Number
 
  fullScreen : Boolean
 
  fullScreen : Boolean
 +
 +
The keyConfig property contains the numeric (decimal) KeyCode values of all Keyconfig Entry in oolite.app/Resources/Config/keyconfig.plist file. Keyconfig Entry - KeyCode pairs are documented in ''[[Oolite_Keyboard_Controls]]''.
 +
 +
You can use the standard Javascript String.fromCharCode() method to convert KeyCode to a string:
 +
var button = String.fromCharCode( oolite.gameSettings.keyConfig.key_ident_system );
 +
player.consoleMessage( "Press " + button + " to turn on the ident system." );
 +
 +
Things like tab, escape, arrow keys, etc. would need to be handled separately.
  
 
=== <code>jsVersion</code> ===
 
=== <code>jsVersion</code> ===

Revision as of 09:59, 8 July 2013

Prototype: Object
Subtypes: none

The Oolite class represents Oolite itself. It allows scripts to access information about the application. There is a global instance of Oolite, named oolite.

Properties

gameSettings

gameSettings : Object(read-only)

This property allows an OXP to detect various game settings. It has the following read-only properties:

autosave : Boolean
gameWindow : Object (see below)
keyConfig : Object (see below)
musicMode : String ("MUSIC_OFF", "MUSIC_ON", or "MUSIC_ITUNES")
procedurallyTexturedPlanets : Boolean
reducedDetailGraphics : Boolean
shaderEffectsLevel : String ("SHADERS_OFF", "SHADERS_SIMPLE", "SHADERS_FULL", or "SHADERS_NOT_SUPPORTED")
speechOn : Boolean
wireframeGraphics : Boolean

The gameWindow property contains the following properties:

height : Number
width : Number
fullScreen : Boolean

The keyConfig property contains the numeric (decimal) KeyCode values of all Keyconfig Entry in oolite.app/Resources/Config/keyconfig.plist file. Keyconfig Entry - KeyCode pairs are documented in Oolite_Keyboard_Controls.

You can use the standard Javascript String.fromCharCode() method to convert KeyCode to a string:

var button = String.fromCharCode( oolite.gameSettings.keyConfig.key_ident_system );
player.consoleMessage( "Press " + button + " to turn on the ident system." );

Things like tab, escape, arrow keys, etc. would need to be handled separately.

jsVersion

jsVersion : Number (read-only)

The version of the JavaScript language implemented by this version of Oolite, multiplied by 100, as an integer. For instance, for JavaScript 1.7 (used in Oolite 1.74), this will be equal to 170.

jsVersionString

jsVersionString : String (read-only)

The version of the JavaScript language implemented by this version of Oolite, as a string. For instance, for JavaScript 1.7, this will be equal to "1.7".

version

version : Array (read-only)

The version of Oolite, as an array of version components. For instance, for Oolite 1.74 this is [1, 74]. For version 1.73.4, it is [1, 73, 4].

versionString

versionString : String (read-only)

The version of Oolite, as a string. For instance, for Oolite 1.74 this is "1.74". For version 1.73.4, it is "1.73.4".


Methods

compareVersion

function compareVersion(versionSpec) : Number

Compare the version of Oolite to versionSpec, which may be either a string or an array (in the format given by version). If the current version of Oolite is less than versionSpec, 1 is returned. If the current version of Oolite is greater than versionSpec, -1 is returned. If they are equal, 0 is returned. Example:

if (0 < oolite.compareVersion("1.80"))
{
    // Oolite version is older than 1.80.
    log(this.name, "An old version of Oolite (" + oolite.versionString + ") is in use. Some features of SuperDuperOXP will not be available.")
}
else
{
    // Enable advanced features here.
}