Oolite JavaScript Reference: ShipGroup

The ShipGroup class is used to manage groups of ships.

Constructor

new ShipGroup() : ShipGroup

Creates a new group

Example:

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

Properties

count

count : Integer (read-only)

Number of ships in the group, including leader.

leader

leader : Entity (read/write)

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

name

name : String (read/write)

Name of the ship group.

ships

ships : Array of entites (read-only)

Methods

addShip

function addShip(ship : Ship)

Add a ship to the group.

containsShip

function containsShip(ship : Ship) : Boolean

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

removeShip

function removeShip(ship : Ship)

Remove a ship from the group.