Oolite JavaScript Reference: Equipment scripts

Equipment scripts

Equipment scripts are used to handle primable equipments activations.

Attach into an equipment in the script property in equipment.plist.

activated

This method is called when the player pressed the activate key (n) when this equipment is primed (Shift+N).

this.activated = function()
{
  // your code here
}

Note the this variable points to the equipment script within this function and not to the worldScript regardless of the same js file is defined to be as worldscript also (which is not recommended).

An example to access a variable and call a function of your worldScript:

this.activated = function()
{
  var w = worldScripts["nameOfYourWorldScript"];
  if( w._nameOfYourVariableInYourWorldScript ) 
  {
     w._nameOfYourFunctionInYourWorldScript();
  }
}

mode

This method is called when the player pressed the mode key (b) when this equipment is primed (Shift+N).

this.mode = function()
{
  // your code here
}