bwapi

Enum MouseButton

java.lang.Object

java.lang.Enum<MouseButton>

bwapi.MouseButton

All Implemented Interfaces:

Serializable, Comparable<MouseButton>

public enum MouseButton
extends Enum<MouseButton>

An enumeration of mouse button inputs.

See Also:

Game.getMouseState(bwapi.MouseButton)

Enum Constant Summary

Enum Constants

Enum Constant and Description
M_LEFT
M_MAX
M_MIDDLE
M_RIGHT

Method Summary

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

M_LEFT

public static final MouseButton M_LEFT

M_RIGHT

public static final MouseButton M_RIGHT

M_MIDDLE

public static final MouseButton M_MIDDLE

M_MAX

public static final MouseButton M_MAX

Method Detail

values

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

Returns:

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

valueOf

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