Scripting Oolite with JavaScript - Revision history

Cholmondely: /* See Also */ Added link to a_c on problems with updating Spidermonkey

2021-12-27T20:09:25Z

‎See Also: Added link to a_c on problems with updating Spidermonkey

Cholmondely: /* See Also */ Added historical link

2021-12-12T11:34:10Z

‎See Also: Added historical link

Hiran: /* script.js File Template */

2021-12-04T17:25:44Z

‎script.js File Template

Show changes

Hiran: /* Using JavaScript */

2021-12-03T16:14:53Z

‎Using JavaScript

Cholmondely: /* See Also */ Added another

2021-10-03T10:30:15Z

‎See Also: Added another

Cholmondely: Added note on AppleMacs & semicolons!

2021-03-10T13:07:59Z

Added note on AppleMacs & semicolons!

Milo: changed world-scripts.plist to a link

2020-06-20T19:49:04Z

changed world-scripts.plist to a link

Astrobe: /* See Also */ added optimization tips link.

2017-09-24T16:16:09Z

‎See Also: added optimization tips link.

Debresser: Page moved.

2016-01-16T20:48:40Z

Page moved.

Makarius: category added

2014-11-10T07:51:35Z

category added

@@ Line 455: / Line 455: @@
 === History ===
 * [http://aegidian.org/bb/viewtopic.php?f=6&t=2784 Anyone want to write scripts using JavaScript?] ([[David Taylor|Dajt]], 2007)
 [[Category:Oolite]]

@@ Line 452: / Line 452: @@
 * [[Handling OXP Dependencies with JavaScript]]
 * [[Optimization tips]]
 [[Category:Oolite]]

@@ Line 7: / Line 7: @@
 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 worldScript 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, <code>willExitWitchSpace</code> is called just before player exits witchspace, and <code>alertConditionChanged</code> is called whenever the alert condition changes. See the [[Oolite JavaScript event handler reference|event handler reference]] for a full list of handlers and when Oolite will call them.
+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, <code>willExitWitchSpace</code> is called just before player exits witchspace, and <code>alertConditionChanged</code> is called whenever the alert condition changes.
@@ Line 35: / Line 35: @@
 === AppleMacs ===
 ... Strict semicolon parsing is a Mac thing. Windows and Linux use GNUstep to parse plists and that apparently is more relaxed syntax-wise than whatever it is that the Mac uses. [[User:Another_commander|Another_commander]] from [http://www.aegidian.org/bb/viewtopic.php?p=262814#p262814 A possible solution?] (2018).
 == See Also ==

@@ Line 38: / Line 38: @@
 == See Also ==
 * [https://developer.mozilla.org/en/JavaScript/Reference Mozilla JavaScript reference pages]
 * [[Oolite JavaScript event handler reference]]

@@ Line 32: / Line 32: @@
+}
 </pre>
 == See Also ==

@@ Line 5: / Line 5: @@
 Currently, JavaScript is supported for “worldScripts”, that is, as a replacement for scripts in ''script.plist'' and shipScripts, that acts as expansion for the ships AI. 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 worldScript 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.
+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 worldScript 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, <code>willExitWitchSpace</code> is called just before player exits witchspace, and <code>alertConditionChanged</code> is called whenever the alert condition changes. See the [[Oolite JavaScript event handler reference|event handler reference]] for a full list of handlers and when Oolite will call them.

← Older revision		Revision as of 20:48, 16 January 2016
Line 1:		Line 1:
−	[[Oolite]] 1.68 and later supports scripts written in [http://en.wikipedia.org/wiki/ECMAScript ECMAScript] (more commonly known as [http://en.wikipedia.org/wiki/JavaScript 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 Reference: object model]] provides reference for Oolite-specific objects and methods. The page [[Oolite JavaScript Reference: ~~world~~ script event handlers]] provides reference for the event handlers Oolite supports. The language standards and some tutorials can be found through the Wiki links provided above.	+	[[Oolite]] 1.68 and later supports scripts written in [http://en.wikipedia.org/wiki/ECMAScript ECMAScript] (more commonly known as [http://en.wikipedia.org/wiki/JavaScript 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 Reference: object model]] provides reference for Oolite-specific objects and methods. The page [[Oolite JavaScript Reference: World script event handlers]] provides reference for the event handlers Oolite supports. The language standards and some tutorials can be found through the Wiki links provided above.

	== Using JavaScript ==		== Using JavaScript ==

← Older revision		Revision as of 07:51, 10 November 2014
Line 42:		Line 42:
	* [[Handling OXP Dependencies with JavaScript]]		* [[Handling OXP Dependencies with JavaScript]]

		+	[[Category:Oolite]]
	[[Category:Oolite scripting]]		[[Category:Oolite scripting]]