Difference between revisions of "love.keyboard.getKeyFromScancode"

m
m
Line 15: Line 15:
 
{{param|Scancode|scancode|The scancode to get the key from.}}
 
{{param|Scancode|scancode|The scancode to get the key from.}}
 
=== Returns ===
 
=== Returns ===
{{param|KeyConstant|key|The key corresponding to the given scancode, or "unknown" if the scancode doesn't map to a key on the current system.}}
+
{{param|KeyConstant|key|The key corresponding to the given scancode, or "unknown" if the scancode doesn't map to a [[KeyConstant]] on the current system.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.keyboard]]
 
* [[parent::love.keyboard]]

Revision as of 02:33, 9 March 2015

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

Gets the key corresponding to the given hardware scancode.

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".

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

Function

Synopsis

key = love.keyboard.getKeyFromScancode( scancode )

Arguments

Scancode scancode
The scancode to get the key from.

Returns

KeyConstant key
The key corresponding to the given scancode, or "unknown" if the scancode doesn't map to a KeyConstant on the current system.

See Also

Other Languages