BlzGetTriggerPlayerMousePosition

comment

Returns the ground location on the map, where the cursor points at. Only valid inside a mouse event trigger’s action/condition.

Returns {0, 0, surfaceZ} when pointing at certain "opaque" UI elements like the top status bar with resources. However minimap, the bottom half of the clock, and the entire bottom UI are transparent to the cursor and show the correct map coordinates.

Returns {maxX, maxY, surfaceZ} when pointing outside of map bounds on any side.

maxX and maxY is highest valid map coordinate and surfaceZ is the terrain surface elevation at the given point.

event

EVENT_PLAYER_MOUSE_MOVE

note

See: EVENT_PLAYER_MOUSE_MOVE (includes an example), BlzGetTriggerPlayerMouseX, BlzGetTriggerPlayerMouseY

patch

1.29.2.9231

Source

common.j (raise an issue to discuss on Github or submit a PR)

return type

location

Source code

native BlzGetTriggerPlayerMousePosition            takes nothing returns location