Event.EventMouse Class

Extends Event

Module: cc

The mouse event

Index

Properties

• NONE Number The none event code of mouse event.
• DOWN Number The event type code of mouse down event.
• UP Number The event type code of mouse up event.
• MOVE Number The event type code of mouse move event.
• SCROLL Number The event type code of mouse scroll event.
• BUTTON_LEFT Number The tag of Mouse left button.
• BUTTON_RIGHT Number The tag of Mouse right button (The right button number is 2 on browser).
• BUTTON_MIDDLE Number The tag of Mouse middle button (The right button number is 1 on browser).
• BUTTON_4 Number The tag of Mouse button 4.
• BUTTON_5 Number The tag of Mouse button 5.
• BUTTON_6 Number The tag of Mouse button 6.
• BUTTON_7 Number The tag of Mouse button 7.
• BUTTON_8 Number The tag of Mouse button 8.
• type String The name of the event (case-sensitive), e.g.
• bubbles Boolean Indicate whether the event bubbles up through the tree or not.
• target Object A reference to the target to which the event was originally dispatched.
• currentTarget Object A reference to the currently registered target for the event.
• eventPhase Number Indicates which phase of the event flow is currently being evaluated.

Methods

• setScrollData Sets scroll data.
• getScrollX Returns the x axis scroll value.
• getScrollY Returns the y axis scroll value.
• setLocation Sets cursor location.
• getLocation Returns cursor location.
• getLocationInView Returns the current cursor location in screen coordinates.
• getPreviousLocation Returns the previous touch location.
• getDelta Returns the delta distance from the previous location to current location.
• getDeltaX Returns the X axis delta distance from the previous location to current location.
• getDeltaY Returns the Y axis delta distance from the previous location to current location.
• setButton Sets mouse button.
• getButton Returns mouse button.
• getLocationX Returns location X axis data.
• getLocationY Returns location Y axis data.
• constructor
• unuse Reset the event for being stored in the object pool.
• reuse Reuse the event for being used again by the object pool.
• stopPropagation Stops propagation for current event.
• stopPropagationImmediate Stops propagation for current event immediately,...
• isStopped Checks whether the event has been stopped.
• getCurrentTarget note: It only be available when the event listener is associated with node.
• getType Gets the event type.

Details

Properties

NONE

The none event code of mouse event.

DOWN

The event type code of mouse down event.

UP

The event type code of mouse up event.

MOVE

The event type code of mouse move event.

SCROLL

The event type code of mouse scroll event.

BUTTON_LEFT

The tag of Mouse left button.

BUTTON_RIGHT

The tag of Mouse right button (The right button number is 2 on browser).

BUTTON_MIDDLE

The tag of Mouse middle button (The right button number is 1 on browser).

BUTTON_4

The tag of Mouse button 4.

BUTTON_5

The tag of Mouse button 5.

BUTTON_6

The tag of Mouse button 6.

BUTTON_7

The tag of Mouse button 7.

BUTTON_8

The tag of Mouse button 8.

type

The name of the event (case-sensitive), e.g. "click", "fire", or "submit".

bubbles

Indicate whether the event bubbles up through the tree or not.

target

A reference to the target to which the event was originally dispatched.

currentTarget

A reference to the currently registered target for the event.

eventPhase

Indicates which phase of the event flow is currently being evaluated. Returns an integer value represented by 4 constants:

• Event.NONE = 0
• Event.CAPTURING_PHASE = 1
• Event.AT_TARGET = 2
• Event.BUBBLING_PHASE = 3 The phases are explained in the [section 3.1, Event dispatch and DOM event flow] (http://www.w3.org/TR/DOM-Level-3-Events/#event-flow), of the DOM Level 3 Events specification.

Methods

setScrollData

Sets scroll data.

Parameters

• scrollX Number
• scrollY Number

getScrollX

Returns the x axis scroll value.

getScrollY

Returns the y axis scroll value.

setLocation

Sets cursor location.

Parameters

• x Number
• y Number

getLocation

Returns cursor location.

getLocationInView

Returns the current cursor location in screen coordinates.

getPreviousLocation

Returns the previous touch location.

getDelta

Returns the delta distance from the previous location to current location.

getDeltaX

Returns the X axis delta distance from the previous location to current location.

getDeltaY

Returns the Y axis delta distance from the previous location to current location.

setButton

Sets mouse button.

Parameters

• button Number

getButton

Returns mouse button.

getLocationX

Returns location X axis data.

getLocationY

Returns location Y axis data.

constructor

Parameters

• type String The name of the event (case-sensitive), e.g. "click", "fire", or "submit"
• bubbles Boolean A boolean indicating whether the event bubbles up through the tree or not

unuse

Reset the event for being stored in the object pool.

reuse

Reuse the event for being used again by the object pool.

stopPropagation

Stops propagation for current event.

stopPropagationImmediate

Stops propagation for current event immediately, the event won't even be dispatched to the listeners attached in the current target.

isStopped

Checks whether the event has been stopped.

getCurrentTarget

Gets current target of the event
note: It only be available when the event listener is associated with node.
It returns 0 when the listener is associated with fixed priority.

getType

Gets the event type.