Difference between revisions of "Global Command: getCursorPos"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: Line 1:
 
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
 
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<span class="bold">Command History</span>
+
<span class="bold">Function History</span>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
<div class="alt-bg">Available since v?</div>
+
<div class="alt-bg">Available since v3.3</div>
 
</div></div>
 
</div></div>
  

Revision as of 18:54, 23 March 2014

Function History

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.


Syntax:

getCursorPos()


Example:

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


Arguments

none


Flags

none


Return

pos
Table containing x,y values of current mouse cursor position