Package org.bukkit.event.player
Class PlayerFishEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerFishEvent
- All Implemented Interfaces:
Cancellable
Thrown when a player is fishing
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
An enum to specify the state of the fishingNested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
ConstructorDescriptionPlayerFishEvent
(@NotNull Player player, @Nullable Entity entity, @NotNull FishHook hookEntity, @NotNull PlayerFishEvent.State state) PlayerFishEvent
(@NotNull Player player, @Nullable Entity entity, @NotNull FishHook hookEntity, @Nullable EquipmentSlot hand, @NotNull PlayerFishEvent.State state) -
Method Summary
Modifier and TypeMethodDescriptionGets the entity caught by the player.int
Gets the amount of experience received when fishing.getHand()
Get the hand that was used in this event.static @NotNull HandlerList
getHook()
Gets the fishing hook.getState()
Gets the state of the fishingboolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setExpToDrop
(int amount) Sets the amount of experience received when fishing.Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerFishEvent
-
PlayerFishEvent
-
-
Method Details
-
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
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 interfaceCancellable
- 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 interfaceCancellable
- 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
-
getHand
Get the hand that was used in this event.The hand used is only present for player interactions. This means it will be null if state is set to
PlayerFishEvent.State.BITE
orPlayerFishEvent.State.FAILED_ATTEMPT
.- Returns:
- the hand
-
getState
Gets the state of the fishing- Returns:
- A State detailing the state of the fishing
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-