package net.knarcraft.minigames.arena;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Set;
import java.util.UUID;

/**
 * A registry keeping track of all player sessions for some arenas
 *
 * @param <K> <p>The type of arena this registry stores</p>
 */
public interface ArenaPlayerRegistry<K extends Arena> {

    /**
     * Gets the ids of the players currently playing
     *
     * @return <p>The ids of the playing players</p>
     */
    @NotNull Set<UUID> getPlayingPlayers();

    /**
     * Gets the current entry state for the given player
     *
     * @param playerId <p>The id of the player to get an entry state for</p>
     * @return <p>The entry state of the player, or null if not found</p>
     */
    @Nullable PlayerEntryState getEntryState(@NotNull UUID playerId);

    /**
     * Registers that the given player has started playing the given dropper arena session
     *
     * @param playerId     <p>The id of the player that started playing</p>
     * @param arenaSession <p>The arena session to register</p>
     */
    void registerPlayer(@NotNull UUID playerId, @NotNull ArenaSession arenaSession);

    /**
     * Removes this player from players currently playing
     *
     * @param playerId     <p>The id of the player to remove</p>
     * @param restoreState <p>Whether to restore the state of the player as part of the removal</p>
     */
    boolean removePlayer(@NotNull UUID playerId, boolean restoreState);

    /**
     * Gets the player's active dropper arena session
     *
     * @param playerId <p>The id of the player to get arena for</p>
     * @return <p>The player's active arena session, or null if not currently playing</p>
     */
    @Nullable ArenaSession getArenaSession(@NotNull UUID playerId);

    /**
     * Removes all active sessions for the given arena
     *
     * @param arena       <p>The arena to remove sessions for</p>
     * @param immediately <p>Whether to immediately teleport the player</p>
     */
    void removeForArena(K arena, boolean immediately);

}