package org.bukkit.event.player;

import org.bukkit.Player;

/**
 * Stores details for players attempting to log in
 */
public class PlayerLoginEvent extends PlayerEvent {
    private Result result;
    private String message;

    public PlayerLoginEvent(final Type type, final Player player) {
        super(type, player);
        this.result = Result.ALLOWED;
        this.message = "";
    }

    public PlayerLoginEvent(final Type type, final Player player, final Result result, final String message) {
        super(type, player);
        this.result = result;
        this.message = message;
    }

    /**
     * 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;
    }

    /**
     * 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, for reasons undefined
         */
        KICK_OTHER
    }
}