Added pre-login event for catching logins right after name verification has completed. This happens in a different thread from the server (and thus can also block).

By: sk89q <the.sk89q@gmail.com>
This commit is contained in:
Bukkit/Spigot
2011-04-16 03:08:05 -07:00
parent 752c217557
commit a53996b243
5 changed files with 155 additions and 6 deletions

View File

@@ -152,6 +152,13 @@ public abstract class Event implements Serializable {
*/
PLAYER_LOGIN (Category.PLAYER),
/**
* Called when a player has just been authenticated
*
* @see org.bukkit.event.player.PlayerPreLoginEvent
*/
PLAYER_PRELOGIN (Category.PLAYER),
/**
* Called when a player respawns
*

View File

@@ -100,6 +100,14 @@ public class PlayerListener implements Listener {
public void onPlayerLogin(PlayerLoginEvent event) {
}
/**
* Called when a player has just been authenticated
*
* @param event Relevant event details
*/
public void onPlayerPreLogin(PlayerPreLoginEvent event) {
}
/**
* Called when a player throws an egg and it might hatch
*

View File

@@ -0,0 +1,126 @@
package org.bukkit.event.player;
import java.net.InetAddress;
import org.bukkit.event.Event;
/**
* Stores details for players attempting to log in
*/
public class PlayerPreLoginEvent extends Event {
private Result result;
private String message;
private String name;
private InetAddress ipAddress;
public PlayerPreLoginEvent(String name, InetAddress ipAddress) {
super(Type.PLAYER_PRELOGIN);
this.result = Result.ALLOWED;
this.message = "";
this.name = name;
this.ipAddress = ipAddress;
}
/**
* Gets the current result of the login, as an enum
*
* @return Current Result of the login
*/
public Result getResult() {
return result;
}
/**
* Sets the new result of the login, as an enum
*
* @param result New result to set
*/
public void setResult(final Result result) {
this.result = result;
}
/**
* Gets the current kick message that will be used if getResult() != Result.ALLOWED
*
* @return Current kick message
*/
public String getKickMessage() {
return message;
}
/**
* Sets the kick message to display if getResult() != Result.ALLOWED
*
* @param message New kick message
*/
public void setKickMessage(final String message) {
this.message = message;
}
/**
* Allows the player to log in
*/
public void allow() {
result = Result.ALLOWED;
message = "";
}
/**
* Disallows the player from logging in, with the given reason
*
* @param result New result for disallowing the player
* @param message Kick message to display to the user
*/
public void disallow(final Result result, final String message) {
this.result = result;
this.message = message;
}
/**
* Gets the player name.
*
* @return
*/
public String getName() {
return name;
}
/**
* Gets the player IP address.
*
* @return
*/
public InetAddress getAddress() {
return ipAddress;
}
/**
* Basic kick reasons for communicating to plugins
*/
public enum Result {
/**
* The player is allowed to log in
*/
ALLOWED,
/**
* The player is not allowed to log in, due to the server being full
*/
KICK_FULL,
/**
* The player is not allowed to log in, due to them being banned
*/
KICK_BANNED,
/**
* The player is not allowed to log in, due to them not being on the white list
*/
KICK_WHITELIST,
/**
* The player is not allowed to log in, for reasons undefined
*/
KICK_OTHER
}
}