Documentation

Board
in package

Table of Contents

Constants

NX  = 8
NY  = 8

Properties

$board  : array<int, array<int, ChessPiece|null>>
$canCastle  : array<string|int, mixed>
$enPassantPawn  : Loc|null
$numMoves  : int

Methods

__construct()  : mixed
canCastle()  : bool
clear()  : void
Remove all pieces from the board
clearSquare()  : void
Remove the piece, if any, from this square
deepCopy()  : self
getBoardDisplay()  : array<int, array<int, ChessPiece|null>>
Get the board from the colour's perspective as an array.
getCurrentTurnColour()  : Colour
getEnPassantPawn()  : Loc|null
getFEN()  : string
getKing()  : ChessPiece
getPiece()  : ChessPiece
getPieceOrNull()  : ChessPiece|null
getPieces()  : array<string|int, ChessPiece>
hasPiece()  : bool
isChecked()  : bool
Is the $colour King being attacked by any enemy pieces?
isCheckmated()  : bool
isDraw()  : bool
movePiece()  : ChessPiece, EnPassant: bool, PawnPromotion: bool}
Move a piece. Note that legality of the move is not checked here.
setCastling()  : void
setEnPassantPawn()  : void
setSquare()  : void
Change the position of a piece on the board
hasLegalMoves()  : bool
Can $colour make any legal moves in the current position?
initialize()  : void

Constants

Properties

$canCastle

private array<string|int, mixed> $canCastle

$enPassantPawn

private Loc|null $enPassantPawn

$numMoves

private int $numMoves = 0

Methods

__construct()

public __construct([bool $initialize = true ]) : mixed
Parameters
$initialize : bool = true

clear()

Remove all pieces from the board

public clear() : void

clearSquare()

Remove the piece, if any, from this square

public clearSquare(Loc $loc) : void
Parameters
$loc : Loc

deepCopy()

public deepCopy() : self
Return values
self

getBoardDisplay()

Get the board from the colour's perspective as an array.

public getBoardDisplay(bool $playerIsWhite) : array<int, array<int, ChessPiece|null>>

The first dimension is the y-coordinate, second is x-coordinate.

Parameters
$playerIsWhite : bool
Return values
array<int, array<int, ChessPiece|null>>

getEnPassantPawn()

public getEnPassantPawn() : Loc|null
Return values
Loc|null

getFEN()

public getFEN() : string
Return values
string

hasPiece()

public hasPiece(Loc $loc) : bool
Parameters
$loc : Loc
Return values
bool

isChecked()

Is the $colour King being attacked by any enemy pieces?

public isChecked(Colour $colour) : bool
Parameters
$colour : Colour
Return values
bool

isCheckmated()

public isCheckmated(Colour $colour) : bool
Parameters
$colour : Colour
Return values
bool

isDraw()

public isDraw(Colour $colour) : bool
Parameters
$colour : Colour
Return values
bool

movePiece()

Move a piece. Note that legality of the move is not checked here.

public movePiece(Loc $loc, Loc $toLoc[, int $pawnPromotionPiece = ChessPiece::QUEEN ]) : ChessPiece, EnPassant: bool, PawnPromotion: bool}
Parameters
$loc : Loc
$toLoc : Loc
$pawnPromotionPiece : int = ChessPiece::QUEEN
Return values
ChessPiece, EnPassant: bool, PawnPromotion: bool}

setCastling()

public setCastling(Colour $colour, array<string|int, Castling> $castling) : void
Parameters
$colour : Colour
$castling : array<string|int, Castling>

Set allowed castling operations

setEnPassantPawn()

public setEnPassantPawn(Loc|null $enPassantPawn) : void
Parameters
$enPassantPawn : Loc|null

hasLegalMoves()

Can $colour make any legal moves in the current position?

private hasLegalMoves(Colour $colour) : bool
Parameters
$colour : Colour
Return values
bool

initialize()

private initialize() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results