Microsoft.Xna.Framework.Input
Enum KeyState

java.lang.Object
  java.lang.Enum<KeyState>
      Microsoft.Xna.Framework.Input.KeyState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KeyState>

public enum KeyState
extends java.lang.Enum<KeyState>

Identifies the state of a keyboard key.

Author:

Halofreak1990

Enum Constant Summary

Down
The key is pressed.

Up
The key is released.

Method Summary

int	getValue()
static KeyState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeyState[]	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

Down

public static final KeyState Down

The key is pressed.

Up

public static final KeyState Up

The key is released.

Method Detail

values

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

Returns:

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

valueOf

public static KeyState valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()