Difference between revisions of "love.mouse.isDown"

m
m (Function)
Line 26: Line 26:
 
{{param|boolean|down|True if the specified button is down.}}
 
{{param|boolean|down|True if the specified button is down.}}
 
== Function ==
 
== Function ==
{{newin|[[0.7.2]]|072|type=variant}}
+
{{newinoldin|[[0.7.2]]|072|[[0.10.0]]|100|type=variant}}
{{oldin|[[0.10.0]]|100|type=variant}}
 
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 36: Line 35:
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|anyDown|True if any specified button is down, false otherwise.}}
 
{{param|boolean|anyDown|True if any specified button is down, false otherwise.}}
 +
 
== Example ==
 
== Example ==
 
=== Increase a value while the right mouse button is held (version [[0.10.0]] and newer) ===
 
=== Increase a value while the right mouse button is held (version [[0.10.0]] and newer) ===

Revision as of 22:41, 27 December 2015

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, etc.
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 (version 0.10.0 and newer)

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

Increase a value while the right mouse button is held (version 0.9.2 and older)

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