Files
prosperon/docs/api/modules/input.md
John Alanbrook 83b798e365 Add Hugo website and rewrite docs to match current engine
New Hugo site in website/ with prosperon.dev theme (blue/gold/castle
aesthetic), docs sidebar navigation, and content pages. Rewrote all
doc files to align with the actual codebase: compositor+film2d
rendering, use() modules (no global prosperon object), Pit language,
script+JSON entity model. Added entities.md, front matter to all
70+ API docs, and updated API index for current module architecture.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-23 18:09:55 -06:00

1.2 KiB

title, type
title type
input docs

input

mouse_show(show) function

Show or hide the mouse cursor. Pass true to show, false to hide.

show: Boolean. True to show, false to hide.

Returns: None

mouse_lock(lock) function

Capture or release the mouse, confining it within the window if locked.

lock: Boolean. True to lock, false to unlock.

Returns: None

cursor_set(cursor) function

Set the given cursor (created by os.make_cursor) as the active mouse cursor.

cursor: The cursor to set.

Returns: None

keyname(keycode) function

Given a numeric keycode, return the corresponding key name (e.g., from SDL).

keycode: A numeric SDL keycode.

Returns: A string with the key name.

keymod() function

Return an object describing the current modifier keys, e.g. {shift:true, ctrl:true}.

Returns: An object with boolean fields for each modifier key.

mousestate() function

Return an object describing the current mouse state, including x,y coordinates and booleans for pressed buttons (left, middle, right, x1, x2).

Returns: Object { x, y, left, middle, right, x1, x2 }