DungeonsXL/api/src/main/java/de/erethon/dungeonsxl/api/player/GlobalPlayer.java

/*
 * Copyright (C) 2014-2020 Daniel Saukel
 *
 * This library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNULesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package de.erethon.dungeonsxl.api.player;

import de.erethon.commons.chat.MessageUtil;
import de.erethon.commons.player.PlayerWrapper;
import java.util.List;
import org.bukkit.Location;
import org.bukkit.inventory.ItemStack;

/**
 * Represents a player anywhere on the server.
 * <p>
 * All players on the server, including the ones in dungeons, have one wrapper object that is an instance of GlobalPlayer.
 *
 * @author Daniel Saukel
 */
public interface GlobalPlayer extends PlayerWrapper {

    /**
     * Returns the player's group.
     *
     * @return the player's group.
     */
    PlayerGroup getGroup();

    /**
     * Returns if the player uses the built-in group chat.
     *
     * @return if the player uses the built-in group chat
     */
    boolean isInGroupChat();

    /**
     * Sets if the player uses the built-in group chat.
     *
     * @param groupChat if the player shall use the built-in group chat
     */
    void setInGroupChat(boolean groupChat);

    /**
     * Returns if the player may read messages from the built-in group chat.
     *
     * @return if the player may read messages from the built-in group chat
     */
    boolean isInChatSpyMode();

    /**
     * Sets if the player may read messages from the built-in group chat.
     *
     * @param chatSpyMode if the player may read messages from the built-in group chat
     */
    void setInChatSpyMode(boolean chatSpyMode);

    /**
     * Checks if the player has the given permission.
     *
     * @param permission the permission
     * @return if the player has the given permission
     */
    default boolean hasPermission(String permission) {
        return getPlayer().hasPermission(permission);
    }

    /**
     * Returns the reward items a player collected in a dungeon game.
     *
     * @return the reward items a player collected in a dungeon game
     */
    public List<ItemStack> getRewardItems();

    /**
     * Returns if the player has any reward items left.
     *
     * @return if the player has any reward items left
     */
    public boolean hasRewardItemsLeft();

    /**
     * Returns if the player is currently breaking a global protection (=using /dxl break).
     *
     * @return if the player is currently breaking a global protection (=using /dxl break)
     */
    boolean isInBreakMode();

    /**
     * Sets the player into or out of break mode; see {@link #isInBreakMode()}.
     *
     * @param breakMode if the player may break global protections
     */
    void setInBreakMode(boolean breakMode);

    /**
     * Sends a message to the player.
     *
     * @param message the message to send
     */
    default void sendMessage(String message) {
        MessageUtil.sendMessage(getPlayer(), message);
    }

    /**
     * Respawns the player at his old position before he was in a dungeon.
     *
     * @param keepInventory if the saved status shall be reset
     */
    void reset(boolean keepInventory);

    /**
     * Respawns the player at his old position before he was in a dungeon.
     *
     * @param tpLoc         the location where the player shall respawn
     * @param keepInventory if the saved status shall be reset
     */
    void reset(Location tpLoc, boolean keepInventory);

}