org.mini2Dx.core

Interface Input

public interface Input

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClipboardContents() Returns the clipboard contents.
org.mini2Dx.gdx.utils.Array<GamePad>	getGamePads() Returns the list of known GamePads connected to the device.
int	getX() Returns the mouse/touch screen X coordinate
int	getY() Returns the mouse/touch screen Y coordinate
boolean	hasClipboardContents() Returns if the clipboard has contents.
boolean	isClipboardSupported() Returns if the clipboard is supported by the current platform.
boolean	isKeyDown(int key) Returns if a keyboard key is down
boolean	isKeyJustPressed(int key) Returns if a keyboard key was just pressed (down, then released)
boolean	isKeyUp(int key) Returns if a keyboard key is up
boolean	justTouched() Returns if the the screen was just touched or the mouse was just clicked
PS4GamePad	newPS4GamePad(GamePad gamePad) Wraps a GamePad as a PS4GamePad
SwitchDualJoyConGamePad	newSwitchDualJoyConGamePad(GamePad gamePad) Wraps a GamePad as a SwitchDualJoyConGamePad
SwitchJoyConLGamePad	newSwitchJoyConLGamePad(GamePad gamePad) Wraps a GamePad as a SwitchJoyConLGamePad
SwitchJoyConRGamePad	newSwitchJoyConRGamePad(GamePad gamePad) Wraps a GamePad as a SwitchJoyConRGamePad
XboxGamePad	newXboxGamePad(GamePad gamePad) Wraps a GamePad as a XboxGamePad
void	setClipboardContents(java.lang.String contents) Sets the clipboard contents.
void	setGamePadConnectionListener(GamePadConnectionListener listener, boolean notifyExisting) Sets the GamePadConnectionListener for handling GamePad connects/disconnects
void	setInputProcessor(org.mini2Dx.gdx.InputProcessor inputProcessor) Sets the InputProcessor for handling mouse/keyboard/touch events
void	setOnScreenKeyboardVisible(boolean visible) Sets on mobile and consoles of the on-screen keyboard should appear.

Method Detail

setInputProcessor

void setInputProcessor(org.mini2Dx.gdx.InputProcessor inputProcessor)

Sets the InputProcessor for handling mouse/keyboard/touch events

Parameters:

inputProcessor - The InputProcessor to use

setGamePadConnectionListener

void setGamePadConnectionListener(GamePadConnectionListener listener,
                                  boolean notifyExisting)

Sets the GamePadConnectionListener for handling GamePad connects/disconnects

Parameters:

listener - The GamePadConnectionListener to use

notifyExisting - True if the listener should receive a GamePadConnectionListener.onConnect(GamePad) call for existing controllers connected

setOnScreenKeyboardVisible

void setOnScreenKeyboardVisible(boolean visible)

Sets on mobile and consoles of the on-screen keyboard should appear. Note: The keyboard may close itself via OS events. Input.Keys.ESCAPE is sent when the keyboard is closed.

Parameters:

visible - True if the keyboard should appear

getGamePads

org.mini2Dx.gdx.utils.Array<GamePad> getGamePads()

Returns the list of known GamePads connected to the device.

Returns:

An empty Array if no GamePads are present.

newPS4GamePad

PS4GamePad newPS4GamePad(GamePad gamePad)

Wraps a GamePad as a PS4GamePad

Parameters:

gamePad - The underlying GamePad instance

Returns:

A new instance of PS4GamePad

newSwitchDualJoyConGamePad

SwitchDualJoyConGamePad newSwitchDualJoyConGamePad(GamePad gamePad)

Wraps a GamePad as a SwitchDualJoyConGamePad

Parameters:

gamePad - The underlying GamePad instance

Returns:

A new instance of SwitchDualJoyConGamePad

newSwitchJoyConLGamePad

SwitchJoyConLGamePad newSwitchJoyConLGamePad(GamePad gamePad)

Wraps a GamePad as a SwitchJoyConLGamePad

Parameters:

gamePad - The underlying GamePad instance

Returns:

A new instance of SwitchJoyConLGamePad

newSwitchJoyConRGamePad

SwitchJoyConRGamePad newSwitchJoyConRGamePad(GamePad gamePad)

Wraps a GamePad as a SwitchJoyConRGamePad

Parameters:

gamePad - The underlying GamePad instance

Returns:

A new instance of SwitchJoyConRGamePad

newXboxGamePad

XboxGamePad newXboxGamePad(GamePad gamePad)

Wraps a GamePad as a XboxGamePad

Parameters:

gamePad - The underlying GamePad instance

Returns:

A new instance of XboxGamePad

getX

int getX()

Returns the mouse/touch screen X coordinate

Returns:

The x coordinate

getY

int getY()

Returns the mouse/touch screen Y coordinate

Returns:

The y coordinate

isKeyJustPressed

boolean isKeyJustPressed(int key)

Returns if a keyboard key was just pressed (down, then released)

Parameters:

key - The keyboard keycode

Returns:

True if the key was just pressed (down, then released)

isKeyDown

boolean isKeyDown(int key)

Returns if a keyboard key is down

Parameters:

key - The keyboard keycode

Returns:

True if the key is down

isKeyUp

boolean isKeyUp(int key)

Returns if a keyboard key is up

Parameters:

key - The keyboard keycode

Returns:

True if the key is down

justTouched

boolean justTouched()

Returns if the the screen was just touched or the mouse was just clicked

Returns:

True if the screen was touched or mouse button pressed down then released

isClipboardSupported

boolean isClipboardSupported()

Returns if the clipboard is supported by the current platform.

Returns:

True if clipboard is supported by the current platform

hasClipboardContents

boolean hasClipboardContents()

Returns if the clipboard has contents. Recommended to use instead of getClipboardContents() to prevent triggering unwanted clipboard access notifications (iOS >= 14)

Returns:

True if the system clipboard has contents

getClipboardContents

java.lang.String getClipboardContents()

Returns the clipboard contents.

Returns:

Clipboard contents

setClipboardContents

void setClipboardContents(java.lang.String contents)

Sets the clipboard contents. Isn't guaranteed to be a synchronous operations so don't rely on getting contents just after setting them.

Parameters:

contents - Clipboard contents to be set