Skip to content

keyIsDown()

Returns true if the key it’s checking is pressed and false if not.

keyIsDown() is helpful when checking for multiple different key presses. For example, keyIsDown() can be used to check if both left arrow and up arrow are pressed:

if keyIsDown('left') and keyIsDown('up') then
  print('move diagonally')
end

Examples

keyIsDown example 1

local x = 50
local y = 50

function setup()
  size(100, 100)

  background(200)

  describe(
    'A gray square with a black circle at its center. The circle moves when the user presses an arrow key. It leaves a trail as it moves.'
  )
end

function draw()
  -- Update x and y if an arrow key is pressed.
  if keyIsDown('left') == true then
    x = x - 1
  end

  if keyIsDown('right') == true then
    x = x + 1
  end

  if keyIsDown('up') == true then
    y = y - 1
  end

  if keyIsDown('down') == true then
    y = y + 1
  end

  -- Style the circle.
  fill(0)

  -- Draw the circle.
  circle(x, y, 5)
end

Syntax

keyIsDown(keyname)

Parameters

Parameter
keyname String: keyname in quotes.