Event Class

Defined in: https://github.com/cocos-creator/engine/blob/2fda22be5638065a190bc4c97da6548631319aba/cocos2d/core/event/event.js:32

Module: cc

Base class of all kinds of events.

Index

Properties

• 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.
• NO_TYPE String Code for event without type.
• TOUCH String The type code of Touch event.
• MOUSE String The type code of Mouse event.
• KEYBOARD String The type code of Keyboard event.
• ACCELERATION String The type code of Acceleration event.
• NONE Number Events not currently dispatched are in this phase
• CAPTURING_PHASE Number The capturing phase comprises the journey from the root to the last node before the event target's node
• AT_TARGET Number The target phase comprises only the event target node
• BUBBLING_PHASE Number The bubbling phase comprises any subsequent nodes encountered on the return trip to the root of the hierarchy

Methods

• 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

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.

NO_TYPE

Code for event without type.

TOUCH

The type code of Touch event.

MOUSE

The type code of Mouse event.

KEYBOARD

The type code of Keyboard event.

ACCELERATION

The type code of Acceleration event.

NONE

Events not currently dispatched are in this phase

CAPTURING_PHASE

The capturing phase comprises the journey from the root to the last node before the event target's node see http://www.w3.org/TR/DOM-Level-3-Events/#event-flow

AT_TARGET

The target phase comprises only the event target node see http://www.w3.org/TR/DOM-Level-3-Events/#event-flow

BUBBLING_PHASE

The bubbling phase comprises any subsequent nodes encountered on the return trip to the root of the hierarchy see http://www.w3.org/TR/DOM-Level-3-Events/#event-flow

Methods

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.