Difference between revisions of "love.keyboard.getScancodeFromKey"

m
m
Line 4: Line 4:
 
The location of a [[KeyConstant|key]] is based on the keyboard's current language layout, whereas [[Scancode|scancodes]] are the layout-independent representations of where the physical keys are.
 
The location of a [[KeyConstant|key]] is based on the keyboard's current language layout, whereas [[Scancode|scancodes]] are the layout-independent representations of where the physical keys are.
  
For example, pressing the key located where "q" is on a U.S. keyboard will produce the key "q" and the scancode "q" when using a U.S. keyboard layout, but when using a French keyboard layout it will produce the key "a" and the scancode "q".
+
For example, the key located where "q" is on a U.S. keyboard has the scancode "q". When using a U.S. keyboard layout it produces the key "q", but when using a French keyboard layout it produces the key "a". French keyboards usually label the key as "a" rather than "q".
  
 
Scancodes are useful for creating default controls that have the same physical locations on on all keyboards and systems.
 
Scancodes are useful for creating default controls that have the same physical locations on on all keyboards and systems.
Line 15: Line 15:
 
{{param|KeyConstant|key|The key to get the scancode from.}}
 
{{param|KeyConstant|key|The key to get the scancode from.}}
 
=== Returns ===
 
=== Returns ===
{{param|Scancode|scancode|The scancode corresponding to the given key.}}
+
{{param|Scancode|scancode|The scancode corresponding to the given key, or "unknown" if the given key has no known physical representation on the current system.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.keyboard]]
 
* [[parent::love.keyboard]]

Revision as of 04:08, 9 February 2015

Available since LÖVE 0.9.2
This function is not supported in earlier versions.

Gets the hardware scancode corresponding to the given key.

The location of a key is based on the keyboard's current language layout, whereas scancodes are the layout-independent representations of where the physical keys are.

For example, the key located where "q" is on a U.S. keyboard has the scancode "q". When using a U.S. keyboard layout it produces the key "q", but when using a French keyboard layout it produces the key "a". French keyboards usually label the key as "a" rather than "q".

Scancodes are useful for creating default controls that have the same physical locations on on all keyboards and systems.

Function

Synopsis

scancode = love.keyboard.getScancodeFromKey( key )

Arguments

KeyConstant key
The key to get the scancode from.

Returns

Scancode scancode
The scancode corresponding to the given key, or "unknown" if the given key has no known physical representation on the current system.

See Also

Other Languages