EventCustom Class Reference

Custom event. More...

Inherits Event.

Inherited by 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.
Type	getType () const
	Gets the event type. More...
void	stopPropagation ()
	Stops propagation for current event.
var	stopPropagation ()
	Stops propagation for current event.
local	stopPropagation ()
	Stops propagation for current event.
bool	isStopped () const
	Checks whether the event has been stopped. More...
var	isStopped ()
	Checks whether the event has been stopped. More...
local	isStopped ()
	Checks whether the event has been stopped. More...
Node *	getCurrentTarget ()
	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...
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...

Additional Inherited Members
Public Types inherited from Event
enum	Type
	Type Event type. More...
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.
Protected Member Functions inherited from Event
	Event (Type type)
	Constructor.
	Event ( var type)
	Constructor.
	Event ( local type)
	Constructor.

Detailed Description

Custom event.

Constructor & Destructor Documentation

EventCustom

(

const std::string &

eventName

)

Constructor.

Parameters

eventName

A given name of the custom event.

var ctor

(

var

eventName

)

Constructor.

Parameters

eventName

A given name of the custom event.

local EventCustom

(

local

eventName

)

Constructor.

Parameters

eventName

A given name of the custom event.

Member Function Documentation

void setUserData ( void *  data )

inline

Sets user data.

Parameters

data	The user data pointer, it's a void*.

var setUserData ( var  data )

inline

Sets user data.

Parameters

data	The user data pointer, it's a void*.

local setUserData ( local  data )

inline

Sets user data.

Parameters

data	The user data pointer, it's a void*.

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*.

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.

---

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

• CCEventCustom.h