keyboard

v0.1.7

keyIsDown(k);

Check if a keyboard key is pressed, returns true if key is down and returns false if it's not

Arguments

kThe keyboard key to check as a key global, or a string

Returns

booleanWhether or not the key is down

-- Use a string 
if (keyIsDown('a')) then
  -- key 'a' is down
end

-- use a global
if (keyIsDown(LEFT_ARROW)) then
  -- left arrow is down
end

See keyIsDown in keyboard.h

keyPressed(key, keyCode);Event

Called whenever a key is pressed.

Arguments

keyThe pressed key as a string, is nil if glfw cannot find a name for the key.

keyCodeThe pressed key as a key code

function setup()
   createWindow(200, 200);

   background('purple');
   text('Press any key', 10, 40);
end

-- no draw
function draw() return end 

function keyPressed(key, keyCode)
   print(key, keyCode);

   background('purple');

   if key ~= nil then 
       text('Pressed: ' .. key, 10, 40);
   end
end

Output

See keyPressed in keyboard.h

keyReleased(key, keyCode);Event

Called whenever a key is released.

Arguments

keyThe released key as a string, is nil if glfw cannot find a name for the key

keyCodeThe released key as a key code

function setup()
   createWindow(200, 200);

   background('purple');
   text('Release any key', 10, 40);
end

-- no draw
function draw() return end 

function keyReleased(key, keyCode)
   print(key, keyCode);

   background('purple');

   if key ~= nil then 
       text('Released: ' .. key, 10, 40);
   end
end

Output

See keyReleased in keyboard.h

keyHeld(key, keyCode);Event

Called whenever a key is held down.

Arguments

keyThe held key as a string, is nil if glfw cannot find a name for the key

keyCodeThe held key as a key code

function setup()
   createWindow(200, 200);

   background('purple');
   text('Hold any key', 10, 40);
end

-- no draw
function draw() return end 

function keyHeld(key, keyCode)
   print(key, keyCode);

   background('purple');

   if key ~= nil then 
       text('Held key: ' .. key, 10, 40);
   end
end

Output

See keyHeld in keyboard.h

UP_ARROWConstant

No description

See UP_ARROW in keyboard.h

DOWN_ARROWConstant

No description

See DOWN_ARROW in keyboard.h

LEFT_ARROWConstant

No description

See LEFT_ARROW in keyboard.h

RIGHT_ARROWConstant