cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
EventListenerCustom Class Reference

Custom event listener. More...

#include <CCEventListenerCustom.h>

Inheritance diagram for EventListenerCustom:
EventListener Ref EventListenerPhysicsContact EventListenerAssetsManagerEx EventListenerPhysicsContactWithBodies EventListenerPhysicsContactWithGroup EventListenerPhysicsContactWithShapes

Public Member Functions

virtual bool checkAvailable () override
 Overrides. More...
 
virtual EventListenerCustomclone () 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...
 
bool init (const ListenerID &listenerId, const std::function< void(EventCustom *)> &callback)
 Initializes event with type and callback function. More...
 
- Public Member Functions inherited from EventListener
bool init (Type t, const ListenerID &listenerID, const std::function< void(Event *)> &callback)
 Initializes event with type and callback function. More...
 
virtual ~EventListener ()
 Destructor. More...
 
void setEnabled (bool enabled)
 Enables or disables the listener. More...
 
local setEnabled ( local enabled)
 Enables or disables the listener. More...
 
bool isEnabled () const
 Checks whether the listener is enabled. More...
 
local isEnabled ()
 Checks whether the listener is enabled. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Static Public Member Functions

static EventListenerCustomcreate (const std::string &eventName, const 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...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: EventListenerCustom()
- Public Attributes inherited from EventListener
CC_CONSTRUCTOR_ACCESS __pad0__: EventListener()
var __pad0__: EventListener()
local __pad0__: EventListener()

Protected Attributes

std::function< void(EventCustom *)> _onCustomEvent
var _onCustomEvent
- Protected Attributes inherited from EventListener
std::function< void(Event *)> _onEvent
Type _type
 Event callback function. More...
 
var _type
 Event callback function. More...
 
local _type
 Event callback function. More...
 
ListenerID _listenerID
 Event listener type. More...
 
var _listenerID
 Event listener type. More...
 
local _listenerID
 Event listener type. More...
 
bool _isRegistered
 Event listener ID. More...
 
var _isRegistered
 Event listener ID. More...
 
local _isRegistered
 Event listener ID. More...
 
int _fixedPriority
 Whether the listener has been added to dispatcher. More...
 
var _fixedPriority
 Whether the listener has been added to dispatcher. More...
 
local _fixedPriority
 Whether the listener has been added to dispatcher. More...
 
Node_node
var _node
local _node
bool _paused
var _paused
local _paused
bool _isEnabled
var _isEnabled
local _isEnabled
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Friends

class LuaEventListenerCustom

Additional Inherited Members

- Public Types inherited from EventListener
enum  Type {
  UNKNOWN, TOUCH_ONE_BY_ONE, TOUCH_ALL_AT_ONCE, KEYBOARD,
  MOUSE, ACCELERATION, FOCUS, GAME_CONTROLLER,
  CUSTOM
}
 Type Event type. More...
 
typedef std::string ListenerID
- Protected Member Functions inherited from EventListener
void setPaused (bool paused)
 Sets paused state for the listener The paused state is only used for scene graph priority listeners. More...
 
bool isPaused () const
 Checks whether the listener is paused. More...
 
void setRegistered (bool registered)
 Marks the listener was registered by EventDispatcher. More...
 
var setRegistered ( var registered)
 Marks the listener was registered by EventDispatcher. More...
 
local setRegistered ( local registered)
 Marks the listener was registered by EventDispatcher. More...
 
bool isRegistered () const
 Checks whether the listener was registered by EventDispatcher. More...
 
Type getType () const
 Gets the type of this listener. More...
 
const ListenerIDgetListenerID () const
 Gets the listener ID of this listener When event is being dispatched, listener ID is used as key for searching listeners according to event type. More...
 
local getListenerID ()
 Gets the listener ID of this listener When event is being dispatched, listener ID is used as key for searching listeners according to event type. More...
 
void setFixedPriority (int fixedPriority)
 Sets the fixed priority for this listener. More...
 
int getFixedPriority () const
 Gets the fixed priority of this listener. More...
 
void setAssociatedNode (Node *node)
 Sets the node associated with this listener. More...
 
NodegetAssociatedNode () const
 Gets the node associated with this listener. More...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

Custom event listener.

Usage:
auto dispatcher = Director::getInstance()->getEventDispatcher();
Adds a listener:
auto callback = [](EventCustom* event){ do_some_thing(); };
auto listener = EventListenerCustom::create(callback);
dispatcher->addEventListenerWithSceneGraphPriority(listener, one_node);
Dispatchs a custom event:
EventCustom event("your_event_type");
dispatcher->dispatchEvent(&event);
Removes a listener
dispatcher->removeEventListener(listener);

Member Function Documentation

virtual bool checkAvailable ( )
overridevirtual

Overrides.

Implements EventListener.

Reimplemented in EventListenerPhysicsContact, and EventListenerAssetsManagerEx.

var checkAvailable ( )
overridevirtual

Overrides.

Implements EventListener.

Reimplemented in EventListenerPhysicsContact, and EventListenerAssetsManagerEx.

local checkAvailable ( )
overridevirtual

Overrides.

Implements EventListener.

Reimplemented in EventListenerPhysicsContact, and EventListenerAssetsManagerEx.

virtual EventListenerCustom* clone ( )
overridevirtual
var clone ( )
overridevirtual
local clone ( )
overridevirtual
static EventListenerCustom* create ( const std::string &  eventName,
const std::function< void(EventCustom *)> &  callback 
)
static

Creates an event listener with type and callback.

Parameters
eventTypeThe type of the event.
callbackThe callback function when the specified event was emitted.
Returns
An autoreleased EventListenerCustom object.
var create ( var  eventName,
var  callback 
)
static

Creates an event listener with type and callback.

Parameters
eventTypeThe type of the event.
callbackThe callback function when the specified event was emitted.
Returns
An autoreleased EventListenerCustom object.
local create ( local  eventName,
local  callback 
)
static

Creates an event listener with type and callback.

Parameters
eventTypeThe type of the event.
callbackThe callback function when the specified event was emitted.
Returns
An autoreleased EventListenerCustom object.
bool init ( const ListenerID listenerId,
const std::function< void(EventCustom *)> &  callback 
)

Initializes event with type and callback function.

var init ( var  listenerId,
var  callback 
)

Initializes event with type and callback function.

local init ( local  listenerId,
local  callback 
)

Initializes event with type and callback function.

Friends And Related Function Documentation

friend class LuaEventListenerCustom
friend
var LuaEventListenerCustom
friend
local LuaEventListenerCustom
friend

Member Data Documentation

var __pad0__
local __pad0__
std::function<void(EventCustom*)>
_onCustomEvent
protected
var _onCustomEvent
protected
local _onCustomEvent
protected

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