mirror of
https://github.com/PaperMC/Paper.git
synced 2025-01-09 11:44:19 +01:00
SPIGOT-3059: Update PlayerFishEvent documentation
By: md_5 <git@md-5.net>
This commit is contained in:
parent
8abb2aa9e9
commit
6852148a0a
1 changed files with 10 additions and 5 deletions
|
@ -106,24 +106,29 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
|
||||||
*/
|
*/
|
||||||
FISHING,
|
FISHING,
|
||||||
/**
|
/**
|
||||||
* When a player has successfully caught a fish and is reeling it in.
|
* 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_FISH,
|
CAUGHT_FISH,
|
||||||
/**
|
/**
|
||||||
* When a player has successfully caught an 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.
|
||||||
*/
|
*/
|
||||||
CAUGHT_ENTITY,
|
CAUGHT_ENTITY,
|
||||||
/**
|
/**
|
||||||
* When a bobber is stuck in the ground
|
* When a bobber is stuck in the ground.
|
||||||
*/
|
*/
|
||||||
IN_GROUND,
|
IN_GROUND,
|
||||||
/**
|
/**
|
||||||
* When a player fails to catch anything while fishing usually due to
|
* When a player fails to catch anything while fishing usually due to
|
||||||
* poor aiming or timing
|
* poor aiming or timing.
|
||||||
*/
|
*/
|
||||||
FAILED_ATTEMPT,
|
FAILED_ATTEMPT,
|
||||||
/**
|
/**
|
||||||
* Called when there is a bite on the hook and it is ready to be reeled in.
|
* Called when there is a bite on the hook and it is ready to be reeled
|
||||||
|
* in.
|
||||||
*/
|
*/
|
||||||
BITE
|
BITE
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue