Difference between revisions of "Event.KEY UP"

From GiderosMobile
 
(11 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Value:''' keyUp<br/>
 
'''Value:''' keyUp<br/>
 +
'''Defined by:''' [[Sprite]]<br/>
 +
 
=== Description ===
 
=== Description ===
<translate>Button on controller was released up</translate>
+
This event is dispatched when a supported key is released.  List of supported keys '''[[KeyCode Constants]]'''.
 +
 
 
=== Parameters ===
 
=== Parameters ===
'''playerId''': (number) <translate>id of controller/player that released the button</translate><br/>
+
'''type''': (String) '''keyDown'''<br/>
'''keyCode''': (number) <translate>button key code that was released</translate><br/>
+
'''keyCode''': (number) code of the key pressed<br/>
__NOTOC__
+
'''realCode''': (number) real keyCode underneath<br/>
'''Available since:''' Gideros 2011.6<br/>
+
'''modifiers''': (number) modifiers present:<br/>
'''Value:''' keyUp<br/>
+
&nbsp;&nbsp; no key modifier, '''KeyCode.MODIFIER_NONE''', '''0'''<br/>
=== Description ===
+
&nbsp;&nbsp; ''SHIFT'' key modifier, '''KeyCode.MODIFIER_SHIFT''', '''1'''<br/>
<translate>This event is dispatched when a supported key is released. For the list of supported keys, check [[Special:MyLanguage/KeyCode|KeyCode]] class.</translate>
+
&nbsp;&nbsp; ''LEFT ALT'' modifier, '''KeyCode.MODIFIER_ALT''', '''2'''<br/>
=== Parameters ===
+
&nbsp;&nbsp; ''CONTROL'' modifier, '''KeyCode.MODIFIER_CTRL''', '''4'''<br/>
'''keyCode''': (number) <translate>code of the key pressed.</translate><br/>
+
&nbsp;&nbsp; ''RIGHT ALT'' modifier, '''KeyCode.MODIFIER_ALT''', '''6'''<br/>
'''realCode''': (number) <translate>real keyCode underneath</translate><br/>
+
&nbsp;&nbsp; ''META'' modifier, '''KeyCode.MODIFIER_META''', '''8'''<br/>
 +
 
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
function onKeyUp(e)
 +
print(e.keyCode, e.realCode)
 +
end
 +
stage:addEventListener(Event.KEY_UP, onKeyUp)
 +
</syntaxhighlight>
 +
'''note''': for this event to work you need to add your sprite to the stage (scene)
 +
 
 +
=== See also ===
 +
'''[[Event.KEY DOWN]]'''<br/>
 +
'''[[Event.KEY CHAR]]'''
 +
 
 +
{{Sprite}}

Latest revision as of 00:04, 1 August 2025

Available since: Gideros 2011.6
Value: keyUp
Defined by: Sprite

Description

This event is dispatched when a supported key is released. List of supported keys KeyCode Constants.

Parameters

type: (String) keyDown
keyCode: (number) code of the key pressed
realCode: (number) real keyCode underneath
modifiers: (number) modifiers present:
   no key modifier, KeyCode.MODIFIER_NONE, 0
   SHIFT key modifier, KeyCode.MODIFIER_SHIFT, 1
   LEFT ALT modifier, KeyCode.MODIFIER_ALT, 2
   CONTROL modifier, KeyCode.MODIFIER_CTRL, 4
   RIGHT ALT modifier, KeyCode.MODIFIER_ALT, 6
   META modifier, KeyCode.MODIFIER_META, 8

Example

function onKeyUp(e)
	print(e.keyCode, e.realCode)
end
stage:addEventListener(Event.KEY_UP, onKeyUp)

note: for this event to work you need to add your sprite to the stage (scene)

See also

Event.KEY DOWN
Event.KEY CHAR