Difference between revisions of "Oolite JavaScript Reference: ShipGroup"

From Elite Wiki
m (Moving Oolite JS reference into a *correctly-named* subcategory of Oolite scripting.)
(→‎leader)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Oolite-class-added|1.73}}
  
  +
The '''<code>ShipGroup</code>''' class is used to manage groups 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 ==
  
== Constructor ==
−
'''new ShipGroup'''() : ShipGroup
 +
'''new ShipGroup'''([name : String [, leader : {{oojsclass|Ship}}]]) : ShipGroup
−
Creates a new group to which ships can be added. e.g.
 +
Creates a new group, optionally specifying the <code>[[#name|name]]</code> and <code>[[#leader|leader]]</code>.
  +
  +
'''Example:'''
 
var myGroup = new ShipGroup();
  
var myGroup = new ShipGroup();
 
myGroup.name = "My group";
  
myGroup.name = "My group";
Line 11: Line 9:
   
 
== Properties ==
  
== Properties ==
−
=== <code>ships</code> ===
 +
=== <code>count</code> ===
−
'''ships''' : Array of entites (read-only)
 +
'''count''' : Number (integer, read-only)
  +
Number of ships in the group, including leader.
   
 
=== <code>leader</code> ===
  
=== <code>leader</code> ===
−
'''leader''' : Entity (read/write)
 +
'''leader''' : Ship (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.
  +
'''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> ===
  
=== <code>name</code> ===
 
'''name''' : String (read/write)
  
'''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 ([[Oolite JavaScript Reference: Ship|Ship]]s, read-only)
−
Number of ships in the group, including leader.
  
   
   
 
== Methods ==
  
== Methods ==
−
=== <code>toString</code> ===
  
−
function '''toString'''()
  
−
Returns the whole group as a human readable string.
  
−  
 
=== <code>addShip</code> ===
  
=== <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>containsShip</code> ===
  +
function '''containsShip'''(ship : [[Oolite JavaScript Reference: Ship|Ship]]) : Boolean
  +
Returns <code>true</code> if <code>ship</code> is a member of the group, <code>false</code> otherwise.
   
 
=== <code>removeShip</code> ===
  
=== <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.
   
−
=== <code>containsShip</code> ===
  
−
function '''containsShip'''([ship : Entity])
  
−
Boolean, returns true when the ship belongs to the group. When not it returns false.
  
   
 
[[Category:Oolite JavaScript Reference]]
  
[[Category:Oolite JavaScript Reference]]

Latest revision as of 18:24, 18 July 2016

The ShipGroup class is used to manage groups of ships.

Constructor

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;

Properties

count

count : Number (integer, read-only)

Number of ships in the group, including leader.

leader

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.

name

name : String (read/write)

Name of the ship group.

ships

ships : Array (Ships, 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.

Retrieved from "http://backup.witchspacewiki.org/index.php?title=Oolite_JavaScript_Reference:_ShipGroup&oldid=53567"