Cocos2D JavaScript (edge) API Documentation

Class: EventDispatcher

Module
cocos
Defined In
libs/cocos2d/EventDispatcher.js
Extends
BObject
This singleton is responsible for dispatching Mouse and Keyboard events.

Public Properties

Property Defined By
Expand id id : Integer <read-only>
Unique ID for this object
BObject
Expand sharedDispatcher sharedDispatcher : cocos.EventDispatcher <static> <read-only>
A shared singleton instance of cocos.EventDispatcher
EventDispatcher

Public Methods

Method Defined By
Expand EventDispatcher new EventDispatcher () : cocos.EventDispatcher <constructor>
This singleton is responsible for dispatching Mouse and Keyboard events.

Returns

 EventDispatcher
Expand addDelegate addDelegate (opts:*) : void

Arguments

  1. opts :

Returns

  • void
 EventDispatcher
Expand addKeyboardDelegate addKeyboardDelegate (opts:*) : void

Arguments

  1. opts :

Returns

  • void
 EventDispatcher
Expand addMouseDelegate addMouseDelegate (opts:*) : void

Arguments

  1. opts :

Returns

  • void
 EventDispatcher
Expand bindTo bindTo (key:String,target:BOject,[targetKey:String],[noNotify:Boolean]) : void
Bind the value of a property on this object to that of another object so they always have the same value. Setting the value on either object will update the other too.

Arguments

  1. key : String
    Name of the property on this object that should be bound
  2. target : BOject
    Object to bind to
  3. targetKey : String (Optional)
    Key on the target object to bind to
  4. noNotify : Boolean (Optional)
    Set to true to prevent this object's property triggering a 'changed' event when adding the binding

Returns

  • void
 BObject
Expand changed changed (key:*) : void

Arguments

  1. key :

Returns

  • void
 BObject
Expand get get (key:String) : *
Get a property from the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly.

Arguments

  1. key : String
    Name of property to get or dot (.) separated path to a property

Returns

  • *
    Value of the property
 BObject
Expand keyDown keyDown (evt:*) : void

Arguments

  1. evt :

Returns

  • void
 EventDispatcher
Expand keyUp keyUp (evt:*) : void

Arguments

  1. evt :

Returns

  • void
 EventDispatcher
Expand mouseDown mouseDown (evt:*) : void

Arguments

  1. evt :

Returns

  • void
 EventDispatcher
Expand mouseDragged mouseDragged (evt:*) : void

Arguments

  1. evt :

Returns

  • void
 EventDispatcher
Expand mouseMoved mouseMoved (evt:*) : void

Arguments

  1. evt :

Returns

  • void
 EventDispatcher
Expand mouseUp mouseUp (evt:*) : void

Arguments

  1. evt :

Returns

  • void
 EventDispatcher
Expand removeAllDelegates removeAllDelegates (opts:*) : void

Arguments

  1. opts :

Returns

  • void
 EventDispatcher
Expand removeAllKeyboardDelegate removeAllKeyboardDelegate () : void

Returns

  • void
 EventDispatcher
Expand removeAllMouseDelegate removeAllMouseDelegate () : void

Returns

  • void
 EventDispatcher
Expand removeDelegate removeDelegate (opts:*) : void

Arguments

  1. opts :

Returns

  • void
 EventDispatcher
Expand removeKeyboardDelegate removeKeyboardDelegate (opts:*) : void

Arguments

  1. opts :

Returns

  • void
 EventDispatcher
Expand removeMouseDelegate removeMouseDelegate (opts:*) : void

Arguments

  1. opts :

Returns

  • void
 EventDispatcher
Expand set set (key:String,value:*) : void
Set a property on the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly.

Arguments

  1. key : String
    Name of property to get
  2. value : *
    New value for the property

Returns

  • void
 BObject
Expand setValues setValues (kvp:Object) : void
Set multiple propertys in one go

Arguments

  1. kvp : Object
    An Object where the key is a property name and the value is the value to assign to the property

Returns

  • void
 BObject
Expand unbind unbind (key:String) : void
Remove binding from a property which set setup using BObject#bindTo.

Arguments

  1. key : String
    Name of the property on this object to unbind

Returns

  • void
 BObject
Expand unbindAll unbindAll () : void
Remove all bindings on this object

Returns

  • void
 BObject

Private Members

This class has no private members.