Class ChessEngine

Creates the engine to manage chess game

includes movement, ai moves, castling, en passant, and game finished

Hierarchy

ChessEngine

Index

Constructors

Properties

Accessors

Methods

checkPromotion copy getGameFinishedReason getLastMove getLegalMoves getLegalSquares getPieceSide getPieceTypeFromMove getPieceTypeFromSquare hasPiece isCapture isEnPassant isGameFinished isKingSideCastling isQueenSideCastling loadPgn makeAiMove makeMove

Constructors

constructor

new ChessEngine(pgn?: string): ChessEngine
Parameters
- Optional pgn: string
  
  The pgn to use. If undefined, a new game is created.
Returns ChessEngine
- Defined in src/common/chess-engine.ts:18

Properties

`Private` chess

chess: Chess

Accessors

fen

get fen(): string
get the board position

Returns string
- Defined in src/common/chess-engine.ts:39

pgn

get pgn(): string
get the board history

Returns string
- Defined in src/common/chess-engine.ts:44

Methods

checkPromotion

checkPromotion(from: Square, to: Square): boolean
Returns true if a move is a promotion, and false otherwise. Assumes that chess hasn't been updated yet
Parameters
- from: Square
- to: Square
Returns boolean
- Defined in src/common/chess-engine.ts:190

copy

copy(move?: Move): ChessEngine
Copies the chess engine, optionally with an extra move on the copy.
Parameters
- Optional move: Move
  
  A move to make.
Returns ChessEngine
- Defined in src/common/chess-engine.ts:29

getGameFinishedReason

getGameFinishedReason(): undefined | GameFinishedReason
checks if and how the game has ended

Returns
- a game finished reason from the enum
Returns undefined | GameFinishedReason
- Defined in src/common/chess-engine.ts:227

getLastMove

getLastMove(): undefined | Move
get the last move made

Returns undefined | Move
- Defined in src/common/chess-engine.ts:54

getLegalMoves

getLegalMoves(square?: Square): Move[]
gets ALL legal moves from the provided square

Returns
- possible to squares
Parameters
- Optional square: Square
  
  from square
Returns Move[]
- Defined in src/common/chess-engine.ts:161

getLegalSquares

getLegalSquares(square?: Square): Square[]
returns a square's legal moves as a map

Returns
- possible to squares
Parameters
- Optional square: Square
  
  from square
Returns Square[]
- Defined in src/common/chess-engine.ts:173

getPieceSide

getPieceSide(square: Square): undefined | Side
Takes in a Square argument and returns the side of the piece on the square or undefined

Returns
The current side of the piece on the square or undefined if there is no piece on the square
Parameters
- square: Square
Returns undefined | Side
- Defined in src/common/chess-engine.ts:131

getPieceTypeFromMove

getPieceTypeFromMove(move: Move): PieceType
Takes in a Move argument and returns the piece on the square

Returns
The current piece on the square as a PieceType enum
Parameters
- move: Move
Returns PieceType
- Defined in src/common/chess-engine.ts:152

getPieceTypeFromSquare

getPieceTypeFromSquare(square: Square): undefined | PieceType
Takes in a Square argument and returns the piece on the square or undefined

Returns
The current piece on the square as a PieceType enum or undefined if there is no piece
Parameters
- square: Square
Returns undefined | PieceType
- Defined in src/common/chess-engine.ts:118

hasPiece

hasPiece(square: Square): boolean
Takes in a Square argument and returns if the square has a piece on it.

Returns
true if the square has a piece on it.
Parameters
- square: Square
Returns boolean
- Defined in src/common/chess-engine.ts:144

isCapture

isCapture(move: Move): boolean
Takes a move argument and determines if the move results in a capture Assumes that chess hasn't been updated yet

Returns
true if the move is a Capture
Parameters
- move: Move
Returns boolean
- Defined in src/common/chess-engine.ts:95

isEnPassant

isEnPassant(move: Move): boolean
Takes a move argument and determines if the move is an En Passant Capture. Assumes that chess hasn't been updated yet

Returns
true if the move is an En Passant Capture
Parameters
- move: Move
Returns boolean
- Defined in src/common/chess-engine.ts:79

isGameFinished

isGameFinished(): boolean
Returns true if getGameFinishedReason does not return undefined.

Returns boolean
- Defined in src/common/chess-engine.ts:248

isKingSideCastling

isKingSideCastling(move: Move): boolean
Takes a move argument and determines if the move is a King Side Castle. Assumes that chess hasn't been updated yet

Returns
true if the move is a King Side Castle
Parameters
- move: Move
Returns boolean
- Defined in src/common/chess-engine.ts:64

isQueenSideCastling

isQueenSideCastling(move: Move): boolean
Takes a move argument and determines if the move is a Queen Side Castle. Assumes that chess hasn't been updated yet

Returns
true if the move is a Queen Side Castle
Parameters
- move: Move
Returns boolean
- Defined in src/common/chess-engine.ts:104

loadPgn

loadPgn(pgn: string): void
load a board from history
Parameters
- pgn: string
Returns void
- Defined in src/common/chess-engine.ts:49

makeAiMove

makeAiMove(difficulty: Difficulty): Move
makes an ai move based on the selected difficulty

Returns
- the move made
Parameters
- difficulty: Difficulty
  
  a value from 0 to 4 for the ai
Returns Move
- Defined in src/common/chess-engine.ts:204

makeMove

makeMove(move: Move): Move
Makes a move on the chessboard.

Returns
the move that was made.
Parameters
- move: Move
Returns Move
- Defined in src/common/chess-engine.ts:181

Generated using TypeDoc