bwapi

Enum CoordinateType

java.lang.Object

java.lang.Enum<CoordinateType>

bwapi.CoordinateType

All Implemented Interfaces:

Serializable, Comparable<CoordinateType>

public enum CoordinateType
extends Enum<CoordinateType>

The coordinate type enumeration for relative drawing positions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Map Position.Origin (0,0) corresponds to the top left corner of the map
Mouse Position.Origin (0,0) corresponds to the top left corner of the mouse cursor
None A default value for uninitialized coordinate types.
Screen Position.Origin (0,0) corresponds to the top left corner of the screen

Method Summary

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

None

public static final CoordinateType None

A default value for uninitialized coordinate types.

Screen

public static final CoordinateType Screen

Position.Origin (0,0) corresponds to the top left corner of the screen

Map

public static final CoordinateType Map

Position.Origin (0,0) corresponds to the top left corner of the map

Mouse

public static final CoordinateType Mouse

Position.Origin (0,0) corresponds to the top left corner of the mouse cursor

Method Detail

values

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

Returns:

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

valueOf

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