Fork of Poseidon providing Bukkit #1060 to older Beta versions (b1.0-b1.7.3)
1package org.bukkit.event.player;
2
3import org.bukkit.entity.Player;
4import org.bukkit.event.Cancellable;
5
6/**
7 * Called when a player gets kicked from the server
8 */
9public class PlayerKickEvent extends PlayerEvent implements Cancellable {
10 private String leaveMessage;
11 private String kickReason;
12 private Boolean cancel;
13
14 public PlayerKickEvent(Player playerKicked, String kickReason, String leaveMessage) {
15 super(Type.PLAYER_KICK, playerKicked);
16 this.kickReason = kickReason;
17 this.leaveMessage = leaveMessage;
18 this.cancel = false;
19 }
20
21 /**
22 * Gets the reason why the player is getting kicked
23 *
24 * @return string kick reason
25 */
26 public String getReason() {
27 return kickReason;
28 }
29
30 /**
31 * Gets the leave message send to all online players
32 *
33 * @return string kick reason
34 */
35 public String getLeaveMessage() {
36 return leaveMessage;
37 }
38
39 public boolean isCancelled() {
40 return cancel;
41 }
42
43 public void setCancelled(boolean cancel) {
44 this.cancel = cancel;
45 }
46
47 /**
48 * Sets the reason why the player is getting kicked
49 *
50 * @param kickReason kick reason
51 */
52 public void setReason(String kickReason) {
53 this.kickReason = kickReason;
54 }
55
56 /**
57 * Sets the leave message send to all online players
58 *
59 * @param leaveMessage leave message
60 */
61 public void setLeaveMessage(String leaveMessage) {
62 this.leaveMessage = leaveMessage;
63 }
64}