Input

object Input

Input A utility class for generating input to the canvas and retrieving information from the canvas.

Functions

blocking

fun blocking(): Boolean

Whether or not user input is being relayed to the client instance.

fun blocking(b: Boolean)

Sets whether or not to block user input from being relayed to the client instance.

drag

fun drag(start: Point, dest: Point): Boolean

Holds down the left or right button, and drags the mouse to the specified location.

fun drag(x1: Int, y1: Int, x2: Int, y2: Int): Boolean

dragUntil

fun dragUntil(startX: Int, startY: Int, minY: Int, maxY: Int, yIncrement: Int, until: () -> Boolean): Boolean

inputBounds

fun inputBounds(): Rectangle

inputDimensions

fun inputDimensions(): Dimension

isTargetInViewport

fun isTargetInViewport(target: Point): Boolean

keyboard

fun keyboard(): Boolean

Whether or not keyboard events are allowed.

fun keyboard(b: Boolean)

Allow keyboard events to be relayed regardless of .blocking.

press

fun press(p: Point): Boolean

fun press(x: Int, y: Int): Boolean

Simulates the specified mouse button being pressed.

pressKey

fun pressKey(keyCode: Int)

release

fun release(p: Point): Boolean

fun release(x: Int, y: Int): Boolean

Simulates the specified mouse button being released.

releaseKey

fun releaseKey(keyCode: Int)

send

fun send(s: String): Boolean

Sends keys to the client, represented in a String, and a new-line at the end. Unicode commands are acceptable input, for example, \t

sendln

fun sendln(s: String): Boolean

Sends keys to the client, represented in a String, and a new-line at the end. Unicode commands are acceptable input, for example, \t

speed

fun speed(): Int

Returns the current mouse speed.

fun speed(s: Int): Int

Set the relative speed for mouse movements. This is a sensitive function and should be used in exceptional circumstances for a short period of time only.

tap

fun tap(point: Point, durationMs: Int = 0, getPoint: Callable<Point> = Callable { Point.Nil }): Boolean

fun tap(x: Int, y: Int, durationMs: Int = 0, getPoint: Callable<Point> = Callable { Point.Nil }): Boolean

Simulates the mouse clicking the specified button at the specified location.

Properties

blocking

val blocking: AtomicBoolean

keyboard

val keyboard: AtomicBoolean

KEYCODE_BACKSPACE

const val KEYCODE_BACKSPACE: Int

KEYCODE_SHIFT

const val KEYCODE_SHIFT: Int

MAXIMUM_SPEED

const val MAXIMUM_SPEED: Int = 100

MINIMUM_SPEED

const val MINIMUM_SPEED: Int = 1