Difference between revisions of "GetCursorPos"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+
==getCursorPos==
<span class="bold">Command History</span>
 
<div class="mw-collapsible-content">
 
<div class="alt-bg">Available since v?</div>
 
</div></div>
 
  
 +
<div class="command-min-version-info">Available since: <span class="command-min-version">v3.3</span></div>
  
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===
 +
Example 1:  
 
<syntaxhighlight>
 
<syntaxhighlight>
-- let's store the current position into a variable!
+
-- let's store the current position into a variable
 
local curPos = getCursorPos()
 
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
 
if curPos.x == 200 and curPos.y == 400 then
-- do some action!
+
  -- do some action
 
else
 
else
-- do some other action!
+
  -- do some other action
 
end
 
end
 
</syntaxhighlight>
 
</syntaxhighlight>
 
 
 
<span class="bold underline">Arguments</span>
 
 
none
 
 
 
<span class="bold underline">Flags</span>
 
 
none
 
 
 
<span class="bold underline">Return</span>
 
 
<span class="bold">pos</span> <br/>
 
Table containing x,y values of current mouse cursor position
 
{{i18n|GetCursorPos}} <br/>
 
{| class="tbl-ds"
 
|-
 
|<span class="bold">Relevant Pages</span>: [[SetCursorPos|setCursorPos]]
 
|}
 

Revision as of 21:27, 30 September 2014

getCursorPos

Available since: v3.3
Returns the current absolute cursor position.

Lua Syntax:

getCursorPos()

Arguments

Flags

Return Values

pos
Table with x and y values containing cursor position.

Examples

Example 1:

-- 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