Package me.remigio07.chatplugin.api.common.event

Interface CancellableEvent

All Superinterfaces:
ChatPluginEvent
All Known Implementing Classes:
ActionbarSendEvent, AdSendEvent, AllowChatEvent, AllowPrivateMessageEvent, BossbarSendEvent, ChatChannelEvent, ChatChannelJoinEvent, ChatChannelLeaveEvent, ChatChannelSwitchEvent, ChatPluginCrashEvent, EmbedMessageSendEvent, EmptySlotClickEvent, F3ServerNameSendEvent, FakeKickEvent, GUIDragEvent, GUIInteractEvent, GUIOpenEvent, GUIRefreshStartEvent, IconClickEvent, IgnoreEvent, IPLookupCleanCacheEvent, MessageSendEvent, PlainMessageSendEvent, PlayerPingEvent, PreChatEvent, PrePrivateMessageEvent, ScoreboardAddPlayerEvent, StaffChatEvent, StatusUpdateEvent, StatusUpdateEvent, TablistSendEvent, ToggleChatMuteEvent, UnignoreEvent, VanishDisableEvent, VanishEnableEvent
public interface CancellableEvent extends ChatPluginEvent
Represents a cancellable event.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isCancelled()
    Checks if this event has been cancelled and will not be executed.
    void
    setCancelled(boolean cancelled)
    Sets the cancellation state of this event.

    Methods inherited from interface me.remigio07.chatplugin.api.common.event.ChatPluginEvent

    call

  • Method Details

    • isCancelled

      boolean isCancelled()
      Checks if this event has been cancelled and will not be executed.
      Returns:
      Whether this event is cancelled

    • setCancelled

      void setCancelled(boolean cancelled)
      Sets the cancellation state of this event.

      It will be passed through other registered listeners even if it is cancelled, but it will not be executed.

      Parameters:
      cancelled - Whether this event should be cancelled