Oolite Javascript basics - Revision history

Cholmondely: Added "Wildeblood's comments"

2026-06-28T11:04:38Z

Added "Wildeblood's comments"

Cholmondely: /* Links */ Added Hiran's Index

2026-06-18T17:33:47Z

‎Links: Added Hiran's Index

Cholmondely: /* Links */ Added Wildeblood's User page

2025-04-29T10:32:10Z

‎Links: Added Wildeblood's User page

Cholmondely: /* Links */ Added another

2024-05-29T04:45:31Z

‎Links: Added another

Phkb: Updating BB links

2024-02-29T02:19:50Z

Updating BB links

Cholmondely: Added Links

2023-06-29T23:10:13Z

Added Links

Massively Locked: /* Square = 1 */ updated formatting

2022-10-06T23:10:17Z

‎Square = 1: updated formatting

Massively Locked: Massively Locked moved page Testxyz js basics wip to Oolite Javascript basics

2022-10-05T19:40:48Z

Massively Locked moved page Testxyz js basics wip to Oolite Javascript basics

Massively Locked: 2nd article

2022-10-05T19:33:44Z

2nd article

Massively Locked: Created page with "Just playing around with the wiki. I may continue this, or I may return to my day job which currently consists of making smaller rocks from larger rocks & hoping that there's..."

2022-10-01T23:32:46Z

Created page with "Just playing around with the wiki. I may continue this, or I may return to my day job which currently consists of making smaller rocks from larger rocks & hoping that there's..."

New page

Just playing around with the wiki. I may continue this, or I may return to my day job which currently consists of making smaller rocks from larger rocks & hoping that there's gold in them thar 'roids...

----
==Oolite Javascript basics==

So you want to write scripts for Oolite that'll do all sorts of neat stuff, but you don't know where to start. Well, I was once like you when I started to learn Oolite Javascript and look at where I am today: a broken-down, hollow husk of a man... but that's a whole 'nother story.

The very first thing you need to know and always remember is this:
::::'''Javascript is object-oriented and''' (largely) '''event-driven'''

In many non-object-oriented programming languages, you use commands to do things- commands like "print". You might write something like: <code>print "Hello World!"</code>. When you run your program, you'll be rewarded with a friendly greeting on-screen.

Things are done a little differently in Oolite Javascript because... reasons. Commands are called methods in object-oriented lingo. One of the commands (methods) to print something in Oolite is the <code>[[Oolite JavaScript Reference: Player#consoleMessage|consoleMessage]]</code> method. Your <code>print "Hello World!"</code> will look like this:

<code>consoleMessage ("Hello World!")</code>

That, however, is not complete and will not work. For non-object-oriented humans, amphibians and occasional rhinoceri reading this- always remember and never forget the following: methods '''ALWAYS ALWAYS ALWAYS''' need to be attached to an object. Without it, it's like driving your car... but without your car. <code>consoleMessage</code> is a method of the object, <code>[[Oolite JavaScript Reference: Player|player]]</code>. So our example should now look like this:

<code>player.consoleMessage ("Hello World!")</code>

Knowing this is still not quite enough for your first script. This brings us to the next important point: Javascript is event-driven. Not only does Oolite need to know ''what to do'' (methods) and ''who'' or ''what'' wants to do it (objects), it needs to know ''when'' to do it. To this end, almost everything you write needs to be in an event handler (for further enlightenment/confusion, see [[Oolite JavaScript Reference: World script event handlers|here]] and [[Oolite JavaScript Reference: Ship script event handlers|here]]). Putting your commands in an event handler answers the ''when''. Let's use the <code>[[Oolite JavaScript Reference: World script event handlers#startUp|startUp]]</code> event. This is the event (one of them, at least) when you start a new game or load a save file. Here's the format: <code>this.startUp = function () {}</code>

So the TL;DR version:

Don't do this:

<code>consoleMessage ("Hello World!")</code>

Don't even do this:

<code>player.consoleMessage ("Hello World!")</code>

Do this:

<code>this.startUp = function () {<br>player.consoleMessage ("Hello World!")<br>
}</code>

There- you've written your very first Oolite Javascript script! Congrats & break out the bubbly- we're gonna party like it's 2084004!

@@ Line 77: / Line 77: @@
 Hopefully, all this objectification hasn't been too soul-crushing for you.  As for me, I'm going to go outside, smell some roses, feel the grass beneath my feet and a cool breeze on my face.
 == Links ==
@@ Line 85: / Line 99: @@
 *Hiran's [https://ooliteproject.github.io/oolite-expansion-catalog/index.html OXP Index] updated weekly - includes'' all'' Javascript files in the officially published OXZs.
-*[[User:Massively Locked|Massively Locked]] - author
+*[[User:Massively Locked|Massively Locked]] - original author of this wiki page

@@ Line 83: / Line 83: @@
 *[https://bb.oolite.space/viewtopic.php?p=53620#p53620 Syntax for "if" sentences] (2008)
 *[[User:Wildeblood]] - see "My "How-to" OXPs" - A collection of micro-OXPs, each demonstrating a particular Oolite JavaScript technique, which might be helpful to others seeking an example to copy.
 *[[User:Massively Locked|Massively Locked]] - author

@@ Line 82: / Line 82: @@
 *[https://bb.oolite.space/viewtopic.php?f=4&t=8968 Understanding JavaScript, maybe] ([[User:Ahruman|Ahruman]], 2011)
 *[https://bb.oolite.space/viewtopic.php?p=53620#p53620 Syntax for "if" sentences] (2008)
 *[[User:Massively Locked|Massively Locked]] - author

@@ Line 81: / Line 81: @@
 *[[The Dark Side‎]]
 *[https://bb.oolite.space/viewtopic.php?f=4&t=8968 Understanding JavaScript, maybe] ([[User:Ahruman|Ahruman]], 2011)
 *[[User:Massively Locked|Massively Locked]] - author

@@ Line 80: / Line 80: @@
 == Links ==
 *[[The Dark Side‎]]
-*[http://www.aegidian.org/bb/viewtopic.php?f=4&t=8968 Understanding JavaScript, maybe] ([[User:Ahruman|Ahruman]], 2011)
+*[https://bb.oolite.space/viewtopic.php?f=4&t=8968 Understanding JavaScript, maybe] ([[User:Ahruman|Ahruman]], 2011)
 *[[User:Massively Locked|Massively Locked]] - author

← Older revision		Revision as of 23:10, 29 June 2023
Line 77:		Line 77:

	Hopefully, all this objectification hasn't been too soul-crushing for you. As for me, I'm going to go outside, smell some roses, feel the grass beneath my feet and a cool breeze on my face.		Hopefully, all this objectification hasn't been too soul-crushing for you. As for me, I'm going to go outside, smell some roses, feel the grass beneath my feet and a cool breeze on my face.
		+
		+	== Links ==
		+	*[[The Dark Side‎]]
		+	*[http://www.aegidian.org/bb/viewtopic.php?f=4&t=8968 Understanding JavaScript, maybe] ([[User:Ahruman\|Ahruman]], 2011)
		+
		+	*[[User:Massively Locked\|Massively Locked]] - author

@@ Line 12: / Line 12: @@
 Things are done a little differently in Oolite Javascript because... reasons.  Commands are called methods in object-oriented lingo.  One of the commands (methods) to print something in Oolite is the <code>[[Oolite JavaScript Reference: Player#consoleMessage|consoleMessage]]</code> method.  Your <code>print "Hello World!"</code> will look like this:
+ consoleMessage ("Hello World!")
 That, however, is not complete and will not work.  For non-object-oriented humans, amphibians and occasional rhinoceri reading this- always remember and never forget the following: methods '''ALWAYS ALWAYS ALWAYS''' need to be attached to an object.  Without it, it's like driving your car... but without your car.  <code>consoleMessage</code> is a method of the object, <code>[[Oolite JavaScript Reference: Player|player]]</code>.  So our example should now look like this:
+ player.consoleMessage ("Hello World!")
 Knowing this is still not quite enough for your first script.  This brings us to the next important point: Javascript is event-driven.  Not only does Oolite need to know ''what to do'' (methods) and ''who'' or ''what'' wants to do it (objects), it needs to know ''when'' to do it.  To this end, almost everything you write needs to be in an event handler (for further enlightenment/confusion, see [[Oolite JavaScript Reference: World script event handlers|here]] and [[Oolite JavaScript Reference: Ship script event handlers|here]]).  Putting your commands in an event handler answers the ''when''.  Let's use the <code>[[Oolite JavaScript Reference: World script event handlers#startUp|startUp]]</code> event.  This is the event (one of them, at least) when you start a new game or load a save file.  Here's the format: <code>this.startUp = function () {}</code>
@@ Line 24: / Line 20: @@
 Don't do this:
+ consoleMessage ("Hello World!")
 Don't even do this:
+ player.consoleMessage ("Hello World!")
 Do this:
 ==Your honor, I object...==
 I assume that you are a vibrant person with hopes, dreams, ambitions.  Perhaps you want to rescue animals in need or maybe play the piano at Carnegie Hall or possibly become an astronaut and travel to the Moon, Mars and beyond.  You've had experiences that have brought you sadness, and others that brought you joy.  Perhaps you planted some roses that have bloomed magnificently.  Perhaps your favorite sports team won the championship this year.  Perhaps you found this nice little video game called Oolite and spent countless hours joyfully exploring its universe.

← Older revision	Revision as of 19:40, 5 October 2022
(No difference)

@@ Line 2: / Line 2: @@
 ----
-==Oolite Javascript basics==
+==Square = 1==
 So you want to write scripts for Oolite that'll do all sorts of neat stuff, but you don't know where to start.  Well, I was once like you when I started to learn Oolite Javascript and look at where I am today: a broken-down, hollow husk of a man... but that's a whole 'nother story.
@@ Line 37: / Line 37: @@
 There- you've written your very first Oolite Javascript script!  Congrats & break out the bubbly- we're gonna party like it's 2084004!