Global Command: setCursorPos - Revision history

EK at 15:31, 2 May 2023

2023-05-02T15:31:24Z

EK at 15:18, 2 May 2023

2023-05-02T15:18:54Z

EK: EK moved page SetCursorPos (CMS) to Global Command: setCursorPos

2023-05-02T14:33:18Z

EK moved page SetCursorPos (CMS) to Global Command: setCursorPos

EK at 14:32, 2 May 2023

2023-05-02T14:32:48Z

AFRLme at 16:54, 23 March 2014

2014-03-23T16:54:00Z

AFRLme: Created page with "
Function History

Available since..."

2014-03-23T16:52:58Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> <span class="bold">Function History</span> <div class="mw-collapsible-content"> <div class="alt-bg">Available since..."

New page

<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<span class="bold">Function History</span>
<div class="mw-collapsible-content">
<div class="alt-bg">Available since v3.3</div>
</div></div>

Sets position (absolute) of the mouse cursor to the x,y position provided.

Syntax:
<syntaxhighlight>
setCursorPos(pos)
</syntaxhighlight>

Example:
<syntaxhighlight>
-- let's set mouse cursor to 240 by 480
setCursorPos({x=240,y=480})

-- you could of course use variables instead...
local cPos = {x=240,y=480}
setCursorPos(cPos)
-- or ...
setCursorPos({x=cPos.x,y=cPos.y})
</syntaxhighlight>

<span class="bold underline">Arguments</span>

<span class="bold">pos</span>: point (x,y) <br/>
The position where the mouse cursor should be be moved to. {x=int,y=int}

<span class="bold underline">Flags</span>

none

<span class="bold underline">Return</span>

none

{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
|-
|<span class="bold">Relevant Pages</span>: [[GetCursorPos_CMS)|getCursorPos]]
|}

@@ Line 22: / Line 22: @@
 ! style="width:15%" | Parameter
 ! style="width:15%" colspan="2" | Type/Structure
-! Description
+! colspan="2" | Description
 |-
 | rowspan="2" | pos
 | rowspan="2" | table
 | x (int)
 | 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)
 |}

@@ Line 21: / Line 21: @@
 |-
 ! style="width:15%" | Parameter
-! style="width:15%" | Type/Structure
+! style="width:15%" colspan="2" | Type/Structure
 ! Description
 |-
-| pos
+| rowspan="2" | pos
-| table {x=int,y=int}
+| rowspan="2" | table
-("t_point")
+| x (int)
-| The position where the mouse cursor should be be moved to.
+| 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'''.
 |}

← Older revision	Revision as of 14:33, 2 May 2023
(No difference)

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+Sets the mouse cursor to the {x,y} position provided.
-Sets position (absolute) of the mouse cursor to the x,y position provided.
+{| class="ts"
-Syntax:
+== Syntax ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 setCursorPos(pos)
 </syntaxhighlight>
-Example:
+== Parameters ==
--- you could of course use variables instead...
+{| class="ts"
-local cPos = {x=240,y=480}
+|-
-setCursorPos(cPos)
+! style="width:15%" | Parameter
--- or ...
+! style="width:15%" | Type/Structure
-setCursorPos({x=cPos.x,y=cPos.y})
+! Description
-</syntaxhighlight>
+|-
+== Return values ==
 none
-<span class="bold underline">Return</span>
+== Examples ==
-none
+'''Example 1:''' Set the mouse cursor to position {240,480} of the screen.
+-- You could use a variable instead
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+local cPos = {x=240,y=480}
-|-
+setCursorPos(cPos)
-|<span class="bold">Relevant Pages</span>: [[GetCursorPos_(CMS)|getCursorPos]]
+</syntaxhighlight>
-|}
+{{toc}}