GameType

interface GameType<B : Board<B, MG, P, C>, MG : MoveGenerator<B, MG, P, C>, P : Piece<B, MG, P, C>, C : Coordinate>

Represents a game variant.

Controls the flow of a game and keeps track of all the moves in the move log, which player has the current turn and the final result of the game.

Parameters

the type of a board.

the type of a move generator.

the type of a piece.

the type of a coordinate.

Functions

concede

abstract fun concede(player: Player)

Sets the concedeWinner to opponent (a player that is not current player)

equals

open operator fun equals(other: Any?): Boolean

getCurrentPlayer

open fun getCurrentPlayer(): Player

Returns the current player

getNextPlayer

open fun getNextPlayer(): Player

Returns the next player without incrementing the turn.

getOpponentPlayers

open fun getOpponentPlayers(player: Player): List<Player>

Returns a list of opponent players for a given player.

getOutcome

open fun getOutcome(): Outcome?

Returns the outcome of the game for the current player, which can be either Win or Draw (null if the game is not over)

abstract fun getOutcome(player: Player): Outcome?

Returns the outcome of the game for the given player, which can be either Win or Draw (null if the game is not over)

getValidMoves

open fun getValidMoves(): List<Move<B, MG, P, C>>

Returns a list of all possible valid moves of the current player

abstract fun getValidMoves(player: Player): List<Move<B, MG, P, C>>

Returns a list of all possible valid moves of the given player

hashCode

open fun hashCode(): Int

inCheck

abstract fun inCheck(player: Player): Boolean

Returns if the given player's Royal piece is is check or not, assuming that the Royal piece is present on the board.

initBoard

abstract fun initBoard()

Initialises the board Places pieces on the initial position of the board

initGame

abstract fun initGame()

Initialises the game by clearing and initialising the board

isOver

abstract fun isOver(): Boolean

Returns if the game is over or not

makeMove

abstract fun makeMove(move: Move<B, MG, P, C>)

Makes the given move on the current board and add the move to the move log.

nextPlayer

open fun nextPlayer()

Increments the turn

playerMakeMove

open fun playerMakeMove(move: Move<B, MG, P, C>)

Makes a given move and increments the turn

prevPlayer

open fun prevPlayer()

Decrements the turn

toString

open fun toString(): String

undoMove

abstract fun undoMove()

Reverts the last move and removes it from the move log.

Properties

board

abstract val board: B

the board of the game

endConditions

abstract val endConditions: List<EndCondition<GameType<B, MG, P, C>, B, MG, P, C>>

moveLog

abstract val moveLog: MutableList<Move<B, MG, P, C>>

the list of all moves played

name

abstract val name: String

the name of the game

players

abstract val players: List<Player>

the list of all participants of the game

playerTurn

abstract var playerTurn: Int

the current turn of the game

rules

abstract val rules: List<SpecialRules<GameType<B, MG, P, C>, B, MG, P, C>>

seed

abstract var seed: Double?

the random seed

Inheritors

GameType2D

GameType2P

GameType3D

GameTypeHex