Class endstone::ICancellable

ClassList > endstone > ICancellable

Interface for events that may be cancelled by a plugin or the server.

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

Inherited by the following classes: endstone::Cancellable, endstone::Cancellable, endstone::Cancellable, endstone::Cancellable, endstone::Cancellable, endstone::Cancellable, endstone::Cancellable

Public Functions

Type	Name
virtual void	cancel () = 0 Cancels this event.
virtual bool	isCancelled () const = 0 Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) = 0 Sets the cancellation state of this event.
virtual	~ICancellable () = default

Public Functions Documentation

function cancel

Cancels this event.

virtual void endstone::ICancellable::cancel () = 0

---

function isCancelled

Gets the cancellation state of this event.

virtual bool endstone::ICancellable::isCancelled () const = 0

Returns:

true if this event is cancelled

---

function setCancelled

Sets the cancellation state of this event.

virtual void endstone::ICancellable::setCancelled (
    bool cancel
) = 0

Parameters:

• cancel true if you wish to cancel this event

---

function ~ICancellable

virtual endstone::ICancellable::~ICancellable () = default

---

---

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