GameTypeHex

interface GameTypeHex : GameType<BoardHex, MoveGeneratorHex, PieceHex, Coordinate2D>

Implementation of the GameType interface for a standard 2d square board.

Functions

concede
Link copied to clipboard
abstract fun concede(player: Player)
Sets the concedeWinner to opponent (a player that is not current player)
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
getCurrentPlayer
Link copied to clipboard
open fun getCurrentPlayer(): Player
Returns the current player
getNextPlayer
Link copied to clipboard
open fun getNextPlayer(): Player
Returns the next player without incrementing the turn.
getOpponentPlayers
Link copied to clipboard
open fun getOpponentPlayers(player: Player): List<Player>
Returns a list of opponent players for a given player.
getOutcome
Link copied to clipboard
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
Link copied to clipboard
open fun getValidMoves(): List<Move<BoardHex, MoveGeneratorHex, PieceHex, Coordinate2D>>
Returns a list of all possible valid moves of the current player
abstract fun getValidMoves(player: Player): List<Move<BoardHex, MoveGeneratorHex, PieceHex, Coordinate2D>>
Returns a list of all possible valid moves of the given player
hashCode
Link copied to clipboard
open fun hashCode(): Int
inCheck
Link copied to clipboard
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
Link copied to clipboard
abstract fun initBoard()
Initialises the board Places pieces on the initial position of the board
initGame
Link copied to clipboard
abstract fun initGame()
Initialises the game by clearing and initialising the board
isOver
Link copied to clipboard
abstract fun isOver(): Boolean
Returns if the game is over or not
makeMove
Link copied to clipboard
abstract fun makeMove(move: Move<BoardHex, MoveGeneratorHex, PieceHex, Coordinate2D>)
Makes the given move on the current board and add the move to the move log.
nextPlayer
Link copied to clipboard
open fun nextPlayer()
Increments the turn
playerMakeMove
Link copied to clipboard
open fun playerMakeMove(move: Move<BoardHex, MoveGeneratorHex, PieceHex, Coordinate2D>)
Makes a given move and increments the turn
prevPlayer
Link copied to clipboard
open fun prevPlayer()
Decrements the turn
toString
Link copied to clipboard
open fun toString(): String
undoMove
Link copied to clipboard
abstract fun undoMove()
Reverts the last move and removes it from the move log.

Properties

board
Link copied to clipboard
abstract val board: BoardHex
the board of the game
moveLog
Link copied to clipboard
abstract val moveLog: MutableList<Move<BoardHex, MoveGeneratorHex, PieceHex, Coordinate2D>>
the list of all moves played
name
Link copied to clipboard
abstract val name: String
the name of the game
players
Link copied to clipboard
abstract val players: List<Player>
the list of all participants of the game
playerTurn
Link copied to clipboard
abstract var playerTurn: Int
the current turn of the game
rules
Link copied to clipboard
seed
Link copied to clipboard
abstract var seed: Double?
the random seed

Inheritors

AbstractChessHex
Link copied to clipboard