Difference between revisions of "Oolite JavaScript Reference: ShipGroup"

Revision as of 15:36, 20 June 2010

The ShipGroup class is used to manage groups of ships.

new ShipGroup() : ShipGroup

Creates a new group

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 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)