Class TInputContext

java.lang.Object

com.thecsdev.commonmc.api.client.gui.util.TInputContext

@Environment(CLIENT)
public final class TInputContext
extends Object

Holds information about a user's input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TInputContext.InputDiscoveryPhase	This refers to the current "phase" at which an input is being handled. Each input phase has its own unique behaviors.
static enum	TInputContext.InputType	Represents an input's type.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object obj)
final @Nullable Character	getCharacter()
final TInputContext.InputType	getInputType()	Returns the TInputContext.InputType.
final @Nullable Integer	getKeyCode()
final @Nullable Integer	getKeyModifiers()
final @Nullable Integer	getMouseButton()
final @Nullable Double	getMouseDeltaX()
final @Nullable Double	getMouseDeltaY()
final @Nullable Double	getMouseX()
final @Nullable Double	getMouseY()
final @Nullable Integer	getScanCode()
final @Nullable Double	getScrollX()
final @Nullable Double	getScrollY()
final int	hashCode()
static final TInputContext	ofCharType(char character, int modifiers)	Creates and returns a TInputContext for TInputContext.InputType.CHAR_TYPE.
static final TInputContext	ofKeyPress(int keyCode, int scanCode, int modifiers)	Creates and returns a TInputContext for TInputContext.InputType.KEY_PRESS.
static final TInputContext	ofKeyRelease(int keyCode, int scanCode, int modifiers)	Creates and returns a TInputContext for TInputContext.InputType.KEY_RELEASE.
static final TInputContext	ofMouseDrag(double mouseX, double mouseY, int button, double deltaX, double deltaY)	Creates and returns a TInputContext for TInputContext.InputType.MOUSE_DRAG.
static final TInputContext	ofMouseMove(double mouseX, double mouseY)	Creates and returns a TInputContext for TInputContext.InputType.MOUSE_RELEASE.
static final TInputContext	ofMousePress(double mouseX, double mouseY, int button)	Creates and returns a TInputContext for TInputContext.InputType.MOUSE_PRESS.
static final TInputContext	ofMouseRelease(double mouseX, double mouseY, int button)	Creates and returns a TInputContext for TInputContext.InputType.MOUSE_RELEASE.
static final TInputContext	ofMouseScroll(double mouseX, double mouseY, double scrollX, double scrollY)	Creates and returns a TInputContext for TInputContext.InputType.MOUSE_SCROLL.

Methods inherited from class Object

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

Method Details

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

ofKeyPress

public static final TInputContext ofKeyPress(int keyCode,
 int scanCode,
 int modifiers)

Creates and returns a TInputContext for TInputContext.InputType.KEY_PRESS.

Parameters:

keyCode - The key code.

scanCode - The scan code.

modifiers - The key modifiers.

ofKeyRelease

public static final TInputContext ofKeyRelease(int keyCode,
 int scanCode,
 int modifiers)

Creates and returns a TInputContext for TInputContext.InputType.KEY_RELEASE.

Parameters:

keyCode - The key code.

scanCode - The scan code.

modifiers - The key modifiers.

ofCharType

public static final TInputContext ofCharType(char character,
 int modifiers)

Creates and returns a TInputContext for TInputContext.InputType.CHAR_TYPE.

Parameters:

character - The typed Character.

modifiers - The key modifiers.

ofMousePress

public static final TInputContext ofMousePress(double mouseX,
 double mouseY,
 int button)

Creates and returns a TInputContext for TInputContext.InputType.MOUSE_PRESS.

Parameters:

mouseX - Mouse X position.

mouseY - Mouse Y position.

button - The pressed mouse button.

ofMouseRelease

public static final TInputContext ofMouseRelease(double mouseX,
 double mouseY,
 int button)

Creates and returns a TInputContext for TInputContext.InputType.MOUSE_RELEASE.

Parameters:

mouseX - Mouse X position.

mouseY - Mouse Y position.

button - The pressed mouse button.

ofMouseMove

public static final TInputContext ofMouseMove(double mouseX,
 double mouseY)

Creates and returns a TInputContext for TInputContext.InputType.MOUSE_RELEASE.

Parameters:

mouseX - Mouse X position.

mouseY - Mouse Y position.

ofMouseScroll

public static final TInputContext ofMouseScroll(double mouseX,
 double mouseY,
 double scrollX,
 double scrollY)

Creates and returns a TInputContext for TInputContext.InputType.MOUSE_SCROLL.

Parameters:

mouseX - Mouse X position.

mouseY - Mouse Y position.

scrollX - Horizontal scroll amount.

scrollY - Vertical scroll amount.

ofMouseDrag

public static final TInputContext ofMouseDrag(double mouseX,
 double mouseY,
 int button,
 double deltaX,
 double deltaY)

Creates and returns a TInputContext for TInputContext.InputType.MOUSE_DRAG.

Parameters:

mouseX - Mouse X position.

mouseY - Mouse Y position.

button - The pressed mouse button.

deltaX - The mouse movement's delta X.

deltaY - The mouse movement's delta Y.

getInputType

public final TInputContext.InputType getInputType()

Returns the TInputContext.InputType.

getKeyCode

@Nullable
public final @Nullable Integer getKeyCode()

See Also:

• TInputContext.InputType.KEY_PRESS
• TInputContext.InputType.KEY_RELEASE

getScanCode

@Nullable
public final @Nullable Integer getScanCode()

See Also:

• TInputContext.InputType.KEY_PRESS
• TInputContext.InputType.KEY_RELEASE

getKeyModifiers

@Nullable
public final @Nullable Integer getKeyModifiers()

See Also:

• TInputContext.InputType.KEY_PRESS
• TInputContext.InputType.KEY_RELEASE
• TInputContext.InputType.CHAR_TYPE

getCharacter

@Nullable
public final @Nullable Character getCharacter()

See Also:

• TInputContext.InputType.CHAR_TYPE

getMouseX

@Nullable
public final @Nullable Double getMouseX()

See Also:

• TInputContext.InputType.MOUSE_PRESS
• TInputContext.InputType.MOUSE_RELEASE
• TInputContext.InputType.MOUSE_MOVE
• TInputContext.InputType.MOUSE_SCROLL

getMouseY

@Nullable
public final @Nullable Double getMouseY()

See Also:

• TInputContext.InputType.MOUSE_PRESS
• TInputContext.InputType.MOUSE_RELEASE
• TInputContext.InputType.MOUSE_MOVE
• TInputContext.InputType.MOUSE_SCROLL

getMouseButton

@Nullable
public final @Nullable Integer getMouseButton()

See Also:

• TInputContext.InputType.MOUSE_PRESS
• TInputContext.InputType.MOUSE_RELEASE

getScrollX

@Nullable
public final @Nullable Double getScrollX()

See Also:

• TInputContext.InputType.MOUSE_SCROLL

getScrollY

@Nullable
public final @Nullable Double getScrollY()

See Also:

• TInputContext.InputType.MOUSE_SCROLL

getMouseDeltaX

@Nullable
public final @Nullable Double getMouseDeltaX()

See Also:

• TInputContext.InputType.MOUSE_DRAG

getMouseDeltaY

@Nullable
public final @Nullable Double getMouseDeltaY()

See Also:

• TInputContext.InputType.MOUSE_DRAG