Difference between revisions of "Oolite JavaScript Reference: ShipGroup"

Revision as of 08:55, 28 June 2010

The ShipGroup class is used to manage groups of ships.

new ShipGroup([name : String [, leader : Ship]]) : ShipGroup

Creates a new group, optionally specifying the name and leader.

Example:

var myGroup = new ShipGroup();
myGroup.name = "My group";
myShip.group = myGroup;

count : Number (integer, read-only)

Number of ships in the group, including leader.

leader : Ship (read/write)

Defines a leader for the group. If the ship is not a member of the group, it is added.

name : String (read/write)

Name of the ship group.

ships : Array (Ships, read-only)

function addShip(ship : Ship)

Add a ship to the group.

function containsShip(ship : Ship) : Boolean

Returns true if ship is a member of the group, false otherwise.

function removeShip(ship : Ship)

Remove a ship from the group.

@@ 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:'''