Difference between revisions of "love.keyreleased"

m (Notes: pressed -> released)
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
Callback function triggered when a key is released.
+
Callback function triggered when a keyboard key is released.
  
Unlike [[love.keypressed]], love.keyreleased does not have an unicode argument because those characters are only generated when keys are pressed.
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.keyreleased( key )
+
love.keyreleased( key, scancode )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|KeyConstant|key|Character of the key released.}}
+
{{param|KeyConstant|key|Character of the released key.}}
 +
{{New feature|0.10.0|
 +
{{param|Scancode|scancode|The scancode representing the released key.}} }}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
=== Notes ===
 +
[[Scancode]]s are keyboard layout-independent, so the scancode "w" will be used if the key in the same place as the "w" key on an [https://en.wikipedia.org/wiki/British_and_American_keyboards#/media/File:KB_United_States-NoAltGr.svg American keyboard] is released, no matter what the key is labelled or what the user's operating system settings are.
 +
 
== Examples ==
 
== Examples ==
Exit the game when the player releases the Escape key, using [[love.event.push]].  
+
Exit the game when the player releases the Escape key, using [[love.event.quit]].  
 
<source lang="lua">
 
<source lang="lua">
 
function love.keyreleased(key)
 
function love.keyreleased(key)
Line 23: Line 27:
 
* [[parent::love]]
 
* [[parent::love]]
 
* [[love.keypressed]]  
 
* [[love.keypressed]]  
* [[love.keyboard.isDown]]  
+
* [[love.keyboard.isDown]]
 
[[Category:Callbacks]]
 
[[Category:Callbacks]]
{{#set:Description=Callback function triggered when a key is released.}}
+
{{#set:Description=Callback function triggered when a keyboard key is released.}}
{{#set:Subcategory=General}}
+
{{#set:Subcategory=Keyboard}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.keyreleased}}
 
{{i18n|love.keyreleased}}

Latest revision as of 04:45, 12 January 2020

Callback function triggered when a keyboard key is released.

Function

Synopsis

love.keyreleased( key, scancode )

Arguments

KeyConstant key
Character of the released key.
Available since LÖVE 0.10.0
Scancode scancode
The scancode representing the released key.

Returns

Nothing.

Notes

Scancodes are keyboard layout-independent, so the scancode "w" will be used if the key in the same place as the "w" key on an American keyboard is released, no matter what the key is labelled or what the user's operating system settings are.

Examples

Exit the game when the player releases the Escape key, using love.event.quit.

function love.keyreleased(key)
   if key == "escape" then
      love.event.quit()
   end
end

See Also


Other Languages