util.input.get_cursor_position

Client

Retrieves the current cursor position relative to the root viewport


Syntax

local position = util.input.get_cursor_position()

Parameters

No parameters are accepted by this function

Returns

TypeNameDescription
vector2positionCursor position as {x, y} in pixels, relative to the root viewport

Examples

Print the current cursor position
core.engine.print("info", "Cursor position:", util.table.unpack(util.input.get_cursor_position()))
Convert the cursor position to a world-space ray
local cursor_position = util.input.get_cursor_position()
local world_position = core.engine.screen_to_world(position, 10)

core.engine.print("info", "World position:", util.table.unpack(world_position))

On this page