Difference between revisions of "Event.KEY DOWN"

From GiderosMobile
(Undo revision 17092 by MoKaLux (talk))
Tag: Undo
 
(9 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:''' [[Controller]]<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:
=== Parameters ===
+
*[[KeyCode.MODIFIER_NONE]]
'''playerId''': (number) id of controller/player that pressed the button<br/>
+
*[[KeyCode.MODIFIER_SHIFT]]
'''keyCode''': (number) button key code that was pressed<br/>
+
*[[KeyCode.MODIFIER_CTRL]]
 +
*[[KeyCode.MODIFIER_ALT]]
 +
*[[KeyCode.MODIFIER_META]]
  
 
----
 
 
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Value:''' keyDown<br/>
 
'''Defined by:''' [[Sprite]]<br/>
 
=== Description ===
 
This event is dispatched when a supported key is pressed. For the list of supported keys, check [[KeyCode]] class.
 
 
=== Parameters ===
 
=== Parameters ===
'''keyCode''': (number) code of the key pressed.<br/>
+
'''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 ===
 
=== Example ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
function onKeyDown(e)
 
function onKeyDown(e)
print(e.keyCode, e.realCode)
+
print(e.keyCode, e.realCode, e.modifiers)
 
end
 
end
  
 
stage:addEventListener(Event.KEY_DOWN, onKeyDown)
 
stage:addEventListener(Event.KEY_DOWN, onKeyDown)
</source>
+
</syntaxhighlight>
 +
'''note''': for this event to work you need to add your sprite to the stage (scene).
  
{{GIDEROS IMPORTANT LINKS}}
+
{{Sprite}}

Latest revision as of 11: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).