WoW API: GetCursorPosition

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetCursorPosition

Returns the cursor's position on the screen.

GetCursorPosition();

Arguments

none

Returns

x

Number - The cursor's x-position on the screen.

y

Number - The cursor's y-position on the screen.

Example

 local x, y = GetCursorPosition();

Result

x = 956.24999166082;
y = 538.49999965651;

Details

Returns scale-independent coordinates similar to Cursor:GetCenter() if 'Cursor' was a valid frame. You can use this value relative to UIParent if you treat BOTTOMLEFT as 0,0. Remember to also apply scale.

Notes

To apply scale, divide both x and y by the value returned by UIParent:GetEffectiveScale()

The coordinates returned by this use BOTTOMLEFT as the origin, not TOPLEFT. This means [0, 0] is the exact bottom-left point on the screen.