Input

Reference for the input API.

Functions

input.show_cursor

Show the mouse cursor.

---@param show bool
function input.show_cursor(show): nil

input.disable_input

Disable input to Lexis.

---@param disable bool
function input.disable_input(disable): nil

input.key

Get a key state.

---@param vk integer
function input.key(vk): input_keyboard_state

input.mouse

Get a mouse key state.

---@param vk integer
function input.mouse(vk): input_mouse_state

input.pad

Get a controller key state.

---@param key integer
function input.pad(key): input_pad_state

input.mouse_position

Get the position of the mouse cursor.

function input.mouse_position(): vec2

input.is_mouse_within

If the mouse cursor is within a given bounds.

---@param position vec2
---@param scale vec2
function input.is_mouse_within(position, scale): bool

input.get_clipboard_text

Get the text in your clipboard.

function input.get_clipboard_text(): string

input.set_clipboard_text

Set your clipboard text.

---@param str string
function input.set_clipboard_text(str): nil

Types

input_keyboard_state

Field	Type
pressed	bool
just_pressed	bool
just_released	bool
name	string

input_mouse_state

Field	Type
double_clicked	bool
pressed	bool
just_pressed	bool
just_released	bool
name	string

input_pad_state

Field	Type
pressed	bool
just_pressed	bool
just_released	bool

Examples

INPUT_ATTACK = 0x18
VK_W = 0x57
VK_LEFT_MOUSE = 0x01

print('w just pressed: ', input.key(VK_W).just_pressed)
print('left mouse being held: ', input.mouse(VK_LEFT_MOUSE).pressed)
print('mouse position: ', input.mouse_position())
print('attacking: ', input.pad(INPUT_ATTACK).pressed)