Class Chess

Hierarchy (view full)

Position
- Chess

Properties

board

board: Board

castles

castles: Castles

epSquare

epSquare: undefined | number

fullmoves

fullmoves: number

halfmoves

halfmoves: number

pockets

pockets: undefined | Material

remainingChecks

remainingChecks: undefined | RemainingChecks

`Readonly`rules

rules:
    | "chess"
    | "antichess"
    | "kingofthehill"
    | "3check"
    | "atomic"
    | "horde"
    | "racingkings"
    | "crazyhouse"

turn

turn: "black" | "white"

Methods

allDests

allDests(ctx?): Map<number, SquareSet>
Parameters
- Optionalctx: Context
Returns Map<number, SquareSet>
Inherited from Position.allDests
- Defined in src/chess.ts:420

clone

clone(): Chess
Returns Chess
Overrides Position.clone
- Defined in src/chess.ts:505

ctx

ctx(): Context
Returns Context
Inherited from Position.ctx
- Defined in src/chess.ts:213

dests

dests(square, ctx?): SquareSet
Parameters
- square: number
- Optionalctx: Context
Returns SquareSet
Inherited from Position.dests
- Defined in src/chess.ts:274

dropDests

dropDests(_ctx?): SquareSet
Parameters
- Optional_ctx: Context
Returns SquareSet
Inherited from Position.dropDests
- Defined in src/chess.ts:270

hasDests

hasDests(ctx?): boolean
Parameters
- Optionalctx: Context
Returns boolean
Inherited from Position.hasDests
- Defined in src/chess.ts:369

hasInsufficientMaterial

hasInsufficientMaterial(color): boolean
Parameters
- color: "black" | "white"
Returns boolean
Inherited from Position.hasInsufficientMaterial
- Defined in src/chess.ts:334

isCheck

isCheck(): boolean
Returns boolean
Inherited from Position.isCheck
- Defined in src/chess.ts:391

isCheckmate

isCheckmate(ctx?): boolean
Parameters
- Optionalctx: Context
Returns boolean
Inherited from Position.isCheckmate
- Defined in src/chess.ts:401

isEnd

isEnd(ctx?): boolean
Parameters
- Optionalctx: Context
Returns boolean
Inherited from Position.isEnd
- Defined in src/chess.ts:396

isInsufficientMaterial

isInsufficientMaterial(): boolean
Returns boolean
Inherited from Position.isInsufficientMaterial
- Defined in src/chess.ts:365

isLegal

isLegal(move, ctx?): boolean
Parameters
- move: Move
- Optionalctx: Context
Returns boolean
Inherited from Position.isLegal
- Defined in src/chess.ts:377

isStalemate

isStalemate(ctx?): boolean
Parameters
- Optionalctx: Context
Returns boolean
Inherited from Position.isStalemate
- Defined in src/chess.ts:406

isVariantEnd

isVariantEnd(): boolean
Returns boolean
Inherited from Position.isVariantEnd
- Defined in src/chess.ts:326

kingAttackers

kingAttackers(square, attacker, occupied): SquareSet
Parameters
- square: number
- attacker: "black" | "white"
- occupied: SquareSet
Returns SquareSet
Inherited from Position.kingAttackers
- Defined in src/chess.ts:203

outcome

outcome(ctx?): undefined | Outcome
Parameters
- Optionalctx: Context
Returns undefined | Outcome
Inherited from Position.outcome
- Defined in src/chess.ts:411

play

play(move): void
Parameters
- move: Move
Returns void
Inherited from Position.play
- Defined in src/chess.ts:430

`Protected`playCaptureAt

playCaptureAt(square, captured): void
Parameters
- square: number
- captured: Piece
Returns void
Inherited from Position.playCaptureAt
- Defined in src/chess.ts:207

reset

reset(): void
Returns void
Inherited from Position.reset
- Defined in src/chess.ts:168

`Protected`setupUnchecked

setupUnchecked(setup): void
Parameters
- setup: Setup
Returns void
Inherited from Position.setupUnchecked
- Defined in src/chess.ts:179

toSetup

toSetup(): Setup
Returns Setup
Inherited from Position.toSetup
- Defined in src/chess.ts:352

`Protected`validate

validate(): Result<undefined, PositionError>
Returns Result<undefined, PositionError>
Inherited from Position.validate
- Defined in src/chess.ts:251

variantOutcome

variantOutcome(_ctx?): undefined | Outcome
Parameters
- Optional_ctx: Context
Returns undefined | Outcome
Inherited from Position.variantOutcome
- Defined in src/chess.ts:330

`Static`default

default(): Chess
Returns Chess
- Defined in src/chess.ts:493

`Static`fromSetup

fromSetup(setup): Result<Chess, PositionError>
Parameters
- setup: Setup
Returns Result<Chess, PositionError>
- Defined in src/chess.ts:499