Difference between revisions of "Global Command: setCursorPos"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 22: | Line 22: | ||
! style="width:15%" | Parameter | ! style="width:15%" | Parameter | ||
! style="width:15%" colspan="2" | Type/Structure | ! style="width:15%" colspan="2" | Type/Structure | ||
| − | ! Description | + | ! colspan="2" | Description |
|- | |- | ||
| rowspan="2" | pos | | rowspan="2" | pos | ||
| rowspan="2" | table | | rowspan="2" | table | ||
| x (int) | | x (int) | ||
| + | | style="width:25%" | Horizontal position (X coordinate) | ||
| rowspan="2" | Pass the position where the mouse cursor should be set to as a Visionaire "t_point" field: an associative array containing the elements '''x''' and '''y'''. | | rowspan="2" | Pass the position where the mouse cursor should be set to as a Visionaire "t_point" field: an associative array containing the elements '''x''' and '''y'''. | ||
|- | |- | ||
| y (int) | | y (int) | ||
| + | | Vertical position (Y coordinate) | ||
|} | |} | ||
Latest revision as of 16:31, 2 May 2023
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) | Horizontal position (X coordinate) | Pass the position where the mouse cursor should be set to as a Visionaire "t_point" field: an associative array containing the elements x and y. |
| y (int) | Vertical position (Y coordinate) | |||
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)
