com.github.shynixn.blockball.api.business.service.GameService.kt Maven / Gradle / Ivy
package com.github.shynixn.blockball.api.business.service
import com.github.shynixn.blockball.api.persistence.entity.Game
import java.util.*
import java.util.concurrent.CompletableFuture
/**
* Created by Shynixn 2018.
*
* Version 1.2
*
* MIT License
*
* Copyright (c) 2018 by Shynixn
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
interface GameService : AutoCloseable {
/**
* Restarts all games on the server.
*/
fun restartGames() : CompletableFuture
/**
* Returns the game if the given [player] is playing a game.
*/
fun getGameFromPlayer(player: P): Optional
/**
* Returns the game if the given [player] is spectating a game.
*/
fun getGameFromSpectatingPlayer(player: P): Optional
/**
* Returns the game at the given location.
*/
fun getGameFromLocation(location: L): Optional
/**
* Returns the game with the given name or displayName.
*/
fun getGameFromName(name: String): Optional
/**
* Returns all currently loaded games on the server.
*/
fun getAllGames(): List
/**
* Closes all games permanently and should be executed on server shutdown.
*/
override fun close()
}