bwapi

Enum UnitCommandType

java.lang.Object

java.lang.Enum<UnitCommandType>

bwapi.UnitCommandType

All Implemented Interfaces:

Serializable, Comparable<UnitCommandType>

public enum UnitCommandType
extends Enum<UnitCommandType>

A representation of a unit command in BWAPI. This is used by bots to notify BWAPI which commands to use. BWAPI filters commands accordingly and then converts them to Broodwar commands, which differ in complexity.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Attack_Move
Attack_Unit
Build
Build_Addon
Burrow
Cancel_Addon
Cancel_Construction
Cancel_Morph
Cancel_Research
Cancel_Train
Cancel_Train_Slot
Cancel_Upgrade
Cloak
Decloak
Follow
Gather
Halt_Construction
Hold_Position
Land
Lift
Load
Morph
Move
None
Patrol
Place_COP
Repair
Research
Return_Cargo
Right_Click_Position
Right_Click_Unit
Set_Rally_Position
Set_Rally_Unit
Siege
Stop
Train
Unburrow
Unknown
Unload
Unload_All
Unload_All_Position
Unsiege
Upgrade
Use_Tech
Use_Tech_Position
Use_Tech_Unit

Method Summary

Modifier and Type	Method and Description
static UnitCommandType	valueOf(String name) Returns the enum constant of this type with the specified name.
static UnitCommandType[]	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

Attack_Move

public static final UnitCommandType Attack_Move

Attack_Unit

public static final UnitCommandType Attack_Unit

Build

public static final UnitCommandType Build

Build_Addon

public static final UnitCommandType Build_Addon

Train

public static final UnitCommandType Train

Morph

public static final UnitCommandType Morph

Research

public static final UnitCommandType Research

Upgrade

public static final UnitCommandType Upgrade

Set_Rally_Position

public static final UnitCommandType Set_Rally_Position

Set_Rally_Unit

public static final UnitCommandType Set_Rally_Unit

Move

public static final UnitCommandType Move

Patrol

public static final UnitCommandType Patrol

Hold_Position

public static final UnitCommandType Hold_Position

Stop

public static final UnitCommandType Stop

Follow

public static final UnitCommandType Follow

Gather

public static final UnitCommandType Gather

Return_Cargo

public static final UnitCommandType Return_Cargo

Repair

public static final UnitCommandType Repair

Burrow

public static final UnitCommandType Burrow

Unburrow

public static final UnitCommandType Unburrow

Cloak

public static final UnitCommandType Cloak

Decloak

public static final UnitCommandType Decloak

Siege

public static final UnitCommandType Siege

Unsiege

public static final UnitCommandType Unsiege

Lift

public static final UnitCommandType Lift

Land

public static final UnitCommandType Land

Load

public static final UnitCommandType Load

Unload

public static final UnitCommandType Unload

Unload_All

public static final UnitCommandType Unload_All

Unload_All_Position

public static final UnitCommandType Unload_All_Position

Right_Click_Position

public static final UnitCommandType Right_Click_Position

Right_Click_Unit

public static final UnitCommandType Right_Click_Unit

Halt_Construction

public static final UnitCommandType Halt_Construction

Cancel_Construction

public static final UnitCommandType Cancel_Construction

Cancel_Addon

public static final UnitCommandType Cancel_Addon

Cancel_Train

public static final UnitCommandType Cancel_Train

Cancel_Train_Slot

public static final UnitCommandType Cancel_Train_Slot

Cancel_Morph

public static final UnitCommandType Cancel_Morph

Cancel_Research

public static final UnitCommandType Cancel_Research

Cancel_Upgrade

public static final UnitCommandType Cancel_Upgrade

Use_Tech

public static final UnitCommandType Use_Tech

Use_Tech_Position

public static final UnitCommandType Use_Tech_Position

Use_Tech_Unit

public static final UnitCommandType Use_Tech_Unit

Place_COP

public static final UnitCommandType Place_COP

None

public static final UnitCommandType None

Unknown

public static final UnitCommandType Unknown

Method Detail

values

public static UnitCommandType[] 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 (UnitCommandType c : UnitCommandType.values())
    System.out.println(c);

Returns:

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

valueOf

public static UnitCommandType 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