Difference between revisions of "Event.MOUSE DOWN"

From GiderosMobile
(removed language stuff)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Value:''' mouseDown<br/>
'''<translate>Value</translate>:''' mouseDown<br/>
+
'''Defined by:''' [[Sprite]]<br/>
'''<translate>Defined by</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
 
  
=== <translate>Description</translate> ===
+
=== Description ===
 
This event is dispatched on mouse down action. It is possible to generate this event using touch actions, by enabling this option through project settings.
 
This event is dispatched on mouse down action. It is possible to generate this event using touch actions, by enabling this option through project settings.
  
 
Mouse button can have values of:
 
Mouse button can have values of:
*[[Special:MyLanguage/KeyCode.MOUSE_NONE|KeyCode.MOUSE_NONE]]  
+
*[[KeyCode.MOUSE_NONE]]  
*[[Special:MyLanguage/KeyCode.MOUSE_LEFT|KeyCode.MOUSE_LEFT]]  
+
*[[KeyCode.MOUSE_LEFT]]  
*[[Special:MyLanguage/KeyCode.MOUSE_RIGHT|KeyCode.MOUSE_RIGHT]]  
+
*[[KeyCode.MOUSE_RIGHT]]  
*[[Special:MyLanguage/KeyCode.MOUSE_MIDDLE|KeyCode.MOUSE_MIDDLE]]
+
*[[KeyCode.MOUSE_MIDDLE]]
  
 
Modifiers can have values of:
 
Modifiers can have values of:
*[[Special:MyLanguage/KeyCode.MODIFIER_NONE|KeyCode.MODIFIER_NONE]]  
+
*[[KeyCode.MODIFIER_NONE]]  
*[[Special:MyLanguage/KeyCode.MODIFIER_SHIFT|KeyCode.MODIFIER_SHIFT]]  
+
*[[KeyCode.MODIFIER_SHIFT]]  
*[[Special:MyLanguage/KeyCode.MODIFIER_CTRL|KeyCode.MODIFIER_CTRL]]  
+
*[[KeyCode.MODIFIER_CTRL]]  
*[[Special:MyLanguage/KeyCode.MODIFIER_ALT|KeyCode.MODIFIER_ALT]]  
+
*[[KeyCode.MODIFIER_ALT]]  
*[[Special:MyLanguage/KeyCode.MODIFIER_META|KeyCode.MODIFIER_META]]
+
*[[KeyCode.MODIFIER_META]]
  
=== <translate>Parameters</translate> ===
+
=== Parameters ===
'''x''': (number) <translate>x coordinate of the click</translate><br/>
+
'''x''': (number) x coordinate of the click<br/>
'''y''': (number) <translate>y coordinate of the click</translate><br/>
+
'''y''': (number) y coordinate of the click<br/>
'''rx''': (number) <translate>unrounded x coordinate of the click</translate><br/>
+
'''rx''': (number) unrounded x coordinate of the click<br/>
'''ry''': (number) <translate>unrounded y coordinate of the click</translate><br/>
+
'''ry''': (number) unrounded y coordinate of the click<br/>
'''button''': (number) <translate>Mouse button pressed</translate><br/>
+
'''button''': (number) mouse button pressed<br/>
'''modifiers''': (number) <translate>Modifiers present</translate><br/>
+
'''modifiers''': (number) modifiers present<br/>
'''mouseType''': (string) Origin of the mouse event. possible values: finger, pen, mouse, penTablet<br/>
+
'''mouseType''': (string) origin of the mouse event. possible values: finger, pen, mouse, penTablet<br/>
  
=== <translate>Example</translate> ===
+
=== Example ===
 
<source lang="lua">
 
<source lang="lua">
 
-- event mouse down example
 
-- event mouse down example

Revision as of 18:46, 17 December 2021

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

Description

This event is dispatched on mouse down action. It is possible to generate this event using touch actions, by enabling this option through project settings.

Mouse button can have values of:

Modifiers can have values of:

Parameters

x: (number) x coordinate of the click
y: (number) y coordinate of the click
rx: (number) unrounded x coordinate of the click
ry: (number) unrounded y coordinate of the click
button: (number) mouse button pressed
modifiers: (number) modifiers present
mouseType: (string) origin of the mouse event. possible values: finger, pen, mouse, penTablet

Example

-- event mouse down example
local mypixel = Pixel.new(0xFF0000, 1, 64, 64)
mypixel:setPosition(128, 128)
stage:addChild(mypixel)
mypixel:addEventListener(Event.MOUSE_DOWN, function(e)
	if mypixel:hitTestPoint(e.x, e.y) then
		local x, y = mypixel:globalToLocal(e.x, e.y)
		local button, modifier = e.button, e.modifiers
		print(x, y, button, modifier)
		e:stopPropagation()
	end
end)