love.mouse.isDown

Checks whether a certain mouse button is down. This function does not detect mousewheel scrolling; you must use the love.mousepressed callback for that.

Function

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
This variant is not supported in earlier 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("r") then
        val = val + dt   -- we will increase the variable by 1 for every second the button is held down
    end
end

See Also


Other Languages

Personal tools