Difference between revisions of "Oolite JavaScript Reference: ShipGroup"

Revision as of 19:56, 27 September 2009

This class was added in Oolite test release 1.73.

The ShipGroup class is a property of an Entity representing a group of ships.

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;

ships : Array of entites (read-only)

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.

name : String (read/write)

Name of the shipgroup.

count : Integer (read-only)

Number of ships in the group, including leader.

function toString()

Returns the whole group as a human readable string.

function addShip([ship : Entity])

Adds an entity to a group.

function removeShip([ship : Entity])

Removes an entity to a group.

function containsShip([ship : Entity])

Boolean, returns true when the ship belongs to the group. When not it returns false.

@@ 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.
+== 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 ==