Input Functions

Functions for keyboard and gamepad input detection.

mouseClicked

mouseClicked(button:String = 'left'):Bool

Returns whether the Mouse button just got clicked in this frame.

button - Can be: "left", "middle" or "right". Defaults to "left"

Examples:

mouseClicked() - Checks for Left click.
mouseClicked('right') - Checks for Right click.

mousePressed

mousePressed(button:String = 'left'):Bool

Returns whether the Mouse button is being held currently.

button - Can be: "left", "middle" or "right". Defaults to "left"

mouseReleased

mouseReleased(button:String = 'left'):Bool

Returns whether the Mouse button was just released in this frame.

button - Can be: "left", "middle" or "right". Defaults to "left"

getMouseX

getMouseX(camera:String = 'game'):Float

Returns Mouse's Screen X from a Camera.

camera - Can be "game", "hud" or "other".

Examples:

getMouseX() - Mouse X on Game Camera.
getMouseX('hud') - Mouse X on HUD Camera.

getMouseY

getMouseY(camera:String = 'game'):Float

Returns Mouse's Screen Y from a Camera.

camera - Can be "game", "hud" or "other".

keyJustPressed

keyJustPressed(button:String):Bool

Returns whether a keybind button just got pressed on a controller or keyboard.

button - Buttons: "left", "down", "up", "right", "ui_left", "ui_down", "ui_up", "ui_right", "accept", "back", "pause", "reset", "volume_mute", "volume_up_down", "debug_1", "debug_2".

Examples:

keyJustPressed('up') - Pressed Up Note button.
keyJustPressed('ui_up') - Pressed Menu Up button, this is a different keybind from Up Note despite the default keys being the same.

keyPressed

keyPressed(button:String):Bool

Returns whether a keybind button is being held on a controller or keyboard.

button - Same as "keyJustPressed".

keyReleased

keyReleased(button:String):Bool

Returns whether a keybind button was just released on a controller or keyboard.

button - Same as "keyJustPressed".

keyboardJustPressed

keyboardJustPressed(button:String):Bool

Returns whether a specific keyboard button just got pressed.

button - Click here for the full list of buttons.

Examples:

keyboardJustPressed('ENTER') - Pressed Enter in your keyboard.

keyboardJustPressed('F5') - Pressed F5 in your keyboard.

keyboardPressed

keyboardPressed(button:String):Bool

Returns whether a specific keyboard button is being pressed.

button - Click here for the full list of buttons.

keyboardReleased

keyboardReleased(button:String):Bool

Returns whether a specific keyboard button was just released.

button - Click here for the full list of buttons.

anyGamepadJustPressed

anyGamepadJustPressed(button:String):Bool

Returns whether a specific gamepad button just got pressed in any controllers.

button - Click here for the full list of buttons.

Examples:

anyGamepadJustPressed('DPAD_LEFT') - Pressed Arrow Left in any gamepad.

anyGamepadJustPressed('X') - Pressed X in any gamepad.

anyGamepadPressed

anyGamepadPressed(button:String):Bool

Returns whether a specific gamepad button is being pressed in any controllers.

button - Click here for the full list of buttons.

anyGamepadReleased

anyGamepadReleased(button:String):Bool

Returns whether a specific gamepad button was just released in any controllers.

button - Click here for the full list of buttons.

gamepadJustPressed

gamepadJustPressed(id:Int, button:String):Bool

Returns whether a specific gamepad button just got pressed in a specific controller.

id - Controller ID, by detection order.
button - Click here for the full list of buttons.

Examples:

gamepadJustPressed(0, 'DPAD_LEFT') - Pressed Arrow Left in controller #1.

gamepadJustPressed(1, 'X') - Pressed X in in controller #2.

gamepadPressed

gamepadPressed(id:Int, button:String):Bool

Returns whether a specific gamepad button is being pressed in a specific controller.

id - Controller ID, by detection order.
button - Click here for the full list of buttons.

gamepadReleased

gamepadReleased(id:Int, button:String):Bool

Returns whether a specific gamepad button was just released in a specific controller.

id - Controller ID, by detection order.
button - Click here for the full list of buttons.

gamepadAnalogX

gamepadAnalogX(id:Int, ?leftStick:Bool = true):Float

Returns the Analog X value in a specific controller, ranges from -1 to 1.

id - Controller ID, by detection order.
button - Left or Right analog? Default is Left (true).

Examples:

gamepadAnalogX(0) - Returns Left Analog X of controller #1.

gamepadAnalogX(1, false) - Returns Right X Analog of controller #2.

gamepadAnalogY

gamepadAnalogY(id:Int, ?leftStick:Bool = true):Float

Returns the Analog Y value in a specific controller, ranges from -1 to 1.

id - Controller ID, by detection order.
button - Left or Right analog? Default is Left (true).