Scripting Oolite with JavaScript

From Elite Wiki
Revision as of 22:24, 3 April 2007 by Ahruman (talk | contribs) (Added See Also section.)
Jump to: navigation, search

Oolite 1.68 and later supports scripts written in ECMAScript (more commonly known as JavaScript) in addition to its traditional model based on property lists. This page provides an overview of how JavaScript is used in Oolite. The page Oolite JavaScript object model provides reference for Oolite-specific objects and methods. The page Oolite JavaScript event handler reference provides reference for the event handlers Oolite supports. The language standards and some tutorials can be found through the Wikipedia links provided above.

Using JavaScript

Currently, JavaScript is only supported for “world scripts”, that is, as a replacement for scripts in script.plist. While a script.plist file may contain any number of separate scripts, a single JavaScript file may contain only one script.

If your OXP only uses one script, place a JavaScript file named script.js (or script.es) in the OXP’s Config directory. If you wish to use multiple scripts, you may instead create file named world-scripts.plist in the Config directory. This property list file should consist of an array of script names; the named scripts should exist in a directory named Scripts inside your OXP. As with most “atomic” files (files which cannot be merged), such script files must have a unique name to avoid conflicts with other OXPs. Using the world-scripts.plist method, you can combine JavaScript, plist and OOS scripts however you wish.

Whereas plist scripts are based on polling – all scripts are run at semi-regular intervals, whether they need to be or not – scripts written in JavaScript are “event driven” – different functions, or event handlers, in the script are called in response to state changes in the game, or when other events of interest happen. For instance, willExitWitchSpace is called just before player exits witchspace, and alertConditionChanged is called whenever the alert condition changes. See the event handler reference for a full list of handlers and when Oolite will call them.

The tickle handler is similar to event handlers, but is called periodically at the same times as plist scripts are run – about every 10 seconds, and when certain state changes occur. For efficiency, however, it is best to avoid using tickle if possible.


script.js File Template

Copy and paste this template into a file called script.js in the OXP Config directory. Ensure you change at least the Name value. Every script must have a unique name. If multiple scripts with the same name are encountered, Oolite will arbitrary select one and discard the others.

this.name           = "My OXP Script";
this.author         = "Your Name Here";
this.copyright      = "(C) 2007 Me.";
this.description    = "This OXP doesn't do very much yet.";
this.version        = "1.0 alpha 1";


/*  You can copy and paste this function and just change the "startUp"
    to another event name to handle other OXP events (eg "STATUS_DOCKED",
    "alertConditionChanged", etc).
*/
this.startUp = function()
{
    Log("Initialising OXP " + name);
}

See Also