SubServers-2/SubServers.Bungee/common/src/net/ME1312/SubServers/Bungee/BungeeAPI.java

package net.ME1312.SubServers.Bungee;

import net.ME1312.Galaxi.Library.Util;
import net.ME1312.Galaxi.Library.Version.Version;
import net.ME1312.SubServers.Bungee.Library.Compatibility.RemotePlayer;

import net.md_5.bungee.api.ProxyServer;
import net.md_5.bungee.api.config.ServerInfo;

import java.io.File;
import java.util.Collection;
import java.util.Map;
import java.util.UUID;

/**
 * SubAPI BungeeCord Common Class
 */
public interface BungeeAPI {

    /**
     * Gets the SubAPI BungeeCord Common Methods
     *
     * @return SubAPI BungeeCord Common
     */
    static BungeeAPI getInstance() {
        return ((BungeeCommon) ProxyServer.getInstance()).api.get();
    }

    /**
     * Gets the BungeeCommon Internals
     *
     * @deprecated Use BungeeAPI Methods when available
     * @return BungeeCommon Internals
     */
    @Deprecated
    BungeeCommon getInternals();

    /**
     * Get the number of players on this network across all known proxies
     *
     * @return Remote Player Collection
     */
    int getRemotePlayerCount();

    /**
     * Get players on this server across all known proxies
     *
     * @param server Server to search
     * @return Remote Player Map
     */
    Map<UUID, ? extends RemotePlayer> getRemotePlayers(ServerInfo server);

    /**
     * Get players on this network across all known proxies
     *
     * @return Remote Player Map
     */
    Map<UUID, ? extends RemotePlayer> getRemotePlayers();

    /**
     * Get a player on this network by searching across all known proxies
     *
     * @param name Player name
     * @return Remote Player
     */
    RemotePlayer getRemotePlayer(String name);

    /**
     * Get a player on this network by searching across all known proxies
     *
     * @param id Player UUID
     * @return Remote Player
     */
    RemotePlayer getRemotePlayer(UUID id);

    /**
     * Gets the current SubServers Lang Channels
     *
     * @return SubServers Lang Channel list
     */
    Collection<String> getLangChannels();

    /**
     * Gets values from the SubServers Lang
     *
     * @param channel Lang Channel
     * @return Lang Value
     */
    Map<String, String> getLang(String channel);

    /**
     * Gets a value from the SubServers Lang
     *
     * @param channel Lang Channel
     * @param key Key
     * @return Lang Values
     */
    default String getLang(String channel, String key) {
        Util.nullpo(channel, key);
        return getLang(channel).get(key);
    }

    /**
     * Gets the Runtime Directory
     *
     * @return Directory
     */
    File getRuntimeDirectory();

    /**
     * Gets the SubServers Version
     *
     * @return SubServers Version
     */
    Version getWrapperVersion();

    /**
     * Gets the SubServers Build Version
     *
     * @return SubServers Build Version (or null if unsigned)
     */
    Version getWrapperBuild();

    /**
     * Gets the BungeeCord Version
     *
     * @return BungeeCord Version
     */
    Version getProxyVersion();

    /**
     * Get an array of compatible Minecraft Versions
     *
     * @return Minecraft Versions
     */
    Version[] getGameVersion();
}