Package org.bukkit.event.player
Enum Class PlayerFishEvent.State
- All Implemented Interfaces:
Serializable
,Comparable<PlayerFishEvent.State>
,Constable
- Enclosing class:
PlayerFishEvent
An enum to specify the state of the fishing
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionCalled when there is a bite on the hook and it is ready to be reeled in.When a player has successfully caught an entity.When a player has successfully caught a fish and is reeling it in.When a player fails to catch a bite while fishing usually due to poor timing.When a player is fishing, ie casting the line out.When a bobber is stuck in the ground.Called when a bobber was lured, and is now waiting to be hooked (when a "fish" starts to swim toward the bobber to bite it).When a player reels in their hook without receiving any bites. -
Method Summary
Modifier and TypeMethodDescriptionstatic PlayerFishEvent.State
Returns the enum constant of this class with the specified name.static PlayerFishEvent.State[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FISHING
When a player is fishing, ie casting the line out. -
CAUGHT_FISH
When a player has successfully caught a fish and is reeling it in. In this instance, a "fish" is any item retrieved from water as a result of fishing, ie an item, but not necessarily a fish. -
CAUGHT_ENTITY
When a player has successfully caught an entity. This refers to any already spawned entity in the world that has been hooked directly by the rod. -
IN_GROUND
When a bobber is stuck in the ground. -
FAILED_ATTEMPT
When a player fails to catch a bite while fishing usually due to poor timing. -
REEL_IN
When a player reels in their hook without receiving any bites. -
BITE
Called when there is a bite on the hook and it is ready to be reeled in. -
LURED
Called when a bobber was lured, and is now waiting to be hooked (when a "fish" starts to swim toward the bobber to bite it).
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-