Oolite JavaScript Reference: Equipment scripts - Revision history

Norby: /* activated */

2015-05-15T12:19:19Z

‎activated

Norby at 12:15, 15 May 2015

2015-05-15T12:15:14Z

Norby: /* Equipment scripts */

2015-05-15T12:04:14Z

‎Equipment scripts

Norby at 12:03, 15 May 2015

2015-05-15T12:03:57Z

Norby at 11:55, 15 May 2015

2015-05-15T11:55:17Z

Norby: Equipment scripts

2015-05-15T11:54:26Z

Equipment scripts

New page

=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
}

[[Category:Oolite JavaScript Reference]]

@@ Line 14: / Line 14: @@
+ }
-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 worldscript also (which is not recommended).
+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 worldscript also (which is not recommended).
 An example to access a variable and call a function of your worldScript:
@@ Line 23: / Line 23: @@
    if( w._nameOfYourVariableInYourWorldScript )
+   {
-      w._nameOfYourFunctionInYourWorldScript();
+      w._nameOfYourFunctionInYourWorldScript(w);
+   }
+ }
 ==mode==

@@ Line 1: / Line 1: @@
 =Equipment scripts=
-Equipment scripts are used to handle primable equipments activations.
+Equipment scripts are used to handle primable equipment activations.
 Attach to an equipment in the script property in [[equipment.plist]].

← Older revision		Revision as of 12:03, 15 May 2015
Line 2:		Line 2:
	Equipment scripts are used to handle primable equipments activations.		Equipment scripts are used to handle primable equipments activations.

−	Attach ~~into~~ an equipment in the script property in [[equipment.plist]].	+	Attach to an equipment in the script property in [[equipment.plist]].