Package civitas.celestis.event

Interface Cancellable

All Superinterfaces:
Handleable, Unique<UUID>
All Known Implementing Classes:
CancellableEvent
public interface Cancellable extends Handleable
An event which can be cancelled by a lower priority listener, which flags the event as cancelled, notifying higher priority listeners that this event should be ignored as if it had not happened in the first place.

A default implementation is provided for easier usage.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isCancelled()
    Returns whether this event has been flagged as cancelled.
    void
    setCancelled(boolean cancelled)
    Sets whether this event has been flagged as cancelled.

    Methods inherited from interface civitas.celestis.event.Handleable

    getCause, getUniqueId

  • Method Details

    • isCancelled

      boolean isCancelled()
      Returns whether this event has been flagged as cancelled.
      Returns:
      true if this event has been flagged as cancelled

    • setCancelled

      void setCancelled(boolean cancelled)
      Sets whether this event has been flagged as cancelled.
      Parameters:
      cancelled - Whether this event has been cancelled