Scripting Tasks - Revision history

Cholmondely: Added link to "script tool: Exception traceback"

2021-11-26T14:06:23Z

Added link to "script tool: Exception traceback"

Debresser: Page moved.

2016-01-16T20:51:02Z

Page moved.

GGShinobi: changed names to make example more generic

2013-02-24T21:26:30Z

changed names to make example more generic

GGShinobi: Scripting Task: drain energy while equipment is being used (simulate energy usage)

2013-02-24T21:16:24Z

Scripting Task: drain energy while equipment is being used (simulate energy usage)

New page

This page lists examples for solutions of often recurring scripting tasks.
If you know a better or other way of doing something or have any suggestions or ideas, feel free to edit / add to this page!


==drain energy while equipment is being used (simulate energy usage)==
===using a Timer and it's callback function (modified example taken from [[Ore Processor]]):===
====Overview====
This solution uses a [[Oolite JavaScript Reference: Timer|Timer]] and it's callback function. When the equipment is activated (here: by collecting some processable ore), the timer is being started. The timer is configured to fire every 0.5 seconds. Every time it fires, the callback function ''this.$processOre'' is being called, which reduces the ships' energy by a certain value (here: by 6.4). Note: for simplicity, the code shown here is reduced to only those parts that simulate the energy usage. Have a look at the original source code for more info (e.g. howto play a sound while energy is drained).

=====1. Timer setup=====
The timer ''this.$oreTimer'' that periodically calls the energy reducing method has to be configured. Here this is done in the method ''[[Oolite JavaScript Reference: world script event handlers#startUp|this.startUp]]'' (which is part of a world script):

<pre>this.startUp = function ()
{
this.$oreTimer = new Timer(this, this.$processOre, 5, 0.5);
this.$oreTimer.stop();
}</pre>

=====2. prepare energy reducing function=====
Together with the timer, this method simulates the energy draining by reducing the ships' energy every time that it is called. If the ships' energy drops to 64, the ore processor will deactivate itself for safety:

<pre>this.$processOre = function ()
{
if (player.ship.energy > 64)
{
// busy processing splinter
player.ship.energy -= 6.4;
}
else
{
player.consoleMessage("Energy failure, no extraction of ore!!");
this.$oreTimer.stop();
}
}</pre>

=====3. start/stop the timer when equipment is activated/deactivated=====
In the actual OreProcessor.oxp, the function ''this.$processOre'' is called when a splinter is scooped. To make things simpler, that has been changed for this example. Now there exist functions ''this.$activateOreProcessor'' and ''this.$deactivateOreProcessor'' which simply start or stop the timer:

<pre>this.$activateOreProcessor = function ()
{
this.$oreTimer.start();
}</pre>

<pre>this.$activateOreProcessor = function ()
{
this.$oreTimer.stop();
}</pre>

[[Category:Oolite scripting]]

@@ Line 46: / Line 46: @@
   this.$energyDrainTimer.stop();
 }</pre>
 [[Category:Oolite scripting]]

@@ Line 9: / Line 9: @@
 =====1. Timer setup=====
-The timer ''this.$energyDrainTimer'' that periodically calls the energy reducing method has to be configured. Here this is done in the method ''[[Oolite JavaScript Reference: world script event handlers#startUp|this.startUp]]'' (which is part of a world script):
+The timer ''this.$energyDrainTimer'' that periodically calls the energy reducing method has to be configured. Here this is done in the method ''[[Oolite JavaScript Reference: World script event handlers#startUp|this.startUp]]'' (which is part of a world script):
 <pre>this.startUp = function ()

@@ Line 6: / Line 6: @@
 ===using a Timer and it's callback function (modified example taken from [[Ore Processor]]):===
 ====Overview====
-This solution uses a [[Oolite JavaScript Reference: Timer|Timer]] and it's callback function. When the equipment is activated (here: by collecting some processable ore), the timer is being started. The timer is configured to fire every 0.5 seconds. Every time it fires, the callback function ''this.$processOre'' is being called, which reduces the ships' energy by a certain value (here: by 6.4). Note: for simplicity, the code shown here is reduced to only those parts that simulate the energy usage. Have a look at the original source code for more info (e.g. howto play a sound while energy is drained).
+This solution uses a [[Oolite JavaScript Reference: Timer|Timer]] and it's callback function. When the equipment is activated, the timer is being started. The timer is configured to fire every 0.5 seconds. Every time it fires, the callback function ''this.$drainEnergy'' is being called, which reduces the ships' energy by a certain value (here: by 6.4). Note: for simplicity, the code shown here is reduced to only those parts that simulate the energy usage. Have a look at the original source code of the [[Ore Processor|Ore Processor OXP]] for more info (e.g. howto play a sound while energy is drained).
 =====1. Timer setup=====
-The timer ''this.$oreTimer'' that periodically calls the energy reducing method has to be configured. Here this is done in the method ''[[Oolite JavaScript Reference: world script event handlers#startUp|this.startUp]]'' (which is part of a world script):
+The timer ''this.$energyDrainTimer'' that periodically calls the energy reducing method has to be configured. Here this is done in the method ''[[Oolite JavaScript Reference: world script event handlers#startUp|this.startUp]]'' (which is part of a world script):
 <pre>this.startUp = function ()
+{
-   this.$oreTimer = new Timer(this, this.$processOre, 5, 0.5);
+   this.$energyDrainTimer = new Timer(this, this.$drainEnergy, 5, 0.5);
-   this.$oreTimer.stop();
+   this.$energyDrainTimer.stop();
 }</pre>
 =====2. prepare energy reducing function=====
-Together with the timer, this method simulates the energy draining by reducing the ships' energy every time that it is called. If the ships' energy drops to 64, the ore processor will deactivate itself for safety:
+Together with the timer, this method simulates the energy draining by reducing the ships' energy every time that it is called. If the ships' energy drops to 64, the energy drain will stop (for safety):
-<pre>this.$processOre = function ()
+<pre>this.$drainEnergy = function ()
+{
   if (player.ship.energy > 64)
+  {
     player.ship.energy -= 6.4;
+  }
   else
+  {
-    player.consoleMessage("Energy failure, no extraction of ore!!");
+    player.consoleMessage("Energy failure!!");
-    this.$oreTimer.stop();
+    this.$energyDrainTimer.stop();
+  }
 }</pre>
 =====3. start/stop the timer when equipment is activated/deactivated=====
-In the actual OreProcessor.oxp, the function ''this.$processOre'' is called when a splinter is scooped. To make things simpler, that has been changed for this example. Now there exist functions ''this.$activateOreProcessor'' and ''this.$deactivateOreProcessor'' which simply start or stop the timer:
+In the actual OreProcessor.oxp, the function energy draining function is called when a splinter is scooped. To make things simpler, that has been changed for this example. Now there exist functions ''this.$activateEnergyDrain'' and ''this.$deactivateEnergyDrain'' which simply start or stop the timer:
-<pre>this.$activateOreProcessor = function ()
+<pre>this.$activateEnergyDrain = function ()
+{
-  this.$oreTimer.start();
+  this.$energyDrainTimer.start();
 }</pre>
-<pre>this.$activateOreProcessor = function ()
+<pre>this.$deactivateEnergyDrain = function ()
+{
-  this.$oreTimer.stop();
+  this.$energyDrainTimer.stop();
 }</pre>