Difference between revisions of "Application:getKeyboardModifiers"

From GiderosMobile
(added example from rrraptor)
m (Text replacement - "<source" to "<syntaxhighlight")
 
(4 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
=== Description ===
 
=== Description ===
 
Returns the current keyboard modifiers.
 
Returns the current keyboard modifiers.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(number) = application:getKeyboardModifiers()
 
(number) = application:getKeyboardModifiers()
</source>
+
</syntaxhighlight>
  
 
=== Return values ===
 
=== Return values ===
 
'''Returns''' (number) the current modifiers bitfield<br/>
 
'''Returns''' (number) the current modifiers bitfield<br/>
  
=== Example ===
+
=== Examples ===
 
'''Checks if Control key is pressed'''
 
'''Checks if Control key is pressed'''
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
stage:addEventListener(Event.KEY_DOWN, function(e)
 
stage:addEventListener(Event.KEY_DOWN, function(e)
 
local modifier = application:getKeyboardModifiers()
 
local modifier = application:getKeyboardModifiers()
Line 23: Line 23:
 
print("CRTL: ", (modifier & KeyCode.MODIFIER_CTRL) > 0)
 
print("CRTL: ", (modifier & KeyCode.MODIFIER_CTRL) > 0)
 
end)
 
end)
</source>
+
</syntaxhighlight>
 +
 
 +
'''Checks if Control and Shift keys are pressed'''
 +
<syntaxhighlight lang="lua">
 +
stage:addEventListener(Event.KEY_DOWN, function(e)
 +
local modifier = application:getKeyboardModifiers()
 +
print("CRTL & SHIFT: ", modifier & KeyCode.MODIFIER_CTRL > 0 and modifier & KeyCode.MODIFIER_SHIFT > 0)
 +
end)
 +
 
 +
stage:addEventListener(Event.KEY_UP, function(e)
 +
local modifier = application:getKeyboardModifiers()
 +
print("CRTL & SHIFT: ", modifier & KeyCode.MODIFIER_CTRL > 0 and modifier & KeyCode.MODIFIER_SHIFT > 0)
 +
end)
 +
</syntaxhighlight>
  
 
{{Application}}
 
{{Application}}

Latest revision as of 16:36, 12 July 2023

Available since: Gideros 2019.5
Class: Application

Description

Returns the current keyboard modifiers.

(number) = application:getKeyboardModifiers()

Return values

Returns (number) the current modifiers bitfield

Examples

Checks if Control key is pressed

stage:addEventListener(Event.KEY_DOWN, function(e)
	local modifier = application:getKeyboardModifiers()
	print("CRTL: ", (modifier & KeyCode.MODIFIER_CTRL) > 0)
end)

stage:addEventListener(Event.KEY_UP, function(e)
	local modifier = application:getKeyboardModifiers()
	print("CRTL: ", (modifier & KeyCode.MODIFIER_CTRL) > 0)
end)

Checks if Control and Shift keys are pressed

stage:addEventListener(Event.KEY_DOWN, function(e)
	local modifier = application:getKeyboardModifiers()
	print("CRTL & SHIFT: ", modifier & KeyCode.MODIFIER_CTRL > 0 and modifier & KeyCode.MODIFIER_SHIFT > 0)
end)

stage:addEventListener(Event.KEY_UP, function(e)
	local modifier = application:getKeyboardModifiers()
	print("CRTL & SHIFT: ", modifier & KeyCode.MODIFIER_CTRL > 0 and modifier & KeyCode.MODIFIER_SHIFT > 0)
end)