EventListenerCustom Class Reference

Usage: auto dispatcher = EventDispatcher::getInstance(); Adds a listener: More...

#include <CCEventListenerCustom.h>

Inheritance diagram for EventListenerCustom:

Public Member Functions
virtual bool	checkAvaiable () override
	Overrides. More...
virtual EventListenerCustom *	clone () override
	Clones the listener, its subclasses have to override this method. More...
local	clone ()
	Clones the listener, its subclasses have to override this method. More...
Public Member Functions inherited from EventListener
virtual	~EventListener ()
	Destructor. More...
Public Member Functions inherited from Object
	Object ()
	Constructor. More...
virtual	~Object ()
void	release ()
	Release the ownership immediately. More...
void	retain ()
	Retains the ownership. More...
Object *	autorelease ()
	Release the ownership sometime soon automatically. More...
bool	isSingleReference () const
	Returns a boolean value that indicates whether there is only one reference to the object. More...
unsigned int	retainCount () const
	Returns the object's current reference count. More...
virtual bool	isEqual (const Object *object)
	Returns a boolean value that indicates whether this object and a given object are equal. More...
virtual void	acceptVisitor (DataVisitor &visitor)
virtual void	update (float dt)

Static Public Member Functions
static EventListenerCustom *	create (const std::string &eventName, std::function< void(EventCustom *)> callback)
	Creates an event listener with type and callback. More...
local	create ( local eventName, local callback)
	Creates an event listener with type and callback. More...

Protected Member Functions
	EventListenerCustom ()
	Constructor. More...
bool	init (const std::string &eventName, std::function< void(EventCustom *)> callback)
	Initializes event with type and callback function. More...
Protected Member Functions inherited from EventListener
	EventListener ()
	Constructor. More...
	EventListener ()
	Constructor. More...
bool	init (const std::string &t, std::function< void(Event *)>callback)
	Initializes event with type and callback function. More...
local	init ( local t, local callback)
	Initializes event with type and callback function. More...

Protected Attributes
std::function< void(EventCustom *)>	_onCustomEvent
var	_onCustomEvent
local	_onCustomEvent
Protected Attributes inherited from EventListener
std::function< void(Event *)>	_onEvent
local	_onEvent
std::string	_type
	Event callback function. More...
var	_type
	Event callback function. More...
local	_type
	Event callback function. More...
bool	_isRegistered
	Event type. More...
Protected Attributes inherited from Object
unsigned int	_reference
	count of references More...
var	_reference
	count of references More...
local	_reference
	count of references More...
unsigned int	_autoReleaseCount
	count of autorelease More...
var	_autoReleaseCount
	count of autorelease More...
local	_autoReleaseCount
	count of autorelease More...

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID More...
int	_luaID
	Lua reference id. More...

Detailed Description

Usage: auto dispatcher = EventDispatcher::getInstance(); Adds a listener:

auto callback = [](CustomEvent* event){ do_some_thing(); }; auto listener = CustomEventListener::create(callback); dispatcher->addEventListenerWithSceneGraphPriority(listener, one_node);

Dispatchs a custom event:

Event event("your_event_type"); dispatcher->dispatchEvent(&event);

Removes a listener

dispatcher->removeListener(listener);

Constructor & Destructor Documentation

EventListenerCustom ( )

protected

Constructor.

var EventListenerCustom ( )

protected

Constructor.

local EventListenerCustom ( )

protected

Constructor.

Member Function Documentation

virtual bool checkAvaiable ( )

overridevirtual

Overrides.

Implements EventListener.

var checkAvaiable ( )

overridevirtual

Overrides.

Implements EventListener.

local checkAvaiable ( )

overridevirtual

Overrides.

Implements EventListener.

virtual EventListenerCustom* clone ( )

overridevirtual

Clones the listener, its subclasses have to override this method.

Implements EventListener.

var clone ( )

overridevirtual

Clones the listener, its subclasses have to override this method.

Implements EventListener.

local clone ( )

overridevirtual

Clones the listener, its subclasses have to override this method.

Implements EventListener.

static EventListenerCustom* create ( const std::string &  eventName, std::function< void(EventCustom *)>  callback  )

static

Creates an event listener with type and callback.

Parameters

eventType	The type of the event.
callback	The callback function when the specified event was emitted.

var create ( var  eventName, var  callback  )

static

Creates an event listener with type and callback.

Parameters

eventType	The type of the event.
callback	The callback function when the specified event was emitted.

local create ( local  eventName, local  callback  )

static

Creates an event listener with type and callback.

Parameters

eventType	The type of the event.
callback	The callback function when the specified event was emitted.

bool init ( const std::string &  eventName, std::function< void(EventCustom *)>  callback  )

protected

Initializes event with type and callback function.

var init ( var  eventName, var  callback  )

protected

Initializes event with type and callback function.

local init ( local  eventName, local  callback  )

protected

Initializes event with type and callback function.

Member Data Documentation

std::function<void(EventCustom*)> _onCustomEvent

protected

var _onCustomEvent

protected

local _onCustomEvent

protected

---

The documentation for this class was generated from the following file:

• /Users/cocos2d/MyWork/cocos2d-x-develop/cocos2dx/event_dispatcher/CCEventListenerCustom.h