reorganize api doc
This commit is contained in:
70
docs/api/modules/input.md
Normal file
70
docs/api/modules/input.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# input
|
||||
|
||||
## mouse_show(show)
|
||||
|
||||
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)
|
||||
|
||||
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.
|
||||
|
||||
**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()
|
||||
|
||||
## print_md_kbm(pawn)
|
||||
|
||||
## has_bind(pawn, bind)
|
||||
|
||||
## tabcomplete(val, list)
|
||||
|
||||
## do_uncontrol(pawn)
|
||||
Reference in New Issue
Block a user