mouseLoc

returns the location of the mouse pointer.

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:

# Syntax

the mouseLoc

# Examples

the mouseLoc

click at the mouseLoc

# Description

Use the mouseLoc function to find out where the mouse is.

The first item of the return value is the horizontal distance in pixels from the left edge of the current stack to the location of the mouse. The second item of the return value is the vertical distance from the top edge of the current stack to the location of the mouse. (Use the defaultStack property to identify the current stack.)

The first item of the mouseLoc is equal to the mouseH. The second item is equal to the mouseV.

>*Note:* When in a mouseDown handler, you can use the clickLoc > function to get the position of the mouse as it was when the mouseDown > action ocurred.

>*Tip:* The mouseMove message sends the current mouse position as a > parameter. This means that in a mouseMove handler, normally it's > not necessary to use the mouseLoc function.

# Tags

ui,

# See

- **glossary:** property, return, handler, message, integer, parameter, mouse pointer - **message:** dragEnter, mouseMove - **keyword:** item - **object:** stack - **control structure:** function - **command:** grab - **function:** mouseV, mouseColor, mouseClick, mouseH, clickLoc, mouseLoc, selectedLoc, mouseCharChunk