openfl.events.MouseEvent - OpenFL API Reference

A MouseEvent object is dispatched into the event flow whenever mouse events occur. A mouse event is usually generated by a user input device, such as a mouse or a trackball, that uses a pointer.

When nested nodes are involved, mouse events target the deepest possible nested node that is visible in the display list. This node is called the target node. To have a target node's ancestor receive notification of a mouse event, use EventDispatcher.addEventListener() on the ancestor node with the type parameter set to the specific mouse event you want to detect.

Static variables

`@:value("click")staticinlineread onlyCLICK:EventType<MouseEvent> = "click"`

Defines the value of the type property of a click event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	For click events, this value is always `false`.
`cancelable`	`false`; there is no default behavior to cancel.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("doubleClick")staticinlineread onlyDOUBLE_CLICK:EventType<MouseEvent> = "doubleClick"`

Defines the value of the type property of a doubleClick event object. The doubleClickEnabled property must be true for an object to generate the doubleClick event. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	For double-click events, this value is always `false`.
`cancelable`	`false`; there is no default behavior to cancel.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("middleClick")staticinlineread onlyMIDDLE_CLICK:EventType<MouseEvent> = "middleClick"`

Defines the value of the type property of a middleClick event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	For middle-click events, this property is always `false`.
`cancelable`	`false`; there is no default behavior to cancel.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("middleMouseDown")staticinlineread onlyMIDDLE_MOUSE_DOWN:EventType<MouseEvent> = "middleMouseDown"`

Defines the value of the type property of a middleMouseDown event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the middle mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`clickCount`	Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("middleMouseUp")staticinlineread onlyMIDDLE_MOUSE_UP:EventType<MouseEvent> = "middleMouseUp"`

Defines the value of the type property of a middleMouseUp event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the middle mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`clickCount`	Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("mouseDown")staticinlineread onlyMOUSE_DOWN:EventType<MouseEvent> = "mouseDown"`

Defines the value of the type property of a mouseDown event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows and Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`clickCount`	Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("mouseMove")staticinlineread onlyMOUSE_MOVE:EventType<MouseEvent> = "mouseMove"`

Defines the value of the type property of a mouseMove event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("mouseOut")staticinlineread onlyMOUSE_OUT:EventType<MouseEvent> = "mouseOut"`

Defines the value of the type property of a mouseOut event object.

This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`relatedObject`	The display list object to which the pointing device now points.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("mouseOver")staticinlineread onlyMOUSE_OVER:EventType<MouseEvent> = "mouseOver"`

Defines the value of the type property of a mouseOver event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`relatedObject`	The display list object to which the pointing device was pointing.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("mouseUp")staticinlineread onlyMOUSE_UP:EventType<MouseEvent> = "mouseUp"`

Defines the value of the type property of a mouseUp event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`clickCount`	Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("mouseWheel")staticinlineread onlyMOUSE_WHEEL:EventType<MouseEvent> = "mouseWheel"`

Defines the value of the type property of a mouseWheel event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`delta`	The number of lines that that each notch on the mouse wheel represents.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("releaseOutside")staticinlineread onlyRELEASE_OUTSIDE:EventType<MouseEvent> = "releaseOutside"`

Defines the value of the type property of a releaseOutside event object.

This event has the following properties:

`@:value("rightClick")staticinlineread onlyRIGHT_CLICK:EventType<MouseEvent> = "rightClick"`

Defines the value of the type property of a rightClick event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	For right-click events, this property is always `false`.
`cancelable`	`false`; there is no default behavior to cancel.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("rightMouseDown")staticinlineread onlyRIGHT_MOUSE_DOWN:EventType<MouseEvent> = "rightMouseDown"`

Defines the value of the type property of a rightMouseDown event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	For right-click events, this property is always `true`.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`clickCount`	Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("rightMouseUp")staticinlineread onlyRIGHT_MOUSE_UP:EventType<MouseEvent> = "rightMouseUp"`

Defines the value of the type property of a rightMouseUp event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	`true` if the right mouse button is pressed; `false` otherwise.
`cancelable`	`false`; the default behavior cannot be canceled.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`clickCount`	Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("rollOut")staticinlineread onlyROLL_OUT:EventType<MouseEvent> = "rollOut"`

Defines the value of the type property of a rollOut event object. This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`false`
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`cancelable`	`false`; there is no default behavior to cancel.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`relatedObject`	The display list object to which the pointing device now points.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

`@:value("rollOver")staticinlineread onlyROLL_OVER:EventType<MouseEvent> = "rollOver"`

Defines the value of the type property of a rollOver event object.

This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`false`
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`cancelable`	`false`; there is no default behavior to cancel.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`relatedObject`	The display list object to which the pointing device was pointing.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Constructor

@:value({ clickCount : 0, controlKey : false, commandKey : false, delta : 0, buttonDown : false, shiftKey : false, altKey : false, ctrlKey : false, relatedObject : null, localY : 0, localX : 0, cancelable : false, bubbles : true })new(type:String, bubbles:Bool = true, cancelable:Bool = false, localX:Float = 0, localY:Float = 0, ?relatedObject:InteractiveObject, ctrlKey:Bool = false, altKey:Bool = false, shiftKey:Bool = false, buttonDown:Bool = false, delta:Int = 0, commandKey:Bool = false, controlKey:Bool = false, clickCount:Int = 0)

Creates an Event object that contains information about mouse events. Event objects are passed as parameters to event listeners.

Parameters:

`type`	The type of the event. Possible values are: `MouseEvent.CLICK`, `MouseEvent.DOUBLE_CLICK`, `MouseEvent.MOUSE_DOWN`, `MouseEvent.MOUSE_MOVE`, `MouseEvent.MOUSE_OUT`, `MouseEvent.MOUSE_OVER`, `MouseEvent.MOUSE_UP`, `MouseEvent.MIDDLE_CLICK`, `MouseEvent.MIDDLE_MOUSE_DOWN`, `MouseEvent.MIDDLE_MOUSE_UP`, `MouseEvent.RIGHT_CLICK`, `MouseEvent.RIGHT_MOUSE_DOWN`, `MouseEvent.RIGHT_MOUSE_UP`, `MouseEvent.MOUSE_WHEEL`, `MouseEvent.ROLL_OUT`, and `MouseEvent.ROLL_OVER`.
`bubbles`	Determines whether the Event object participates in the bubbling phase of the event flow.
`cancelable`	Determines whether the Event object can be canceled.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`relatedObject`	The complementary InteractiveObject instance that is affected by the event. For example, when a `mouseOut` event occurs, `relatedObject` represents the display list object to which the pointing device now points.
`ctrlKey`	On Windows or Linux, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated.
`altKey`	Indicates whether the Alt key is activated(Windows or Linux only).
`shiftKey`	Indicates whether the Shift key is activated.
`buttonDown`	Indicates whether the primary mouse button is pressed.
`delta`	Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but faster rotation may produce larger values. This parameter is used only for the `MouseEvent.mouseWheel` event.

Variables

`altKey:Bool`

Indicates whether the Alt key is active (true) or inactive (false). Supported for Windows only. On other operating systems, this property is always set to false.

`buttonDown:Bool`

Indicates whether the primary mouse button is pressed (true) or not (false).

`clickCount:Int`

Indicates whether or not the mouse down event is part of a multi-click sequence. This parameter will be zero for all mouse events other than MouseEvent.mouseDown, MouseEvent.mouseUp, MouseEvent.middleMouseDown, MouseEvent.middleMouseUp, MouseEvent.rightMouseDown, and MouseEvent.rightMouseUp. Listening for single clicks, double clicks, or any multi-click sequence is possible with the clickCount parameter. For example, an initial MouseEvent.mouseDown and MouseEvent.mouseUp will have a clickCount of 1, and the second MouseEvent.mouseDown and MouseEvent.mouseUp in a double-click sequence will have a clickCount of 2. If the mouse moves sufficiently or the multi-click sequence is interrupted for some reason, then the next MouseEvent.mouseDown will have a clickCount of 1. The doubleClick event will continue to fire as expected.

`commandKey:Bool`

Indicates whether the command key is activated (Mac only.)

The value of property commandKey will have the same value as property ctrlKey on the Mac. Always false on Windows or Linux.

`controlKey:Bool`

Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.

`ctrlKey:Bool`

On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false). On Macintosh, indicates whether either the Control key or the Command key is activated.

`delta:Int`

Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but faster rotation may produce larger values. This setting depends on the device and operating system and is usually configurable by the user. This property applies only to the MouseEvent.mouseWheel event.

`isRelatedObjectInaccessible:Bool`

If true, the relatedObject property is set to null for reasons related to security sandboxes. If the nominal value of relatedObject is a reference to a DisplayObject in another sandbox, relatedObject is set to null unless there is permission in both directions across this sandbox boundary. Permission is established by calling Security.allowDomain() from a SWF file, or by providing a policy file from the server of an image file, and setting the LoaderContext.checkPolicyFile property when loading the image.

`localX:Float`

The horizontal coordinate at which the event occurred relative to the containing sprite.

`localY:Float`

The vertical coordinate at which the event occurred relative to the containing sprite.

`relatedObject:InteractiveObject`

A reference to a display list object that is related to the event. For example, when a mouseOut event occurs, relatedObject represents the display list object to which the pointing device now points. This property applies to the mouseOut, mouseOver, rollOut, and rollOver events.

The value of this property can be null in two circumstances: if there no related object, or there is a related object, but it is in a security sandbox to which you don't have access. Use the isRelatedObjectInaccessible() property to determine which of these reasons applies.

`shiftKey:Bool`

Indicates whether the Shift key is active (true) or inactive (false).

`stageX:Float`

The horizontal coordinate at which the event occurred in global Stage coordinates. This property is calculated when the localX property is set.

`stageY:Float`

The vertical coordinate at which the event occurred in global Stage coordinates. This property is calculated when the localY property is set.

Methods

`updateAfterEvent():Void`

Instructs OpenFL to render after processing of this event completes, if the display list has been modified.

On all targets except Flash/AIR, requires openfl_always_dispatch_mouse_events to be defined because OpenFL will throttle mouse events to the frame rate.

Inherited Variables

Defined by Event

Inherited Methods

Defined by Event

`@:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String`

A utility function for implementing the toString() method in custom OpenFL Event classes. Overriding the toString() method is recommended, but not required.

class PingEvent extends Event {
	var URL:String;

	public function new() {
		super();
	}

	public override function toString():String {
		return formatToString("PingEvent", "type", "bubbles", "cancelable", "eventPhase", "URL");
	}
}

Parameters:

`className`	The name of your custom Event class. In the previous example, the `className` parameter is `PingEvent`.

Returns:

The name of your custom Event class and the String value of your ...arguments parameter.

`isDefaultPrevented():Bool`

Checks whether the preventDefault() method has been called on the event. If the preventDefault() method has been called, returns true; otherwise, returns false.

Returns:

If preventDefault() has been called, returns true; otherwise, returns false.

`preventDefault():Void`

Cancels an event's default behavior if that behavior can be canceled. Many events have associated behaviors that are carried out by default. For example, if a user types a character into a text field, the default behavior is that the character is displayed in the text field. Because the TextEvent.TEXT_INPUT event's default behavior can be canceled, you can use the preventDefault() method to prevent the character from appearing. An example of a behavior that is not cancelable is the default behavior associated with the Event.REMOVED event, which is generated whenever Flash Player is about to remove a display object from the display list. The default behavior (removing the element) cannot be canceled, so the preventDefault() method has no effect on this default behavior. You can use the Event.cancelable property to check whether you can prevent the default behavior associated with a particular event. If the value of Event.cancelable is true, then preventDefault() can be used to cancel the event; otherwise, preventDefault() has no effect.

`stopImmediatePropagation():Void`

Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. This method takes effect immediately, and it affects event listeners in the current node. In contrast, the stopPropagation() method doesn't take effect until all the event listeners in the current node finish processing.

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

`stopPropagation():Void`

Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

class MouseEvent

package openfl.events

extends Event

extended by ScreenMouseEvent

Static variables

@:value("click")staticinlineread onlyCLICK:EventType<MouseEvent> = "click"

@:value("doubleClick")staticinlineread onlyDOUBLE_CLICK:EventType<MouseEvent> = "doubleClick"

@:value("middleClick")staticinlineread onlyMIDDLE_CLICK:EventType<MouseEvent> = "middleClick"

@:value("middleMouseDown")staticinlineread onlyMIDDLE_MOUSE_DOWN:EventType<MouseEvent> = "middleMouseDown"

@:value("middleMouseUp")staticinlineread onlyMIDDLE_MOUSE_UP:EventType<MouseEvent> = "middleMouseUp"

@:value("mouseDown")staticinlineread onlyMOUSE_DOWN:EventType<MouseEvent> = "mouseDown"

@:value("mouseMove")staticinlineread onlyMOUSE_MOVE:EventType<MouseEvent> = "mouseMove"

@:value("mouseOut")staticinlineread onlyMOUSE_OUT:EventType<MouseEvent> = "mouseOut"

@:value("mouseOver")staticinlineread onlyMOUSE_OVER:EventType<MouseEvent> = "mouseOver"

@:value("mouseUp")staticinlineread onlyMOUSE_UP:EventType<MouseEvent> = "mouseUp"

@:value("mouseWheel")staticinlineread onlyMOUSE_WHEEL:EventType<MouseEvent> = "mouseWheel"

@:value("releaseOutside")staticinlineread onlyRELEASE_OUTSIDE:EventType<MouseEvent> = "releaseOutside"

@:value("rightClick")staticinlineread onlyRIGHT_CLICK:EventType<MouseEvent> = "rightClick"

@:value("rightMouseDown")staticinlineread onlyRIGHT_MOUSE_DOWN:EventType<MouseEvent> = "rightMouseDown"

@:value("rightMouseUp")staticinlineread onlyRIGHT_MOUSE_UP:EventType<MouseEvent> = "rightMouseUp"

@:value("rollOut")staticinlineread onlyROLL_OUT:EventType<MouseEvent> = "rollOut"

@:value("rollOver")staticinlineread onlyROLL_OVER:EventType<MouseEvent> = "rollOver"

Constructor

Variables

altKey:Bool

buttonDown:Bool

clickCount:Int

commandKey:Bool

controlKey:Bool

ctrlKey:Bool

delta:Int

isRelatedObjectInaccessible:Bool

localX:Float

localY:Float

relatedObject:InteractiveObject

shiftKey:Bool

stageX:Float

stageY:Float

Methods

updateAfterEvent():Void

Inherited Variables

Defined by Event

read onlybubbles:Bool

read onlycancelable:Bool

read onlycurrentTarget:Object

read onlyeventPhase:EventPhase

read onlytarget:Object

read onlytype:String

Inherited Methods

Defined by Event

@:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

isDefaultPrevented():Bool

preventDefault():Void

stopImmediatePropagation():Void

stopPropagation():Void

`@:value("click")staticinlineread onlyCLICK:EventType<MouseEvent> = "click"`

`@:value("doubleClick")staticinlineread onlyDOUBLE_CLICK:EventType<MouseEvent> = "doubleClick"`

`@:value("middleClick")staticinlineread onlyMIDDLE_CLICK:EventType<MouseEvent> = "middleClick"`

`@:value("middleMouseDown")staticinlineread onlyMIDDLE_MOUSE_DOWN:EventType<MouseEvent> = "middleMouseDown"`

`@:value("middleMouseUp")staticinlineread onlyMIDDLE_MOUSE_UP:EventType<MouseEvent> = "middleMouseUp"`

`@:value("mouseDown")staticinlineread onlyMOUSE_DOWN:EventType<MouseEvent> = "mouseDown"`

`@:value("mouseMove")staticinlineread onlyMOUSE_MOVE:EventType<MouseEvent> = "mouseMove"`

`@:value("mouseOut")staticinlineread onlyMOUSE_OUT:EventType<MouseEvent> = "mouseOut"`

`@:value("mouseOver")staticinlineread onlyMOUSE_OVER:EventType<MouseEvent> = "mouseOver"`

`@:value("mouseUp")staticinlineread onlyMOUSE_UP:EventType<MouseEvent> = "mouseUp"`

`@:value("mouseWheel")staticinlineread onlyMOUSE_WHEEL:EventType<MouseEvent> = "mouseWheel"`

`@:value("releaseOutside")staticinlineread onlyRELEASE_OUTSIDE:EventType<MouseEvent> = "releaseOutside"`

`@:value("rightClick")staticinlineread onlyRIGHT_CLICK:EventType<MouseEvent> = "rightClick"`

`@:value("rightMouseDown")staticinlineread onlyRIGHT_MOUSE_DOWN:EventType<MouseEvent> = "rightMouseDown"`

`@:value("rightMouseUp")staticinlineread onlyRIGHT_MOUSE_UP:EventType<MouseEvent> = "rightMouseUp"`

`@:value("rollOut")staticinlineread onlyROLL_OUT:EventType<MouseEvent> = "rollOut"`

`@:value("rollOver")staticinlineread onlyROLL_OVER:EventType<MouseEvent> = "rollOver"`

`altKey:Bool`

`buttonDown:Bool`

`clickCount:Int`

`commandKey:Bool`

`controlKey:Bool`

`ctrlKey:Bool`

`delta:Int`

`isRelatedObjectInaccessible:Bool`

`localX:Float`

`localY:Float`

`relatedObject:InteractiveObject`

`shiftKey:Bool`

`stageX:Float`

`stageY:Float`

`updateAfterEvent():Void`

`read onlybubbles:Bool`

`read onlycancelable:Bool`

`read onlycurrentTarget:Object`

`read onlyeventPhase:EventPhase`

`read onlytarget:Object`

`read onlytype:String`

`@:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String`

`isDefaultPrevented():Bool`

`preventDefault():Void`

`stopImmediatePropagation():Void`

`stopPropagation():Void`