Cocos Creator API

1.5.x

Cocos Creator is the game engine for the future.

Event static

Defined in: utils/api/engine/cocos2d/core/event/event.js:31
Module: cc

Base class of all kinds of events.

Properties

type String

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

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. 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 String static

Code for event without type.

TOUCH String static

The type code of Touch event.

MOUSE String static

The type code of Mouse event.

KEYBOARD String static

The type code of Keyboard event.

ACCELERATION String static

The type code of Acceleration event.

NONE Number static

Events not currently dispatched are in this phase

CAPTURING_PHASE Number static

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 Number static

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

BUBBLING_PHASE Number static

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

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Methods

constructor
(
  • type
  • bubbles
)

name type description
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 ( ) String

Reset the event for being stored in the object pool.

returns:

type: String

reuse ( ) String

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

returns:

type: String

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 ( ) Boolean

Checks whether the event has been stopped.

returns:

type: Boolean

getCurrentTarget ( ) Node

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.

returns:

type: Node

The target with which the event associates.

getType ( ) String

Gets the event type.

returns:

type: String

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index