mouse

Overview

Mouse events occur when the mouse cursor moves or when the mouse buttons have been pressed or released. This event provides information about the mouse cursor’s current screen coordinates and its button states.

Note that a mouse will generate touch events while holding the primary mouse button down.

Also note that a mouse will generate tap events when clicking the primary mouse button. The tap’s event.numTaps property will be set to 1 when single clicking and 2 when double clicking. A tap event will not be raised when clicking any other mouse button.

Platform Support

Gotchas

Mouse events will not be received while the mouse cursor is outside of the application window, such as when you drag the cursor on top of Android’s bottom navigation bar.

Properties

Example

-- Called when a mouse event has been received.
local function onMouseEvent( event )
    if event.type == "down" then
        if event.isPrimaryButtonDown then
            print( "Left mouse button clicked." )
        elseif event.isSecondaryButtonDown then
            print( "Right mouse button clicked." )        
        end
    end
end
                             
-- Add the mouse event listener.
Runtime:addEventListener( "mouse", onMouseEvent )