Global Command: setCursorPos
From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 15:33, 2 May 2023 by EK (talk | contribs) (EK moved page SetCursorPos (CMS) to Global Command: setCursorPos)
Sets the mouse cursor to the {x,y} position provided.
Note that the coordinates must be provided in relation to the screen instead of in relation to the scene. This difference matters if your scene is larger than your screen resolution and thus scrollable.
Related functions | getCursorPos |
Syntax
setCursorPos(pos)
Parameters
Parameter | Type/Structure | Description |
---|---|---|
pos | table {x=int,y=int}
("t_point") |
The position where the mouse cursor should be be moved to. |
Return values
none
Examples
Example 1: Set the mouse cursor to position {240,480} of the screen.
-- Pass a "t_point" table to the function
setCursorPos({x=240,y=480})
-- You could use a variable instead
local cPos = {x=240,y=480}
setCursorPos(cPos)