docs » hs.mouse

Get or set the absolute co-ordinates of the mouse pointer

• An optional point table containing the absolute x and y co-ordinates to move the mouse pointer to

• A point table containing the absolute x and y co-ordinates of the mouse pointer

• If no parameters are supplied, the current position will be returned. If a point table parameter is supplied, the mouse pointer position will be set and the new co-ordinates returned

Gets the total number of mice connected to your system.

• includeInternal - A boolean which sets whether or not you want to include internal Trackpad's in the count. Defaults to false.

• The number of mice connected to your system

• This function leverages code from ManyMouse.
• This function considers any mouse labelled as "Apple Internal Keyboard / Trackpad" to be an internal mouse.

Gets the identifier of the current mouse cursor type.

• None

• A string.

• Possible values include: arrowCursor, contextualMenuCursor, closedHandCursor, crosshairCursor, disappearingItemCursor, dragCopyCursor, dragLinkCursor, IBeamCursor, operationNotAllowedCursor, pointingHandCursor, resizeDownCursor, resizeLeftCursor, resizeLeftRightCursor, resizeRightCursor, resizeUpCursor, resizeUpDownCursor, IBeamCursorForVerticalLayout or unknown if the cursor type cannot be determined.
• This function can also return daVinciResolveHorizontalArrows, when hovering over mouse-draggable text-boxes in DaVinci Resolve. This is determined using the "hotspot" value of the cursor.

Returns a table containing the current mouse buttons being pressed at this instant.

• None

• Returns an array containing indices starting from 1 up to the highest numbered button currently being pressed where the index is true if the button is currently pressed or false if it is not.
• Special hash tag synonyms for left (button 1), right (button 2), and middle (button 3) are also set to true if these buttons are currently being pressed.

• This function is a wrapper to hs.eventtap.checkMouseButtons
• This is an instantaneous poll of the current mouse buttons, not a callback.

Gets the screen the mouse pointer is on

• None

• An hs.screen object that the mouse pointer is on, or nil if an error occurred

Gets the co-ordinates of the mouse pointer, relative to the screen it is on

• None

• A point-table containing the relative x and y co-ordinates of the mouse pointer, or nil if an error occurred

• The co-ordinates returned by this function are relative to the top left pixel of the screen the mouse is on (see hs.mouse.getAbsolutePosition if you need the location in the full desktop space)

Gets the names of any mice connected to the system.

• None

• A table containing strings of all the mice connected to the system.

• This function leverages code from ManyMouse.

Gets the system-wide direction of scrolling

• None

• A string, either "natural" or "normal"

Sets the co-ordinates of the mouse pointer, relative to a screen

• point - A point-table containing the relative x and y co-ordinates to move the mouse pointer to
• screen - An optional hs.screen object. Defaults to the screen the mouse pointer is currently on

• None

Gets/Sets the current system mouse tracking speed setting

• speed - An optional number containing the new tracking speed to set. If this is omitted, the current setting is returned

• A number indicating the current tracking speed setting for mice

• This is represented in the System Preferences as the "Tracking speed" setting for mice
• Note that not all values will work, they should map to the steps defined in the System Preferences app, which are:
  • 0.0, 0.125, 0.5, 0.6875, 0.875, 1.0, 1.5, 2.0, 2.5, 3.0
• Note that changes to this value will not be noticed immediately by macOS