Scrupp

• Home
• Screenshots
• Videos
• Download
• Installation
• IDE
• Manual
  • Getting Started
  • File Access
  • Callbacks
  • General Functions
  • Drawing
  • Images
  • Cairo
  • Fonts
  • Sound
  • Music
  • Movies
  • Mouse
  • Keyboard
  • Network
• Plugins
  • Class
  • Color
  • Animations
  • Fonts
  • Timers
• Forum
• Twitter
• License

Keyboard Support

Functions

scrupp.keyIsDown(key)

Returns the boolean state of the key. key is one of the key strings.

scrupp.setKeyRepeat(delay, interval)

Configures the delay (in ms) after that a permanently pressed key begins to generate repeating key press events which eventually cause repeated calls of the keypressed function (see below). The time between two calls is defined by the interval (in ms). If delay equals 0, key repeating is disabled. After startup, key repeating is disabled as well.

Callbacks

keypressed(key, utf8_string)

Gets called when a key is pressed. Arguments are the key string of the pressed key and its representation as utf-8 encoded string. The utf-8 encoded string takes modifier keys (e. g. SHIFT) into account.
Example: Pressing SHIFT+2 on a US keyboard will result in key == "2" and utf8_string == "@".

keyreleased(key)

Gets calles when a key is released. Argument is the key string of the released key.

Key strings

The first table shows virtual key strings. These keys do not exist. You should not try to use them with the callbacks. Instead of e.g. "SHIFT", test for "LSHIFT" or "RSHIFT"

They should be used with scrupp.keyIsDown() to test for some special keys which happen to be twice on a standard keyboard. scrupp.keyIsDown("SHIFT") will return true if either of the two shift keys is pressed.

The following table shows all key strings usable with Scrupp.

The source of this table is the SDL man page for SDLKey.

Additionally, there exist strings for keys on international keyboards. They are named from "WORLD_0" to "WORLD_95".

Example

scrupp.init("Keyboard Test", 600, 400, 32, false)

require "font"

local font = Font("fonts/Vera.ttf", 20)

local text = "Press any key."

main = {
	render = function(dt)
		font:print(10, 10, text)
	end,
	
	keypressed = function(key)
		text = key .. " pressed."
		
		-- the escape key exits the demo
		if key == "ESCAPE" then
			scrupp.exit()
		end
	end,
	
	keyreleased = function(key)
		text = key .. " released."
	end
}