bwapi

Enum Race

java.lang.Object

java.lang.Enum<Race>

bwapi.Race

All Implemented Interfaces:

Serializable, Comparable<Race>

public enum Race
extends Enum<Race>

The Race enum is used to get information about a particular race.

For example, the default worker and supply provider UnitType.

As you should already know, Starcraft has three races: @Terran , @Protoss , and @Zerg .

See Also:

UnitType.getRace(), Player.getRace()

Enum Constant Summary

Enum Constants

Enum Constant and Description
None
Other
Protoss
Random
Select
Terran
Unknown
Unused
Zerg

Field Summary

Fields

Modifier and Type	Field and Description
int	id

Method Summary

Modifier and Type	Method and Description
UnitType	getCenter() Deprecated. As of 4.2.0 due to naming inconsistency. Use #getResourceDepot instead. See https://github.com/bwapi/bwapi/issues/621 for more information.
UnitType	getRefinery() Retrieves the default structure UnitType for this Race that is used to harvest gas from @Geysers.
UnitType	getResourceDepot() Retrieves the default resource depot UnitType that workers of this race can construct and return resources to.
UnitType	getSupplyProvider() Retrieves the default supply provider UnitType for this race that is used to construct units.
UnitType	getTransport() Retrieves the default transport UnitType for this race that is used to transport ground units across the map.
UnitType	getWorker() Retrieves the default worker type for this Race.
static Race	valueOf(String name) Returns the enum constant of this type with the specified name.
static Race[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Zerg

public static final Race Zerg

Terran

public static final Race Terran

Protoss

public static final Race Protoss

Other

public static final Race Other

Unused

public static final Race Unused

Select

public static final Race Select

Random

public static final Race Random

None

public static final Race None

Unknown

public static final Race Unknown

Field Detail

id

public final int id

Method Detail

values

public static Race[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Race c : Race.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Race valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getWorker

public UnitType getWorker()

Retrieves the default worker type for this Race.

In Starcraft, workers are the units that are used to construct structures.

Returns:

UnitType of the worker that this race uses.

getResourceDepot

public UnitType getResourceDepot()

Retrieves the default resource depot UnitType that workers of this race can construct and return resources to.

In Starcraft, the center is the very first structure of the Race's technology tree. Also known as its base of operations or resource depot.

Returns:

UnitType of the center that this race uses.

Since:

4.2.0

getCenter

@Deprecated
public UnitType getCenter()

Deprecated. As of 4.2.0 due to naming inconsistency. Use #getResourceDepot instead. See https://github.com/bwapi/bwapi/issues/621 for more information.

Deprecated. Use getResourceDepot instead.

getRefinery

public UnitType getRefinery()

Retrieves the default structure UnitType for this Race that is used to harvest gas from @Geysers.

In Starcraft, you must first construct a structure over a @Geyser in order to begin harvesting Vespene Gas.

Returns:

UnitType of the structure used to harvest gas.

getTransport

public UnitType getTransport()

Retrieves the default transport UnitType for this race that is used to transport ground units across the map.

In Starcraft, transports will allow you to carry ground units over unpassable terrain.

Returns:

UnitType for transportation.

getSupplyProvider

public UnitType getSupplyProvider()

Retrieves the default supply provider UnitType for this race that is used to construct units.

In Starcraft, training, morphing, or warping in units requires that the player has sufficient supply available for their Race.

Returns:

UnitType that provides the player with supply.