kitchen/kiwmi
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update the lua docs for the cursor hide and show methods

Browse source
This commit is contained in:
Toby Rea 2020-09-26 17:56:29 +01:00
parent e33eb5c2d9
commit 89b6fa9144
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lua_docs.md
View file

@ -70,6 +70,10 @@ A reference to the cursor object.
### Methods ### Methods
#### cursor:hide()
Hides the cursor.
#### cursor:on(event, callback) #### cursor:on(event, callback)
Used to register event listeners. Used to register event listeners.
@ -79,6 +83,10 @@ Used to register event listeners.
Get the current position of the cursor. Get the current position of the cursor.
Returns two parameters: `x` and `y`. Returns two parameters: `x` and `y`.
### cursor:show()
Shows the cursor.
#### cursor:view_at_pos() #### cursor:view_at_pos()
Returns the view at the cursor position, or `nil` if there is none. Returns the view at the cursor position, or `nil` if there is none.