Oolite JavaScript Reference: ShipGroup - Revision history

Another commander: /* leader */

2016-07-18T17:24:51Z

‎leader

Another commander: /* leader */

2016-07-18T17:23:22Z

‎leader

Ahruman: Added optional constructor parameters.

2010-06-28T08:55:32Z

Added optional constructor parameters.

Ahruman at 14:36, 20 June 2010

2010-06-20T14:36:10Z

Ahruman: Stylistic homogenization.

2010-06-20T14:35:06Z

Stylistic homogenization.

Ahruman: Moving Oolite JS reference into a correctly-named subcategory of Oolite scripting.

2010-06-19T14:06:14Z

Moving Oolite JS reference into a *correctly-named* subcategory of Oolite scripting.

Ahruman: Moving Oolite JS reference into a subcategory of Oolite scripting.

2010-06-19T13:57:09Z

Moving Oolite JS reference into a subcategory of Oolite scripting.

Eric Walch: Added an example of creating a group

2009-09-27T18:56:40Z

Added an example of creating a group

Eric Walch: Explained leader

2009-09-26T20:37:39Z

Explained leader

Eric Walch: Added shipGroups entry

2009-08-28T11:32:26Z

Added shipGroups entry

New page

{{Oolite-class-added|1.73}}

The '''<code>ShipGroup</code>''' class is a property of an <code>[[Oolite JavaScript Reference: Entity|Entity]]</code> representing a group of ships.

== Properties ==
=== <code>ships</code> ===
'''ships''' : Array of entites (read-only)

=== <code>leader</code> ===
'''leader''' : Entity (read/write)

=== <code>name</code> ===
'''name''' : String (read/write)
Name of the shipgroup.

=== <code>count</code> ===
'''count''' : Integer (read-only)
Number of ships in the group, including leader.

== Methods ==
=== <code>toString</code> ===
function '''toString'''()
Returns the whole group as a human readable string.

=== <code>addShip</code> ===
function '''addShip'''([ship : Entity])
Adds an entity to a group.

=== <code>removeShip</code> ===
function '''removeShip'''([ship : Entity])
Removes an entity to a group.

=== <code>containsShip</code> ===
function '''containsShip'''([ship : Entity])
Boolean, returns true when the ship belongs to the group. When not it returns false.

[[Category:Oolite scripting]]

@@ Line 18: / Line 18: @@
  '''leader''' : Ship (read/write)
 Defines a leader for the group. If the ship is not a member of the group, it is added.
-Note: The player's ship can be set as a group leader, but doing this is not recommended. The lack of JS AIs for the player means that exceptions during script execution and other unpredictable behaviour can be expected and, are in fact, very likely. This is a known issue in versions of the game up to and including 1.84.
+'''Note:''' The player's ship can be set as a group leader, but doing this is not recommended. The lack of JS AIs for the player means that exceptions during script execution and other unpredictable behaviour can be expected and, are in fact, very likely. This is a known issue in versions of the game up to and including 1.84.
 === <code>name</code> ===

@@ Line 18: / Line 18: @@
  '''leader''' : Ship (read/write)
 Defines a leader for the group. If the ship is not a member of the group, it is added.
 === <code>name</code> ===

@@ Line 2: / Line 2: @@
 == Constructor ==
- '''new ShipGroup'''() : ShipGroup
+ '''new ShipGroup'''([name : String [, leader : {{oojsclass|Ship}}]]) : ShipGroup
-Creates a new group
+Creates a new group, optionally specifying the <code>[[#name|name]]</code> and <code>[[#leader|leader]]</code>.
 '''Example:'''

← Older revision		Revision as of 14:06, 19 June 2010
Line 44:		Line 44:
	Boolean, returns true when the ship belongs to the group. When not it returns false.		Boolean, returns true when the ship belongs to the group. When not it returns false.

−	[[Category:Oolite JavaScript ~~reference~~]]	+	[[Category:Oolite JavaScript Reference]]

← Older revision		Revision as of 13:57, 19 June 2010
Line 44:		Line 44:
	Boolean, returns true when the ship belongs to the group. When not it returns false.		Boolean, returns true when the ship belongs to the group. When not it returns false.

−	[[Category:Oolite ~~scripting~~]]	+	[[Category:Oolite JavaScript reference]]

@@ Line 12: / Line 12: @@
 == Properties ==
 === <code>count</code> ===
- '''count''' : Integer (read-only)
+ '''count''' : Number (integer, read-only)
 Number of ships in the group, including leader.
 === <code>leader</code> ===
- '''leader''' : Entity (read/write)
+ '''leader''' : Ship (read/write)
 Defines a leader for the group. If the ship is not a member of the group, it is added.
@@ Line 24: / Line 24: @@
 === <code>ships</code> ===
- '''ships''' : Array of entites (read-only)
+ '''ships''' : Array ([[Oolite JavaScript Reference: Ship|Ship]]s, read-only)

@@ Line 1: / Line 1: @@
 == Constructor ==
  '''new ShipGroup'''() : ShipGroup
-Creates a new group to which ships can be added. e.g.
+Creates a new group
  var myGroup = new ShipGroup();
  myGroup.name = "My group";
@@ Line 11: / Line 9: @@
 == Properties ==
-=== <code>ships</code> ===
+=== <code>count</code> ===
- '''ships''' : Array of entites (read-only)
+ '''count''' : Integer (read-only)
 === <code>leader</code> ===
  '''leader''' : Entity (read/write)
-Defines a leader for the group. When the ship is not on the group list, he is added to the group.
+Defines a leader for the group. If the ship is not a member of the group, it is added.
 === <code>name</code> ===
  '''name''' : String (read/write)
-Name of the shipgroup.
+Name of the ship group.
-=== <code>count</code> ===
+=== <code>ships</code> ===
- '''count''' : Integer (read-only)
+ '''ships''' : Array of entites (read-only)
 == Methods ==
 === <code>addShip</code> ===
- function '''addShip'''([ship : Entity])
+ function '''addShip'''(ship : [[Oolite JavaScript Reference: Ship|Ship]])
-Adds an entity to a group.
+Add a ship to the group.
 === <code>removeShip</code> ===
- function '''removeShip'''([ship : Entity])
+ function '''removeShip'''(ship : [[Oolite JavaScript Reference: Ship|Ship]])
-Removes an entity to a group.
+Remove a ship from the group.
 [[Category:Oolite JavaScript Reference]]

← Older revision		Revision as of 18:56, 27 September 2009
Line 2:		Line 2:

	The '''<code>ShipGroup</code>''' class is a property of an <code>[[Oolite JavaScript Reference: Entity\|Entity]]</code> representing a group of ships.		The '''<code>ShipGroup</code>''' class is a property of an <code>[[Oolite JavaScript Reference: Entity\|Entity]]</code> representing a group of ships.
		+
		+	== Constructor ==
		+	'''new ShipGroup'''() : ShipGroup
		+	Creates a new group to which ships can be added. e.g.
		+	var myGroup = new ShipGroup();
		+	myGroup.name = "My group";
		+	myShip.group = myGroup;

	== Properties ==		== Properties ==

Oolite JavaScript Reference: ShipGroup - Revision history

Another commander: /* leader */

Another commander: /* leader */

Ahruman: Added optional constructor parameters.

Ahruman at 14:36, 20 June 2010

Ahruman: Stylistic homogenization.

Ahruman: Moving Oolite JS reference into a *correctly-named* subcategory of Oolite scripting.

Ahruman: Moving Oolite JS reference into a subcategory of Oolite scripting.

Eric Walch: Added an example of creating a group

Eric Walch: Explained leader

Eric Walch: Added shipGroups entry

Ahruman: Moving Oolite JS reference into a correctly-named subcategory of Oolite scripting.