John Alanbrook
96ef8ccba3
Some checks failed
Build and Deploy / package-dist (push) Has been cancelled
Build and Deploy / deploy-itch (push) Has been cancelled
Build and Deploy / deploy-gitea (push) Has been cancelled
Build and Deploy / build-linux (push) Has been cancelled
Build and Deploy / build-windows (CLANG64) (push) Has been cancelled
69 lines
1.2 KiB
Markdown
69 lines
1.2 KiB
Markdown
# input
|
|
|
|
### mouse_show(show) <sub>function</sub>
|
|
|
|
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) <sub>function</sub>
|
|
|
|
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) <sub>function</sub>
|
|
|
|
Set the given cursor (created by os.make_cursor) as the active mouse cursor.
|
|
|
|
|
|
|
|
**cursor**: The cursor to set.
|
|
|
|
|
|
**Returns**: None
|
|
|
|
|
|
### keyname(keycode) <sub>function</sub>
|
|
|
|
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() <sub>function</sub>
|
|
|
|
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() <sub>function</sub>
|
|
|
|
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 }
|
|
|