GetCursorPos - Revision history

EK: Redirected page to Global Command: getCursorPos

2023-05-19T11:24:12Z

2014-09-30T20:27:47Z

2013-11-26T13:56:26Z

2013-11-22T16:11:49Z

2013-04-02T15:32:53Z

2013-03-12T14:39:42Z

2013-03-12T14:37:24Z

2013-03-12T14:35:23Z

2013-03-07T17:21:35Z

2013-03-05T16:26:42Z

← Older revision		Revision as of 11:24, 19 May 2023
Line 1:		Line 1:
−	~~==getCursorPos==~~	+	#REDIRECT [[Global Command: getCursorPos]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v3.3</span></div>~~
−
−	~~<div class="command-doc">Returns the current absolute cursor position.</div>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">getCursorPos()</pre>~~
−	~~===Arguments===~~
−	~~===Flags===~~
−	~~===Return Values===~~
−	~~;pos~~
−	~~:Table with x and y values containing cursor position.~~
−	~~===Examples===~~
−	~~Example 1~~:
−	~~<syntaxhighlight>~~
−	~~-- let's store the current position into a variable~~
−	~~local curPos =~~ getCursorPos()
−
−	~~-- let's check if the stored cursor position equals another x,y value~~
−	~~if curPos.x == 200 and curPos.y == 400 then~~
−	~~-- do some action~~
−	~~else~~
−	~~-- do some other action~~
−	~~end~~
−	~~</syntaxhighlight>~~

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==getCursorPos==
-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.
+<div class="command-doc">Returns the current absolute cursor position.</div>
+Lua Syntax:
-Syntax:
+<pre class="command-syntax">getCursorPos()</pre>
-<syntaxhighlight>
+===Arguments===
-getCursorPos()
+===Flags===
-</syntaxhighlight>
+===Return Values===
+;pos
+:Table with x and y values containing cursor position.
-Example:
+===Examples===
 <syntaxhighlight>
--- let's store the current position into a variable!
+-- let's store the current position into a variable
 local curPos = getCursorPos()
--- let's check if the stored cursor position equals another x,y value!
+-- let's check if the stored cursor position equals another x,y value
 if curPos.x == 200 and curPos.y == 400 then
- -- do some action!
+  -- do some action
 else
- -- do some other action!
+  -- do some other action
 end
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<b>Command History</b>
+<span class="bold">Command History</span>
 <div class="mw-collapsible-content">
-<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v?</span></div>
+<div class="alt-bg">Available since v?</div>
 </div></div>
@@ Line 30: / Line 30: @@
-<b><u>Arguments</u></b>
+<span class="bold underline">Arguments</span>
 none
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
 none
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
-<b>pos</b> <br/>
+<span class="bold">pos</span> <br/>
 Table containing x,y values of current mouse cursor position
 {{i18n|GetCursorPos}} <br/>
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| class="tbl-ds"
 |-
-|<b>Relevant Pages</b>: [[SetCursorPos|setCursorPos]]
+|<span class="bold">Relevant Pages</span>: [[SetCursorPos|setCursorPos]]
 |}

← Older revision		Revision as of 16:26, 5 March 2013
Line 28:		Line 28:
	Return: Pos <br/>		Return: Pos <br/>
	Table containing x,y values of current mouse cursor position		Table containing x,y values of current mouse cursor position
		+	{{i18n\|GetCursorPos}}