Class PlayerFishEvent

All Implemented Interfaces:
Cancellable

public class PlayerFishEvent extends PlayerEvent implements Cancellable
Thrown when a player is fishing
  • Constructor Details

  • Method Details

    • getCaught

      @Nullable public Entity getCaught()
      Gets the entity caught by the player.

      If player has fished successfully, the result may be cast to Item.

      Returns:
      Entity caught by the player, Entity if fishing, and null if bobber has gotten stuck in the ground or nothing has been caught
    • getHook

      @NotNull public FishHook getHook()
      Gets the fishing hook.
      Returns:
      the entity representing the fishing hook/bobber.
    • 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
    • setCancelled

      public void setCancelled(boolean cancel)
      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
    • getExpToDrop

      public int getExpToDrop()
      Gets the amount of experience received when fishing.

      Note: This value has no default effect unless the event state is PlayerFishEvent.State.CAUGHT_FISH.

      Returns:
      the amount of experience to drop
    • setExpToDrop

      public void setExpToDrop(int amount)
      Sets the amount of experience received when fishing.

      Note: This value has no default effect unless the event state is PlayerFishEvent.State.CAUGHT_FISH.

      Parameters:
      amount - the amount of experience to drop
    • getState

      @NotNull public PlayerFishEvent.State getState()
      Gets the state of the fishing
      Returns:
      A State detailing the state of the fishing
    • getHandlers

      @NotNull public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
    • getHandlerList

      @NotNull public static HandlerList getHandlerList()