heavy overhaul of documentation organizaton

This commit is contained in:
2025-02-08 01:45:51 -06:00
parent 81b42eec67
commit c389e0744a
25 changed files with 591 additions and 1540 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -1,27 +1,62 @@
# input
## mouse_show()
## mouse_show(show)
Show or hide the mouse cursor. Pass true to show, false to hide.
## mouse_lock()
**show**: Boolean. True to show, false to hide.
Capture or release the mouse. Pass true to lock, false to unlock.
**Returns**: None
## cursor_set()
## mouse_lock(lock)
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)
Set the given cursor (created by os.make_cursor) as the active mouse cursor.
## keyname()
**cursor**: The cursor to set.
**Returns**: None
## keyname(keycode)
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()
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()
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 }
## print_pawn_kbm(pawn)
## procdown()