DRSchlaubi/regnum

/*
 * Regnum - A Discord bot clustering system made for Hawk
 *
 * Copyright (C) 2019  Michael Rittmeister
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see https://www.gnu.org/licenses/.
 */

package cc.hawkbot.regnum.client.core.discord

/**
 * Class that represents the connection to the Discord API.
 */
@Suppress("unused")
interface Discord {

    /**
     * The [ShardManager].
     */
    val shardManager: ShardManager

    /**
     * The [GameAnimator]
     */
    val gameAnimator: GameAnimator

    /**
     * Forces all shards to shutdown
     */
    fun shutdown() = shardManager.shutdown()

    /**
     * Starts all new shards in the array
     * @param shards the id of shards
     */
    fun addShards(shards: Array<out Int>)
}