EventListener Class Reference

The base class of event listener. If you need custom listener which with different callback, you need to inherit this class. For instance, you could refer to EventListenerAcceleration, EventListenerKeyboard, EventListenerTouchOneByOne, EventListenerCustom. More...

Inherits Ref.

Inherited by EventListenerAcceleration, EventListenerController, EventListenerCustom, EventListenerFocus, EventListenerKeyboard, EventListenerMouse, EventListenerTouchAllAtOnce, and EventListenerTouchOneByOne.

Public Types
enum	Type
	Type Event type.

Public Member Functions
virtual	~EventListener ()
	Destructor. More...
virtual bool	checkAvailable ()=0
	Checks whether the listener is available. More...
virtual EventListener *	clone ()=0
	Clones the listener, its subclasses have to override this method.
void	setEnabled (bool enabled)
	Enables or disables the listener. More...
bool	isEnabled () const
	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...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...

Protected Member Functions
	EventListener ()
	Constructor @js ctor.
bool	init (Type t, const ListenerID &listenerID, const std::function< void(Event *)> &callback)
	Initializes event with type and callback function @js NA.

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.

Detailed Description

The base class of event listener. If you need custom listener which with different callback, you need to inherit this class. For instance, you could refer to EventListenerAcceleration, EventListenerKeyboard, EventListenerTouchOneByOne, EventListenerCustom.

Constructor & Destructor Documentation

~EventListener()

virtual ~EventListener ( )

virtual

Destructor.

@js NA

Member Function Documentation

checkAvailable()

virtual bool checkAvailable ( )

pure virtual

Checks whether the listener is available.

Returns

True if the listener is available.

Implemented in EventListenerPhysicsContact, EventListenerTouchAllAtOnce, EventListenerTouchOneByOne, EventListenerCustom, EventListenerFocus, EventListenerAcceleration, EventListenerController, EventListenerKeyboard, and EventListenerMouse.

setEnabled()

void setEnabled ( bool  enabled )

inline

Enables or disables the listener.

Note

Only listeners with enabled state will be able to receive events. When an listener was initialized, it's enabled by default. An event listener can receive events when it is enabled and is not paused. paused state is always false when it is a fixed priority listener.

Parameters

enabled

True if enables the listener.

isEnabled()

bool isEnabled ( ) const

inline

Checks whether the listener is enabled.

Returns

True if the listener is enabled.

---

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

• CCEventListener.h