Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
EventListener Class Referenceabstract

The base class of event listener. 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.
 
local ~EventListener ()
 Destructor.
 
virtual bool checkAvailable ()=0
 Checks whether the listener is available. More...
 
virtual EventListenerclone ()=0
 Clones the listener, its subclasses have to override this method.
 
var clone ()
 Clones the listener, its subclasses have to override this method.
 
local clone ()
 Clones the listener, its subclasses have to override this method.
 
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...
 
local 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...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 

Protected Member Functions

 EventListener ()
 Constructor.
 
 EventListener ()
 Constructor.
 
bool init (Type t, const ListenerID &listenerID, const std::function< void(Event *)> &callback)
 Initializes event with type and callback function.
 
local init ( local t, local listenerID, local callback)
 Initializes event with type and callback function.
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 

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.

Member Function Documentation

virtual bool checkAvailable ( )
pure virtual
local checkAvailable ( )
pure virtual
void setEnabled ( bool  enabled)
inline

Enables or disables the listener.

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 if it is a fixed priority listener.

True if enables the listener.

var setEnabled ( var  enabled)
inline

Enables or disables the listener.

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 if it is a fixed priority listener.

True if enables the listener.

local setEnabled ( local  enabled)
inline

Enables or disables the listener.

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 if it is a fixed priority listener.

True if enables the listener.

bool isEnabled ( ) const
inline

Checks whether the listener is enabled.

True if the listenrt is enabled.

var isEnabled ( )
inline

Checks whether the listener is enabled.

True if the listenrt is enabled.

local isEnabled ( )
inline

Checks whether the listener is enabled.

True if the listenrt is enabled.


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