Difference between revisions of "love.keyboard.isDown"

(Replace improper example)
m (Add more see alsos.)
Line 1: Line 1:
Checks whether a certain key is down.
+
Checks whether a certain key is down. Not to be confused with [[love.keypressed]] or [[love.keyreleased]].
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 31: Line 31:
 
== See Also ==
 
== See Also ==
 
* [[parent::love.keyboard]]
 
* [[parent::love.keyboard]]
 +
* [[love.keypressed]]
 +
* [[love.keyreleased]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Checks whether a certain key is down.}}
 
{{#set:Description=Checks whether a certain key is down.}}

Revision as of 16:07, 27 September 2011

Checks whether a certain key is down. Not to be confused with love.keypressed or love.keyreleased.

Function

Synopsis

down = love.keyboard.isDown( key )

Arguments

KeyConstant key
The key to check.

Returns

boolean down
True if the key is down, false if not.

Function

Available since LÖVE 0.7.2
This variant is not supported in earlier versions.

Synopsis

anyDown = love.keyboard.isDown( key1, key2, key3, ... )

Arguments

KeyConstant keyN
A key to check.

Returns

boolean anyDown
True if any supplied key is down, false if not.

Examples

Increase a value while a key is held down

val = 0   -- establish a variable for later use
function love.update(dt)
	if love.keyboard.isDown("up") then
		val = val + dt   -- we will increase the variable by 1 for every second the key is held down
	end	
end

See Also


Other Languages