Class EntityToggleSwimEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityToggleSwimEvent
All Implemented Interfaces:
Cancellable
public class EntityToggleSwimEvent extends EntityEvent implements Cancellable
Sent when an entity's swimming status is toggled.
Since:
1.13

  • Constructor Details

  • Method Details

    • isSwimming

      public boolean isSwimming()
      Returns true if the entity is now swims or false if the entity stops swimming.
      Returns:
      new swimming state
      Since:
      1.13

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: Cancellable
      Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins
      Specified by:
      isCancelled in interface Cancellable
      Returns:
      true if this event is cancelled
      Since:
      1.13

    • setCancelled

      @Deprecated public void setCancelled(boolean cancel)
      Deprecated.
      This does nothing, the server and the client doesn't work correctly when the server try to bypass this. A current workaround exists. If you want to cancel the switch from the ground state to the swimming state you need to disable the sprinting flag for the player after the cancel action.
      Description copied from interface: Cancellable
      Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - true if you wish to cancel this event
      Since:
      1.13

    • getHandlers

      @NotNull public @NotNull HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
      Since:
      1.13

    • getHandlerList

      @NotNull public static @NotNull HandlerList getHandlerList()
      Since:
      1.13