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

Custom event. More...

#include <CCEventCustom.h>

Inheritance diagram for EventCustom:
Event Ref EventAssetsManagerEx PhysicsContact

Public Member Functions

 EventCustom (const std::string &eventName)
 Constructor. More...
 
void setUserData (void *data)
 Sets user data. More...
 
var setUserData ( var data)
 Sets user data. More...
 
local setUserData ( local data)
 Sets user data. More...
 
void * getUserData () const
 Gets user data. More...
 
const std::string & getEventName () const
 Gets event name. More...
 
- Public Member Functions inherited from Event
virtual ~Event ()
 Destructor. More...
 
var ~Event ()
 Destructor. More...
 
local ~Event ()
 Destructor. More...
 
Type getType () const
 Gets the event type. More...
 
var getType ()
 Gets the event type. More...
 
local getType ()
 Gets the event type. More...
 
void stopPropagation ()
 Stops propagation for current event. More...
 
var stopPropagation ()
 Stops propagation for current event. More...
 
local stopPropagation ()
 Stops propagation for current event. More...
 
bool isStopped () const
 Checks whether the event has been stopped. More...
 
NodegetCurrentTarget ()
 Gets current target of the event. More...
 
var getCurrentTarget ()
 Gets current target of the event. More...
 
local getCurrentTarget ()
 Gets current target of the event. 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...
 

Protected Attributes

void * _userData
 User data. More...
 
std::string _eventName
var _eventName
local _eventName
- Protected Attributes inherited from Event
Type _type
 Event type. More...
 
bool _isStopped
 whether the event has been stopped. More...
 
var _isStopped
 whether the event has been stopped. More...
 
local _isStopped
 whether the event has been stopped. More...
 
Node_currentTarget
 Current target. More...
 
var _currentTarget
 Current target. More...
 
local _currentTarget
 Current target. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Additional Inherited Members

- Public Types inherited from Event
enum  Type {
  TOUCH, KEYBOARD, ACCELERATION, MOUSE,
  FOCUS, GAME_CONTROLLER, CUSTOM
}
 Type Event type. More...
 
- Public Attributes inherited from Event
CC_CONSTRUCTOR_ACCESS __pad0__: Event(Type type)
var __pad0__: Event(Type type)
local __pad0__: Event(Type type)
- Protected Member Functions inherited from Event
void setCurrentTarget (Node *target)
 Sets current target. More...
 
var setCurrentTarget ( var target)
 Sets current target. More...
 
local setCurrentTarget ( local target)
 Sets current target. More...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

Custom event.

Constructor & Destructor Documentation

EventCustom ( const std::string &  eventName)

Constructor.

Parameters
eventNameA given name of the custom event.
var ctor ( var  eventName)

Constructor.

Parameters
eventNameA given name of the custom event.
local EventCustom ( local  eventName)

Constructor.

Parameters
eventNameA given name of the custom event.

Member Function Documentation

const std::string& getEventName ( ) const
inline

Gets event name.

Returns
The name of the event.
var getEventName ( )
inline

Gets event name.

Returns
The name of the event.
local getEventName ( )
inline

Gets event name.

Returns
The name of the event.
void* getUserData ( ) const
inline

Gets user data.

Returns
The user data pointer, it's a void*.
var getUserData ( )
inline

Gets user data.

Returns
The user data pointer, it's a void*.
local getUserData ( )
inline

Gets user data.

Returns
The user data pointer, it's a void*.
void setUserData ( void *  data)
inline

Sets user data.

Parameters
dataThe user data pointer, it's a void*.
var setUserData ( var  data)
inline

Sets user data.

Parameters
dataThe user data pointer, it's a void*.
local setUserData ( local  data)
inline

Sets user data.

Parameters
dataThe user data pointer, it's a void*.

Member Data Documentation

std::string _eventName
protected
var _eventName
protected
local _eventName
protected
void* _userData
protected

User data.

var _userData
protected

User data.

local _userData
protected

User data.


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