GetCursorPosition
Jump to navigation
Jump to search
This function gets the current position of the mouse cursor.
Syntax
float float float float float getCursorPosition ( )
Required Arguments
None
Returns
Returns 5 values: cursorX, cursorY, worldX, worldY, worldZ. The first two values are the 2D relative screen coordinates of the cursor: cursorX goes from 0 (left side of the screen) to 1 (right side), cursorY goes from 0 (top) to 1 (bottom). The 3 values that follow are the 3D world map coordinates that the cursor points at.
Example
function cursorInfo()
local screenx, screeny, worldx, worldy, worldz = getCursorPosition()
outputChatBox("Cursor screen position: X=" .. screenx .. " Y=" .. screeny)
outputChatBox("Cursor world position: X=" .. worldx .. " Y=" .. worldy .. " Z=" .. worldz)
end