BlzGetTriggerPlayerMouseX

comment

Returns the map X coordinate (Cartesian System) of the ground location, where the cursor points at. Only valid inside a mouse event trigger’s action/condition.

Returns 0 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 coordinates.

Returns the max valid X map coordinate when pointing outside of map bounds on any side.

note

The world coordinate will be a result of ray tracing based on current camera setup. Changing the camera setup does not affect the result until a new frame has been rendered locally.

event

EVENT_PLAYER_MOUSE_MOVE

bug

(confirmed v2.0.3.23175) Mouse events crash when registered and used during map initialization.

note

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

patch

1.29.2.9231

Source

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

return type

real

Source code

native BlzGetTriggerPlayerMouseX                   takes nothing returns real