Axmol 3.0.0-89d6d9a
Loading...
Searching...
No Matches
Event Class Reference

Base class of all kinds of events. More...

#include <Event.h>

Inherits Object.

Inherited by AccelerationEvent, CustomEvent, FocusEvent, KeyboardEvent, PointerEvent, and XRInputEvent.

Public Types

enum class  Type
 Type Event type.

Public Member Functions

 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.
Node * getCurrentTarget ()
 Gets current target of the event.
Public Member Functions inherited from Object
void retain ()
 Retains the ownership.
void release ()
 Releases the ownership immediately.
Object * autorelease ()
 Releases the ownership sometime soon automatically.
unsigned int getReferenceCount () const
 Returns the Object's current reference count.
uint64_t getObjectID () const noexcept
 Returns the process-local diagnostic identifier assigned at construction.
virtual ~Object ()
 Destructor.

Detailed Description

Base class of all kinds of events.

Member Function Documentation

◆ getType()

Type getType ( ) const
inline

Gets the event type.

Returns
The event type.

◆ isStopped()

bool isStopped ( ) const
inline

Checks whether the event has been stopped.

Returns
True if the event has been stopped.

◆ getCurrentTarget()

Node * getCurrentTarget ( )
inline

Gets current target of the event.

Returns
The target with which the event associates.
Note
It's only available when the event listener is associated with node. It returns 0 when the listener is associated with fixed priority.

The documentation for this class was generated from the following file:
  • Event.h