love.mouse.isDown
Checks whether a certain mouse button is down.
This function does not detect mouse wheel scrolling; you must use the love.wheelmoved (or love.mousepressed in version 0.9.2 and older) callback for that.
Function
Available since LÖVE 0.10.0
This variant is not supported in earlier versions.
Synopsis
down = love.mouse.isDown( button, ... )
Arguments
number button
- The index of a button to check. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependant.
number ...
- Additional button numbers to check.
Returns
boolean down
- True if any specified button is down.
Function
Removed in LÖVE 0.10.0
This variant is not supported in that and later versions.
Synopsis
down = love.mouse.isDown( button )
Arguments
MouseConstant button
- The button to check.
Returns
boolean down
- True if the specified button is down.
Function
Available since LÖVE 0.7.2 and removed in LÖVE 0.10.0
This variant is not supported in earlier or later versions.
Synopsis
anyDown = love.mouse.isDown( button1, button2, button3, ... )
Arguments
MouseConstant buttonN
- A button to check.
Returns
boolean anyDown
- True if any specified button is down, false otherwise.
Example
Increase a value while the right mouse button is held
val = 0 -- establish a variable for later use function love.update(dt) if love.mouse.isDown(2) then val = val + dt -- we will increase the variable by 1 for every second the button is held down end end
Please login to continue.