Global Command: getCursorPos - Revision history

EK at 15:10, 2 May 2023

2023-05-02T15:10:40Z

EK at 14:30, 2 May 2023

2023-05-02T14:30:44Z

EK at 14:14, 2 May 2023

2023-05-02T14:14:27Z

EK at 14:10, 2 May 2023

2023-05-02T14:10:31Z

EK at 14:04, 2 May 2023

2023-05-02T14:04:55Z

EK: EK moved page GetCursorPos (CMS) to Global Command: getCursorPos

2023-05-02T13:58:29Z

EK moved page GetCursorPos (CMS) to Global Command: getCursorPos

EK at 13:57, 2 May 2023

2023-05-02T13:57:25Z

AFRLme at 02:06, 19 November 2014

2014-11-19T02:06:56Z

AFRLme at 02:02, 19 November 2014

2014-11-19T02:02:09Z

David Stoffel: Text replacement - "{{toc}}" to ""

2014-11-03T23:50:08Z

Text replacement - "{{toc}}" to ""

@@ Line 22: / Line 22: @@
 == Return values ==
 {| class="ts"
 |-
-! style="width:15%" | Type/Structure
+! style="width:15%" colspan="2" | Type/Structure
 ! Description
 |-
-| table {x=int,y=int}
+| rowspan="2" | table
-("t_point")
+| x (int)
-| The current mouse cursor position is returned as a Visionaire "t_point" field: an associative array containing the elements '''x (int)''' and '''y (int)'''.
+| Horizontal position (X coordinate) of current mouse cursor position
 |}

@@ Line 29: / Line 29: @@
 |-
 | table {x=int,y=int}
-| The current mouse cursor position is returned as an associative array containing the elements '''x (int)''' and '''y (int)'''.
+("t_point")
 |}

@@ Line 12: / Line 12: @@
 == Syntax ==
 <syntaxhighlight lang="lua">
-GetCursorPos()
+getCursorPos()
 </syntaxhighlight>

@@ Line 28: / Line 28: @@
 ! Description
 |-
-| table {x,y}
+| table {x=int,y=int}
-| The current mouse cursor position is returned as an associative array containing the elements ''x'' and ''y''.
+| The current mouse cursor position is returned as an associative array containing the elements '''x (int)''' and '''y (int)'''.
 |}

← Older revision		Revision as of 14:04, 2 May 2023
Line 2:		Line 2:

	Note that the function returns the cursor position 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. Have a look at example 2 on how to deal with this.		Note that the function returns the cursor position 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. Have a look at example 2 on how to deal with this.
		+
		+	{\| class="ts"
		+	\|-
		+	\| style="width:15%" \| Related functions
		+	\| [[Global Command: setCursorPos\|setCursorPos]]
		+	\|}

← Older revision	Revision as of 13:58, 2 May 2023
(No difference)

@@ Line 1: / Line 1: @@
-{| class="toccolours mw-collapsible mw-collapsed ts"
+Get the current position of the mouse cursor.
-! Function History
-|-
+Note that the function returns the cursor position 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. Have a look at example 2 on how to deal with this.
-| Available since v3.3
-|}
-Stores the current position (absolute) of the mouse cursor into an x,y table, which can be used in a query to check if the current position is over an object/character or a certain part of the scene etc. ''Note: just noticed that it is actually returning coordinates based on current scroll position, as if: scroll position is always 0,0 instead of what it should be. You can counteract this by adding cursor position + scroll position together.''
+== Return values ==
-Example:
+'''Example 1:''' Check if the current cursor position matches a defined position.
-<syntaxhighlight>
+<syntaxhighlight lang ="lua">
--- let's store the current position into a variable!
+-- Store the current position into a variable
 local curPos = getCursorPos()
--- let's check if the stored cursor position equals another x,y value!
+-- Check if the stored cursor position equals another {x,y} value
 if curPos.x == 200 and curPos.y == 400 then
- -- do some action!
+  return true
 else
- -- do some other action!
+  return false
 end
 </syntaxhighlight>
-<span class="bold underline">Arguments</span>
+  -- Empty table to store the absolute position
-none
+  -- Add the current scroll position to the cursor position
+  return curAbsPos
-<span class="bold underline">Flags</span>
+end
+</syntaxhighlight>
-none
+{{toc}}

← Older revision		Revision as of 02:06, 19 November 2014
Line 28:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>

		+	Example 2: Counteracting the scroll position issue. (''example below require vs 4.1'')
		+	<syntaxhighlight>
		+	local pos = {} -- empty table
		+	pos.x = game.ScrollPosition.x + getCursorPos().x -- absolute x position on entire scene
		+	pos.y = game.ScrollPosition.y + getCursorPos().y -- absolute y position on entire scene
		+	</syntaxhighlight>

← Older revision		Revision as of 02:02, 19 November 2014
Line 6:		Line 6:


−	Stores the current position (absolute) of the mouse cursor into an x,y table, which can be used in a query to check if the current position is over an object/character or a certain part of the scene etc.	+	Stores the current position (absolute) of the mouse cursor into an x,y table, which can be used in a query to check if the current position is over an object/character or a certain part of the scene etc. ''Note: just noticed that it is actually returning coordinates based on current scroll position, as if: scroll position is always 0,0 instead of what it should be. You can counteract this by adding cursor position + scroll position together.''

← Older revision		Revision as of 23:50, 3 November 2014
Line 44:		Line 44:
	<span class="bold">pos</span> <br/>		<span class="bold">pos</span> <br/>
	Table containing x,y values of current mouse cursor position		Table containing x,y values of current mouse cursor position
−	~~{{toc}}~~