1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
package org.bukkit.event.player;
import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.bukkit.entity.Entity;
import org.bukkit.entity.FishHook;
import org.bukkit.event.HandlerList;
/**
* Thrown when a player is fishing
*/
public class PlayerFishEvent extends PlayerEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();
private final Entity entity;
private boolean cancel = false;
private int exp;
private final State state;
private final FishHook hookEntity;
public PlayerFishEvent(final Player player, final Entity entity, final FishHook hookEntity, final State state) {
super(player);
this.entity = entity;
this.hookEntity = hookEntity;
this.state = state;
}
/**
* Gets the entity caught by the player.
* <p>
* If player has fished successfully, the result may be cast to {@link
* org.bukkit.entity.Item}.
*
* @return Entity caught by the player, Entity if fishing, and null if
* bobber has gotten stuck in the ground or nothing has been caught
*/
public Entity getCaught() {
return entity;
}
/**
* Gets the fishing hook.
*
* @return the entity representing the fishing hook/bobber.
*/
public FishHook getHook() {
return hookEntity;
}
public boolean isCancelled() {
return cancel;
}
public void setCancelled(boolean cancel) {
this.cancel = cancel;
}
/**
* Gets the amount of experience received when fishing.
* <p>
* Note: This value has no default effect unless the event state is {@link
* State#CAUGHT_FISH}.
*
* @return the amount of experience to drop
*/
public int getExpToDrop() {
return exp;
}
/**
* Sets the amount of experience received when fishing.
* <p>
* Note: This value has no default effect unless the event state is {@link
* State#CAUGHT_FISH}.
*
* @param amount the amount of experience to drop
*/
public void setExpToDrop(int amount) {
exp = amount;
}
/**
* Gets the state of the fishing
*
* @return A State detailing the state of the fishing
*/
public State getState() {
return state;
}
@Override
public HandlerList getHandlers() {
return handlers;
}
public static HandlerList getHandlerList() {
return handlers;
}
/**
* An enum to specify the state of the fishing
*/
public enum State {
/**
* When a player is fishing, ie casting the line out.
*/
FISHING,
/**
* 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,
/**
* 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,
/**
* When a bobber is stuck in the ground.
*/
IN_GROUND,
/**
* When a player fails to catch anything while fishing usually due to
* poor aiming or timing.
*/
FAILED_ATTEMPT,
/**
* Called when there is a bite on the hook and it is ready to be reeled
* in.
*/
BITE
}
}
|
