Difference between revisions of "love.keyboard.isDown"
m (Added table variant available since 0.10.2)
 
(8 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
−
down = love.keyboard.isDown( key[, key2, key3, ...] )
+
down = love.keyboard.isDown( key )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|KeyConstant|key|The key to check.}}
 
{{param|KeyConstant|key|The key to check.}}
−
{{New feature|0.7.2|
 
−
{{param|KeyConstant|keyN|A key to check}}
 
−
|072}}
 
 
=== Returns ===
 
=== Returns ===
−
{{param|boolean|down|True if the any supplied key is down, false if not.}}
+
{{param|boolean|down|True if the key is down, false if not.}}
 +
 
 +
== Function ==
 +
{{newin|[[0.7.2]]|072|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
anyDown = love.keyboard.isDown( key, ... )
 +
</source>
 +
=== Arguments ===
 +
{{param|KeyConstant|key|A key to check.}}
 +
{{param|KeyConstant|...|Additional keys to check.}}
 +
=== Returns ===
 +
{{param|boolean|anyDown|True if any supplied key is down, false if not.}}
 +
 
 +
== Function ==
 +
{{newin|[[0.10.2]]|102|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
anyDown = love.keyboard.isDown({ key, ... })
 +
</source>
 +
=== Arguments ===
 +
{{param|table|keys|Table of keys to check.}}
 +
{{subparam|KeyConstant|key|A key to check.}}
 +
{{subparam|KeyConstant|...|Additional keys to check.}}
 +
=== Returns ===
 +
{{param|boolean|anyDown|True if any supplied key is down, false if not.}}
 +
 
 
== Examples ==
 
== Examples ==
 
=== Increase a value while a key is held down ===
 
=== Increase a value while a key is held down ===
 
<source lang="lua">
 
<source lang="lua">
−
val = 0   -- establish a variable for later use
+
local val = 0;
 
function love.update(dt)
 
function love.update(dt)
−
if love.keyboard.isDown("up") then
+
    -- We will increase the variable by 1 for every second the key is held down.
−
val = val + dt   -- we will increase the variable by 1 for every second the key is held down
+
    if love.keyboard.isDown("up") then
−
end
+
        val = val + dt
 +
        print(val)
 +
    end
 +
 
 +
    -- We will decrease the variable by 1/s if any of the wasd keys is pressed.
 +
    if love.keyboard.isDown('w', 'a', 's', 'd') then
 +
        val = val - dt
 +
        print(val)
 +
    end
 
end
 
end
 
</source>
 
</source>
Line 25: Line 56:
 
* [[parent::love.keyboard]]
 
* [[parent::love.keyboard]]
 
* [[love.keypressed]]  
 
* [[love.keypressed]]  
−
* [[love.keyreleased]]  
+
* [[love.keyreleased]]
 +
* [[love.keyboard.isScancodeDown]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Checks whether a certain key is down.}}
 
{{#set:Description=Checks whether a certain key is down.}}

Latest revision as of 13:10, 7 December 2022

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( key, ... )

Arguments

KeyConstant key
A key to check.
KeyConstant ...
Additional keys to check.

Returns

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

Function

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

Synopsis

anyDown = love.keyboard.isDown({ key, ... })

Arguments

table keys
Table of keys to check.
KeyConstant key
A key to check.
KeyConstant ...
Additional keys 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

local val = 0;
function love.update(dt)
    -- We will increase the variable by 1 for every second the key is held down.
    if love.keyboard.isDown("up") then
        val = val + dt
        print(val)
    end

    -- We will decrease the variable by 1/s if any of the wasd keys is pressed. 
    if love.keyboard.isDown('w', 'a', 's', 'd') then
        val = val - dt
        print(val)
    end
end

See Also


Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Retrieved from "https://love2d.org./w/index.php?title=love.keyboard.isDown&oldid=28145"