Class ChessEngine

Creates the engine to manage chess game

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

Hierarchy

ChessEngine

Index

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:20

Properties

`Private` chess

chess: Chess

Accessors

fen

get fen(): string
get the board position

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

pgn

get pgn(): string
get the board history

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

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:243

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:31

getCapturedPieceId

getCapturedPieceId(move: Move, robotManager: RobotManager): undefined | string
Returns the robot id of the moving piece in a Move. Assumes that chess hasn't been updated yet

Returns
The current piece on the square as a it's robot id as a string
Parameters
- move: Move
  
  The Move to check.
- robotManager: RobotManager
Returns undefined | string
- Defined in src/common/chess-engine.ts:132

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:280

getLastMove

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

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

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:214

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:226

getPieceSide

getPieceSide(square: Square): undefined | Side
Returns the side of the piece on a 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
  
  The Square to check.
Returns undefined | Side
- Defined in src/common/chess-engine.ts:182

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
  
  The Move to check.
Returns PieceType
- Defined in src/common/chess-engine.ts:205

getPieceTypeFromSquare

getPieceTypeFromSquare(square: Square): undefined | PieceType
Returns the piece on a square or undefined

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

hasPiece

hasPiece(square: Square): boolean
Returns if a square has a piece on it.

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

isEnPassant

isEnPassant(move: Move): boolean
Determines if a 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
  
  The Move to analyze.
Returns boolean
- Defined in src/common/chess-engine.ts:88

isGameFinished

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

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

isKingSideCastling

isKingSideCastling(move: Move): boolean
Determines if a 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
  
  The Move to analyze.
Returns boolean
- Defined in src/common/chess-engine.ts:72

isQueenSideCastling

isQueenSideCastling(move: Move): boolean
Determines if a 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
  
  The Move to analyze.
Returns boolean
- Defined in src/common/chess-engine.ts:116

isRegularCapture

isRegularCapture(move: Move): boolean
Determines if a move results in a capture with no special shenanigans. Assumes that chess hasn't been updated yet

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

loadFen

loadFen(fen: string): void
load a board from history (FEN)
Parameters
- fen: string
Returns void
- Defined in src/common/chess-engine.ts:51

loadPgn

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

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:257

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:234

Generated using TypeDoc