com.github.shynixn.blockball.api.business.entity.Game.kt Maven / Gradle / Ivy
package com.github.shynixn.blockball.api.business.entity
import com.github.shynixn.blockball.api.business.enumeration.GameStatus
import com.github.shynixn.blockball.api.business.enumeration.Team
import com.github.shynixn.blockball.api.persistence.entity.Arena
/**
* 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 Game : java.lang.AutoCloseable where ArenaEntity : Arena {
/** Arena of the game. */
val arena: ArenaEntity
/** Ball of the game. */
val ball: BallEntity?
/** Status of the game. */
val status: GameStatus
/** List of players in the redTeam. */
val redTeam: List
/** List of players in the blueTeam. */
val blueTeam: List
/** Ingame stats of the players. */
val ingameStats : Map
/** Amount of points the blue team has scored. */
val bluePoints : Int
/** Amount of points the red team has scored. */
val redPoints : Int
/** Join the game. */
fun join(player: Player, team: Team? = null): Boolean
/** Leave the game. */
fun leave(player: Player)
/** Checks if the player has joined the game. */
fun hasJoined(player: Player): Boolean
/** Returns all players inside of the game. */
fun getPlayers(): List
}