Input

interface Input

Functions

addInputProcessor

abstract fun addInputProcessor(processor: InputProcessor)

Add a InputProcessor to receive input callbacks.

areAllKeysPressed

open fun areAllKeysPressed(vararg keys: Key): Boolean

Determines if all the specified keys are currently pressed.

areAnyKeysPressed

open fun areAnyKeysPressed(vararg keys: Key): Boolean

Determines if any of the specified keys are currently pressed.

areNoKeysPressed

open fun areNoKeysPressed(vararg keys: Key): Boolean

Determines if all the specified keys are NOT currently pressed.

cancelVibrate

open fun cancelVibrate()

Stops the vibrator.

getDeltaX

abstract fun getDeltaX(pointer: Pointer): Int

getDeltaY

abstract fun getDeltaY(pointer: Pointer): Int

getGamepadButtonPressure

abstract fun getGamepadButtonPressure(button: GameButton, gamepad: Int = 0): Float

getGamepadJoystickDistance

abstract fun getGamepadJoystickDistance(stick: GameStick, gamepad: Int = 0): Point

getGamepadJoystickXDistance

abstract fun getGamepadJoystickXDistance(stick: GameStick, gamepad: Int = 0): Float

getGamepadJoystickYDistance

abstract fun getGamepadJoystickYDistance(stick: GameStick, gamepad: Int = 0): Float

getPressure

abstract fun getPressure(pointer: Pointer): Float

getX

abstract fun getX(pointer: Pointer): Int

getY

abstract fun getY(pointer: Pointer): Int

hideSoftKeyboard

abstract fun hideSoftKeyboard()

Hides the on-screen keyboard. Applicable for mobile only.

inputProcessor

open fun inputProcessor(setup: InputProcessBuilder.() -> Unit): InputProcessor

Creates and adds a new InputProcessor to receive input callbacks using a InputProcessBuilder.

isGamepadButtonJustPressed

abstract fun isGamepadButtonJustPressed(button: GameButton, gamepad: Int = 0): Boolean

isGamepadButtonJustReleased

abstract fun isGamepadButtonJustReleased(button: GameButton, gamepad: Int = 0): Boolean

isGamepadButtonPressed

abstract fun isGamepadButtonPressed(button: GameButton, gamepad: Int = 0): Boolean

isJustTouched

abstract fun isJustTouched(pointer: Pointer): Boolean

isKeyJustPressed

abstract fun isKeyJustPressed(key: Key): Boolean

Determines if the key is was just pressed within the past frame.

isKeyJustReleased

abstract fun isKeyJustReleased(key: Key): Boolean

Determines if the key was just released within the past frame.

isKeyPressed

abstract fun isKeyPressed(key: Key): Boolean

Determines if the key is currently pressed down.

isTouching

abstract fun isTouching(pointer: Pointer): Boolean

abstract fun isTouching(totalPointers: Int): Boolean

isTouchJustReleased

abstract fun isTouchJustReleased(pointer: Pointer): Boolean

removeInputProcessor

abstract fun removeInputProcessor(processor: InputProcessor)

Remove a InputProcessor to from receiving input callbacks.

setCursorPosition

abstract fun setCursorPosition(x: Int, y: Int)

showSoftKeyboard

abstract fun showSoftKeyboard()

Shows an on-screen keyboard. Applicable for mobile only.

vibrate

open fun vibrate(duration: Duration)

Vibrates for the given amount of time.

Properties

axisLeftX

abstract val axisLeftX: Float

axisLeftY

abstract val axisLeftY: Float

axisRightX

abstract val axisRightX: Float

axisRightY

abstract val axisRightY: Float

catchKeys

abstract val catchKeys: MutableList<Key>

A list of Key types to catch to prevent calling the current platforms default functionality.

connectedGamepads

abstract val connectedGamepads: List<GamepadInfo>

currentEventTime

abstract val currentEventTime: Long

deltaX

abstract val deltaX: Int

deltaY

abstract val deltaY: Int

gamepads

abstract val gamepads: Array<GamepadInfo>

inputProcessors

abstract val inputProcessors: List<InputProcessor>

isTouching

abstract val isTouching: Boolean

justTouched

abstract val justTouched: Boolean

pressure

abstract val pressure: Float

abstract val x: Int

abstract val y: Int

Inheritors

AndroidInput

JsInput

LwjglInput

Extensions

gestureController

fun Input.gestureController(setup: GestureProcessorBuilder.() -> Unit): GestureController

Creates a new GestureController using a GestureProcessorBuilder and calls Input.addInputProcessor when built.