The base class of event listener.
More...
Inherits Ref.
Inherited by EventListenerAcceleration, EventListenerController, EventListenerCustom, EventListenerFocus, EventListenerKeyboard, EventListenerMouse, EventListenerTouchAllAtOnce, and EventListenerTouchOneByOne.
|
| EventListener () |
| Constructor. More...
|
|
bool | init (Type t, const ListenerID &listenerID, const std::function< void(Event *)> &callback) |
| Initializes event with type and callback function. More...
|
|
local | init ( local t, local listenerID, local callback) |
| Initializes event with type and callback function. More...
|
|
|
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.
|
|
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.
bool init |
( |
Type |
t, |
|
|
const ListenerID & |
listenerID, |
|
|
const std::function< void(Event *)> & |
callback |
|
) |
| |
|
protected |
Initializes event with type and callback function.
local init |
( |
local |
t, |
|
|
local |
listenerID, |
|
|
local |
callback |
|
) |
| |
|
protected |
Initializes event with type and callback function.
virtual bool checkAvailable |
( |
| ) |
|
|
pure virtual |
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. |
var setEnabled |
( |
var |
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. |
local setEnabled |
( |
local |
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. |
Checks whether the listener is enabled.
- Returns
- True if the listener is enabled.
Checks whether the listener is enabled.
- Returns
- True if the listener is enabled.
Checks whether the listener is enabled.
- Returns
- True if the listener is enabled.
The documentation for this class was generated from the following file: