Oolite JavaScript OM Specification - Revision history

Debresser: Category:Oolite scripting

2016-01-22T01:19:01Z

Debresser: Remove non-existing category that IMHO shouldn't exist. If this is a draft, it should be in a userpage. If it is needed, put it in Category:Oolite JavaScript Reference.

2016-01-16T20:45:19Z

Remove non-existing category that IMHO shouldn't exist. If this is a draft, it should be in a userpage. If it is needed, put it in Category:Oolite JavaScript Reference.

Ahruman at 21:10, 22 June 2010

2010-06-22T21:10:28Z

Ahruman: Removed already-implemented classes Vector and Quaternion, changed categories, expanded note.

2007-08-03T14:42:07Z

Removed already-implemented classes Vector and Quaternion, changed categories, expanded note.

Ahruman: Changed properties/instance variables to be consistently lowercase.

2007-03-31T19:27:35Z

Changed properties/instance variables to be consistently lowercase.

Ahruman: Added Category:Oolite Development and WIP note.

2007-03-25T17:15:24Z

Added Category:Oolite Development and WIP note.

Dajt at 07:48, 25 March 2007

2007-03-25T07:48:44Z

Dajt: New page: Use this page to define the object model exposed by Oolite to the JavaScript interpreter. The syntax used should be obvious to anyone with some OO programming experience. class...

2007-03-25T03:27:47Z New page: Use this page to define the object model exposed by Oolite to the JavaScript interpreter. The syntax used should be obvious to anyone with some OO programming experience. <tt><pre> class... New page Use this page to define the object model exposed by Oolite to the JavaScript interpreter. The syntax used should be obvious to anyone with some OO programming experience. <tt><pre> class Vector3 { float x, z, y; } class Quaternion { float x, y, z, w; } class Commodity { readonly string Name; readonly integer unitofMass; // grams, kgs, tons } class Consignment { Commodity commodity; float quantity; } class Entity { readonly integer ID; readonly Entity[] subentities; Vector3 position; Vector3 velocity; Quaternion rotation; // some property to set change in rotation per second? static Entity getEntityWithID(integer ID); void setAI(string AIName); void pushAI(string AIName); void popAI(); } // Note all methods which take an Entity as an argument can also accept an entity ID instead. class Vessel { float foreShieldStrength; float aftShieldStrength; float energy; float foreShieldMaxStrength; float aftShieldMaxStrength; float maxEnergy; // something measure of max and current hull integrity? // need to represent docking ports somehow float cabinTemperature; integer maxCargoCapacity; integer freeCargoCapacity; Consignment[] cargo; Entity currentTarget; Entity[] escorts; string roleName; string commanderName; // short form of getScanClassRelativeTo(0) - ie the player integer getScanClass(); integer getScanClassRelativeTo(Entity other); float getDistanceFrom(Entity other); void Goto(Vector3 destination); void GotoEntity(Entity other, integer minimumDistance); // These methods return the ID of the launched entity, or -1 on error or if the target vessel cannot // launch other vessels. integer launchVesselWithRole(string role); integer launchVesselWithName(string name); } </pre></tt>

← Older revision		Revision as of 01:19, 22 January 2016
Line 71:		Line 71:
	integer launchVesselWithName(string name);		integer launchVesselWithName(string name);
	}		}
		+
		+	[[Category:Oolite scripting]]

← Older revision		Revision as of 20:45, 16 January 2016
Line 71:		Line 71:
	integer launchVesselWithName(string name);		integer launchVesselWithName(string name);
	}		}
−
−	[[Category:Oolite scripting drafts]]

← Older revision		Revision as of 21:10, 22 June 2010
Line 1:		Line 1:
−	Use this page to define the object model exposed by Oolite to the JavaScript interpreter.
		+	'''This document is entirely outdated and kept only for historical purposes. For actual Oolite JavaScript interfaces, see [[:Category:Oolite JavaScript Reference\|Oolite JavaScript Reference]].

−	'''Note:''' this is a work in progress. It should not be taken as a final specification. Much of the functionality has been redesigned already. See [[:Category:Oolite scripting]] for current documentation and [[:Category:Oolite scripting drafts]] for in-progress documentation.
		+	Use this page to define the object model exposed by Oolite to the JavaScript interpreter.

	class Commodity		class Commodity

← Older revision		Revision as of 14:42, 3 August 2007
Line 1:		Line 1:
	Use this page to define the object model exposed by Oolite to the JavaScript interpreter.		Use this page to define the object model exposed by Oolite to the JavaScript interpreter.

−	'''Note:''' this is a work in progress. It should not be taken as a final specification.	+	'''Note:''' this is a work in progress. It should not be taken as a final specification. Much of the functionality has been redesigned already. See [[:Category:Oolite scripting]] for current documentation and [[:Category:Oolite scripting drafts]] for in-progress documentation.

−	<pre>
		+	class Commodity
−	class Vector3
		+	{
−	{
		+	readonly string name;
−	float x, z, y;
		+	readonly integer unitofMass; // grams, kgs, tons
−	}	+	}
		+
		+	class Consignment
		+	{
		+	Commodity commodity;
		+	float quantity;
		+	}
		+
		+	class Entity
		+	{
		+	readonly integer ID;
		+	readonly Entity[] subentities;
		+	Vector3 position;
		+	Vector3 velocity;
		+	Quaternion rotation;
		+	// some property to set change in rotation per second?
		+
		+	static Entity getEntityWithID(integer ID);
		+
		+	void setAI(string AIName);
		+	void pushAI(string AIName);
		+	void popAI();
		+	}
		+
		+	// Note all methods which take an Entity as an argument can also accept an entity ID instead.
		+	class <del>Vessel</del><ins>Ship</ins>
		+	{
		+	float foreShieldStrength;
		+	float aftShieldStrength;
		+	float energy;
		+
		+	float foreShieldMaxStrength;
		+	float aftShieldMaxStrength;
		+	float maxEnergy;
		+
		+	// something measure of max and current hull integrity?
		+
		+	// need to represent docking ports somehow
		+
		+	float cabinTemperature;
		+	integer maxCargoCapacity;
		+	integer freeCargoCapacity;
		+
		+	Consignment[] cargo;
		+
		+	Entity currentTarget;
		+	Entity[] escorts;
		+
		+	string roleName;
		+	string commanderName;
		+
		+	// short form of getScanClassRelativeTo(0) - ie the player
		+	integer getScanClass();
		+	integer getScanClassRelativeTo(Entity other);
		+
		+	float getDistanceFrom(Entity other);
		+	void noto(Vector3 destination);
		+	void notoEntity(Entity other, integer minimumDistance);
		+
		+	// These methods return the ID of the launched entity, or -1 on error or if the target vessel cannot
		+	// launch other vessels.
		+	integer launchVesselWithRole(string role);
		+	integer launchVesselWithName(string name);
		+	}

−	class Quaternion
		+	[[Category:Oolite scripting drafts]]
−	{
−	float x, y, z, w;
−	}
−
−	class Commodity
−	{
−	readonly string name;
−	readonly integer unitofMass; // grams, kgs, tons
−	}
−
−	class Consignment
−	{
−	Commodity commodity;
−	float quantity;
−	}
−
−	class Entity
−	{
−	readonly integer ID;
−	readonly Entity[] subentities;
−	Vector3 position;
−	Vector3 velocity;
−	Quaternion rotation;
−	// some property to set change in rotation per second?
−
−	static Entity getEntityWithID(integer ID);
−
−	void setAI(string AIName);
−	void pushAI(string AIName);
−	void popAI();
−	}
−
−	// Note all methods which take an Entity as an argument can also accept an entity ID instead.
−	class Vessel
−	{
−	float foreShieldStrength;
−	float aftShieldStrength;
−	float energy;
−
−	float foreShieldMaxStrength;
−	float aftShieldMaxStrength;
−	float maxEnergy;
−
−	// something measure of max and current hull integrity?
−
−	// need to represent docking ports somehow
−
−	float cabinTemperature;
−	integer maxCargoCapacity;
−	integer freeCargoCapacity;
−
−	Consignment[] cargo;
−
−	Entity currentTarget;
−	Entity[] escorts;
−
−	string roleName;
−	string commanderName;
−
−	// short form of getScanClassRelativeTo(0) - ie the player
−	integer getScanClass();
−	integer getScanClassRelativeTo(Entity other);
−
−	float getDistanceFrom(Entity other);
−	void noto(Vector3 destination);
−	void notoEntity(Entity other, integer minimumDistance);
−
−	// These methods return the ID of the launched entity, or -1 on error or if the target vessel cannot
−	// launch other vessels.
−	integer launchVesselWithRole(string role);
−	integer launchVesselWithName(string name);
−	}
−	</pre>
−
−	[[Category:Oolite Development]]

← Older revision		Revision as of 07:48, 25 March 2007
Line 1:		Line 1:
	Use this page to define the object model exposed by Oolite to the JavaScript interpreter.		Use this page to define the object model exposed by Oolite to the JavaScript interpreter.
−
−	The syntax used should be obvious to anyone with some OO programming experience.

	<tt><pre>		<tt><pre>

@@ Line 16: / Line 16: @@
 class Commodity
+{
-	readonly string Name;
+	readonly string name;
 	readonly integer unitofMass; // grams, kgs, tons
+}
@@ Line 74: / Line 74: @@
 	float getDistanceFrom(Entity other);
-	void Goto(Vector3 destination);
+	void noto(Vector3 destination);
-	void GotoEntity(Entity other, integer minimumDistance);
+	void notoEntity(Entity other, integer minimumDistance);
 	// These methods return the ID of the launched entity, or -1 on error or if the target vessel cannot

@@ Line 1: / Line 1: @@
 Use this page to define the object model exposed by Oolite to the JavaScript interpreter.
 class Vector3
+{
@@ Line 80: / Line 82: @@
 	integer launchVesselWithName(string name);
+}
-</pre></tt>
+</pre>