Difference between revisions of "GetCursorPos"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 1: | Line 1: | ||
| − | + | ==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: | |
| − | Syntax: | + | <pre class="command-syntax">getCursorPos()</pre> |
| − | < | + | ===Arguments=== |
| − | getCursorPos() | + | ===Flags=== |
| − | </ | + | ===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 | |
else | else | ||
| − | + | -- do some other action | |
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 17:11, 22 November 2013
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