util.input.get_cursor_mode

Client

Retrieves the current cursor visibility and confinement mode

local mode = util.input.get_cursor_mode()

No parameters are accepted by this function

Type	Name	Description
`util.input.cursor_mode`	mode	Current cursor mode

Print the current cursor mode

core.engine.print("info", "Cursor mode:", util.input.get_cursor_mode())

Toggle captured mode only when not already active

if util.input.get_cursor_mode() ~= util.input.cursor_mode.CAPTURED then
    util.input.set_cursor_mode(util.input.cursor_mode.CAPTURED)
end

util.input.is_pressed

Checks whether a keyboard or mouse button is currently held down

util.input.get_cursor_position

Retrieves the current cursor position relative to the root viewport