Difference between revisions of "Event.KEY DOWN"

From GiderosMobile
 
(21 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Value:''' keyDown<br/>
 
'''Value:''' keyDown<br/>
 +
'''Defined by:''' [[Sprite]]<br/>
 +
 
=== Description ===
 
=== Description ===
−
Button on controller was pushed down
+
This event is dispatched when a supported key is pressed. For the list of supported keys, check the '''[[KeyCode]]''' class. Modifiers can have values of:
 +
*[[KeyCode.MODIFIER_NONE]]
 +
*[[KeyCode.MODIFIER_SHIFT]]
 +
*[[KeyCode.MODIFIER_CTRL]]
 +
*[[KeyCode.MODIFIER_ALT]]
 +
*[[KeyCode.MODIFIER_META]]
 +
 
 
=== Parameters ===
 
=== Parameters ===
−
'''playerId''': (number) id of controller/player that pressed the button<br/>
+
'''keyCode''': (number) code of the key pressed<br/>
−
'''keyCode''': (number) button key code that was pressed<br/>
 
−
__NOTOC__
 
−
'''Available since:''' Gideros 2011.6<br/>
 
−
'''Value:''' keyDown<br/>
 
−
=== Description ===
 
−
This event is dispatched when a supported key is pressed. For the list of supported keys, check `KeyCode` class.
 
−
=== Parameters ===
 
−
'''keyCode''': (number) code of the key pressed.<br/>
 
 
'''realCode''': (number) real keyCode underneath<br/>
 
'''realCode''': (number) real keyCode underneath<br/>
 +
'''modifiers''': (number) modifiers present, or nil if not supported<br/>
 +
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
function onKeyDown(e)
 +
print(e.keyCode, e.realCode, e.modifiers)
 +
end
 +
 +
stage:addEventListener(Event.KEY_DOWN, onKeyDown)
 +
</syntaxhighlight>
 +
'''note''': for this event to work you need to add your sprite to the stage (scene).
 +
 +
{{Sprite}}

Latest revision as of 12:07, 25 September 2023

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

Description

This event is dispatched when a supported key is pressed. For the list of supported keys, check the KeyCode class. Modifiers can have values of:

Parameters

keyCode: (number) code of the key pressed
realCode: (number) real keyCode underneath
modifiers: (number) modifiers present, or nil if not supported

Example

function onKeyDown(e)
	print(e.keyCode, e.realCode, e.modifiers)
end

stage:addEventListener(Event.KEY_DOWN, onKeyDown)

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





Retrieved from ‘https://wiki.gideros.rocks/index.php?title=Event.KEY_DOWN&oldid=22580’