bwapi

Class Force

java.lang.Object

bwapi.Force

All Implemented Interfaces:

Comparable<Force>

public final class Force
extends Object
implements Comparable<Force>

The Force class is used to get information about each force in a match. Normally this is considered a team.

It is not called a team because players on the same force do not necessarily need to be allied at the beginning of a match.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Force other)
boolean	equals(Object o)
int	getID() Retrieves the unique ID that represents this Force.
String	getName() Retrieves the name of the Force.
List<Player>	getPlayers() Retrieves the set of players that belong to this Force.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getID

public int getID()

Retrieves the unique ID that represents this Force.

Returns:

An integer containing the ID for the Force.

getName

public String getName()

Retrieves the name of the Force.

Returns:

A String object containing the name of the force.

getPlayers

public List<Player> getPlayers()

Retrieves the set of players that belong to this Force.

Returns:

A List object containing the players that are part of this Force.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Force other)

Specified by:

compareTo in interface Comparable<Force>