Global Command: getCursorPos

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 03:02, 19 November 2014 by AFRLme (talk)
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. 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.


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