love.mousepressed

Callback function triggered when a mouse button is pressed.

Function

Synopsis

love.mousepressed( x, y, button, istouch, presses )

Arguments

number x

Mouse x position, in pixels.

number y

Mouse y position, in pixels.

number button

The button index that was pressed. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependent.

boolean istouch

True if the mouse button press originated from a touchscreen touch-press.

number presses Available since 11.0

The number of presses in a short time frame and small area, used to simulate double, triple clicks

Returns

Nothing.

Notes

Use love.wheelmoved to detect mouse wheel motion. It will not register as a button press in version 0.10.0 and newer.

Function

Removed in LÖVE 0.10.0
This variant is not supported in that and later versions.

Synopsis

love.mousepressed( x, y, button )

Arguments

number x

Mouse x position.

number y

Mouse y position.

MouseConstant button

Mouse button pressed.

Returns

Nothing.

Examples

Position a string ("Text") wherever the user left-clicks.

function love.load()
   printx = 0
   printy = 0
end
 
function love.draw()
   love.graphics.print("Text", printx, printy)
end
 
function love.mousepressed(x, y, button, istouch)
   if button == 1 then -- Versions prior to 0.10.0 use the MouseConstant 'l'
      printx = x
      printy = y
   end
end

See Also

• love
• love.mousereleased
• love.mouse.isDown