love.keyboard.isDown

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.

Examples

Moving the circle when the player press the left and right keys.

function love.load()
  x, y = 20, 20
end

function love.update(dt)
   if love.keyboard.isDown("left") then
      x = x - 10 * dt
   end
   if love.keyboard.isDown("right") then
      x = x + 10 * dt
   end
end

function love.draw()
    love.graphics.circle("line", x, y, 10)
end

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.

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

• love.keyboard
• love.keypressed
• love.keyreleased
• love.keyboard.isScancodeDown

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