Axmol Engine 2.4.0-258ceca
Loading...
Searching...
No Matches
EventCustom Class Reference

Custom event. More...

#include <EventCustom.h>

Inherits Event.

Public Member Functions

 EventCustom (std::string_view eventName)
 Constructor.
 
void setUserData (void *data)
 Sets user data.
 
void * getUserData () const
 Gets user data.
 
std::string_view getEventName () const
 Gets event name.
 
- Public Member Functions inherited from Event
 Event (Type type)
 Constructor.
 
virtual ~Event ()
 Destructor.
 
Type getType () const
 Gets the event type.
 
void stopPropagation ()
 Stops propagation for current event.
 
bool isStopped () const
 Checks whether the event has been stopped.
 
NodegetCurrentTarget ()
 Gets current target of the event.
 
- Public Member Functions inherited from Object
void retain ()
 Retains the ownership.
 
void release ()
 Releases the ownership immediately.
 
Objectautorelease ()
 Releases the ownership sometime soon automatically.
 
unsigned int getReferenceCount () const
 Returns the Object's current reference count.
 
virtual ~Object ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from Event
enum class  Type
 Type Event type.
 
- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 

Detailed Description

Custom event.

Constructor & Destructor Documentation

◆ EventCustom()

EventCustom ( std::string_view eventName)

Constructor.

Parameters
eventNameA given name of the custom event. @js ctor

Member Function Documentation

◆ setUserData()

void setUserData ( void * data)
inline

Sets user data.

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

◆ getUserData()

void * getUserData ( ) const
inline

Gets user data.

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

◆ getEventName()

std::string_view getEventName ( ) const
inline

Gets event name.

Returns
The name of the event.

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