[MysticCraft] MysticApocalipse API.

package com.outlook.devleeo.mysticapocalipse.api;

import java.util.ArrayList;
import java.util.concurrent.ConcurrentHashMap;

import org.bukkit.entity.Player;

import com.outlook.devleeo.mysticapocalipse.common.util.concurrent.WrappedConcurrentHashMap;
import com.outlook.devleeo.mysticapocalipse.event.EventStage;
import com.outlook.devleeo.mysticapocalipse.event.MysticZombie;

/**
 * @author Leonardo O. S. (DevLeeo)
 *
 * MysticApocalipse API.
 */
public interface MysticApi
{

    /**
     * Use para pegar a lista de jogadores no evento.
     *
     * @return lista de jogadores no evento.
     */
    public ArrayList<String> getPlayersInEvent();

    /**
     * Use para pegar a lista de zombies no evento.
     *
     * @return lista de zombies no evento
     */
    public WrappedConcurrentHashMap<Integer, MysticZombie> getZombiesInEvent();

    /**
     * Use para pegar a etapa do evento.
     *
     * @return etapa do evento
     */
    public EventStage getEventStage();

    /**
     * Use para preparar o evento.
     */
    public void prepareEvent();

    /**
     * Use para cancelar o evento.
     */
    public void cancelEvent();

    /**
     * Use para remover um jogador do evento.
     *
     * @param player Jogador desejado.
     */
    public void removePlayerFromEvent(Player player);

    /**
     * Use para remover um jogador do evento.
     *
     * @param player Nome do jogador desejado.
     */
    public void removePlayerFromEvent(String player);

    /**
     * Use para verificar se um certo jogador esta participado do evento.
     *
     * @param player Jogador desejado
     * @return true caso ele esteja, e false caso contrario.
     */
    public boolean isInEvent(Player player);

    /**
     * Use para verificar se um certo jogador esta participado do evento.
     *
     * @param player Nome do jogador desejado
     * @return true caso ele esteja, e false caso contrario.
     */
    public boolean isInEvent(String player);
}