com.github.strikerx3.jxinput

Class XInputKeystroke

java.lang.Object

com.github.strikerx3.jxinput.XInputKeystroke

public class XInputKeystroke
extends Object

Represents a keystroke from an XInput device.

Author:

Ivan "StrikerX3" Oliveira

Method Summary

Modifier and Type	Method and Description
byte	getHidCode() Retrieves the HID code.
char	getUnicode() Retrieves the Unicode character.
byte	getUserIndex() Retrieves the user index (a.k.a. player number).
short	getVirtualKey() Retrieves the virtual key code.
boolean	isKeyDown() Determines whether this is a key down event.
boolean	isKeyUp() Determines whether this is a key up event.
boolean	isRepeat() Determines whether this is a key repeat event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVirtualKey

public short getVirtualKey()

Retrieves the virtual key code. Virtual key codes are defined in the XInputVirtualKeyCodes class.

Returns:

the virtual key code

getUnicode

public char getUnicode()

Retrieves the Unicode character.

Returns:

the Unicode character

isKeyDown

public boolean isKeyDown()

Determines whether this is a key down event.

Returns:

true if the key was pressed

isKeyUp

public boolean isKeyUp()

Determines whether this is a key up event.

Returns:

true if the key was released

isRepeat

public boolean isRepeat()

Determines whether this is a key repeat event.

Returns:

true if this is a key repetition

getUserIndex

public byte getUserIndex()

Retrieves the user index (a.k.a. player number).

Returns:

the user index

getHidCode

public byte getHidCode()

Retrieves the HID code.

Returns:

the HID code