Class endstone::Cancellable

template <typename EventType>

ClassList > endstone > Cancellable

A type characterizing events that may be cancelled by a plugin or the server.

• #include <endstone/event/cancellable.h>

Inherits the following classes: EventType, endstone::ICancellable

Public Functions

Type	Name
virtual void	cancel () Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual bool	isCancelled () const Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual void	setCancelled (bool cancel) Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Public Functions inherited from endstone::ICancellable

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0
virtual bool	isCancelled () const = 0
virtual void	setCancelled (bool cancel) = 0
virtual	~ICancellable () = default

Public Functions Documentation

function cancel

Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

inline virtual void endstone::Cancellable::cancel () 

Implements endstone::ICancellable::cancel

---

function isCancelled

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

inline virtual bool endstone::Cancellable::isCancelled () const

Returns:

true if this event is cancelled

Implements endstone::ICancellable::isCancelled

---

function setCancelled

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

inline virtual void endstone::Cancellable::setCancelled (
    bool cancel
) 

Parameters:

• cancel true if you wish to cancel this event

Implements endstone::ICancellable::setCancelled

---

---

The documentation for this class was generated from the following file include/endstone/event/cancellable.h