Skip to Content
⚠ Under Construction
ReferenceC++ APICancellable

endstone::Cancellable

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

template <typename EventType> Bases: EventType, endstone::ICancellable

Functions:

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

cancel

void cancel()

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

isCancelled

bool isCancelled() override 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.

Returns:

true if this event is cancelled

setCancelled

void setCancelled(bool cancel) override

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

Parameters:

  • cancel true if you wish to cancel this event
Last updated on