Difference between revisions of "GetCursorPos"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Redirected page to Global Command: getCursorPos)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+
#REDIRECT [[Global Command: getCursorPos]]
<b>Command History</b>
 
<div class="mw-collapsible-content">
 
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v?</span></div>
 
</div></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.
 
 
 
 
 
Syntax:
 
<syntaxhighlight>
 
getCursorPos()
 
</syntaxhighlight>
 
 
 
 
 
Example:
 
<syntaxhighlight>
 
-- let's store the current position in a variable!
 
local variableName = getCursorPos()
 
 
 
-- let's check if the stored cursor position equals another x,y value!
 
if variableName.x == 200 and variableName.y == 400 then
 
-- do some action!
 
else
 
-- do some other action!
 
end
 
</syntaxhighlight>
 
 
 
 
 
 
 
<b><u>Arguments</u></b>
 
 
 
none
 
 
 
 
 
<b><u>Flags</u></b>
 
 
 
none
 
 
 
 
 
<b><u>Return</u></b>
 
 
 
<b>pos</b> <br/>
 
Table containing x,y values of current mouse cursor position
 
{{i18n|GetCursorPos}} <br/>
 
{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
 
|-
 
|<b>Relevant Pages</b>: [[SetCurorPos|setCursorPos]]
 
|}
 

Latest revision as of 12:24, 19 May 2023