Class GobanEngine

Hierarchy (view full)

BoardState
- GobanEngine

Index

Constructors

Constructors

constructor

new GobanEngine(config, goban_callback?, dontStoreBoardHistory?): GobanEngine
Parameters
- config: GobanEngineConfig
- Optional goban_callback: GobanBase
- Optional dontStoreBoardHistory: boolean
Returns GobanEngine
Overrides BoardState.constructor
- Defined in engine/GobanEngine.ts:477

Properties

`Private` _cur_move

_cur_move: MoveTree

`Private` _cur_review_move

_cur_review_move: undefined | MoveTree

`Private` _last_official_move

_last_official_move: MoveTree

`Private` _outcome

_outcome: string = ""

`Private` _phase

_phase: GobanEnginePhase = "play"

`Private` _rules

_rules: GobanEngineRules = "japanese"

`Private` _strict_seki_mode

_strict_seki_mode: boolean = false

`Private` `Optional` _undo_requested

_undo_requested?: number

`Private` `Optional` _winner

_winner?: number | "black" | "white"

`Private` aga_handicap_scoring

aga_handicap_scoring: boolean = false

`Private` allow_ko

allow_ko: boolean = false

`Private` allow_self_capture

allow_self_capture: boolean = false

`Private` allow_superko

allow_superko: boolean = false

automatic_stone_removal

automatic_stone_removal: boolean = false

black_prisoners

black_prisoners: number

board

board: JGOFNumericPlayerColor[][]

board_is_repeating

board_is_repeating: boolean

`Readonly` config

config: GobanEngineConfig

decoded_moves

decoded_moves: JGOFMove[] = []

`Readonly` disable_analysis

disable_analysis: boolean = false

`Private` dontStoreBoardHistory

dontStoreBoardHistory: boolean

free_handicap_placement

free_handicap_placement: boolean = false

game_id

game_id: number = NaN

`Protected` `Optional` goban_callback

goban_callback?: GobanBase

`Optional` group_ids

group_ids?: number[]

handicap

handicap: number = NaN

`Optional` handicap_rank_difference

handicap_rank_difference?: number

`Readonly` height

height: number = 19

initial_state

initial_state: GobanEngineInitialState = ...

`Readonly` is_game_record

is_game_record: boolean = false

komi

komi: number = NaN

`Optional` latencies

latencies?: {
[player_id: string]: number;
}

Type declaration

[player_id: string]: number

`Private` loading_sgf

loading_sgf: boolean = false

`Private` `Optional` move_before_jump

move_before_jump?: MoveTree

move_tree

move_tree: MoveTree

move_tree_layout_dirty

move_tree_layout_dirty: boolean = false

move_tree_layout_hash

move_tree_layout_hash: {
[coords: string]: MoveTree;
} = {}

Type declaration

[coords: string]: MoveTree

move_tree_layout_vector

move_tree_layout_vector: number[] = []

`Readonly` name

name: string = ""

`Optional` needs_sealing

needs_sealing?: JGOFSealingIntersection[]

`Optional` parentEventEmitter

parentEventEmitter?: EventEmitter<GobanEvents, any>

player

player: JGOFNumericPlayerColor

player_pool

player_pool: {
[id: number]: GobanEnginePlayerEntry;
}

Type declaration

[id: number]: GobanEnginePlayerEntry

players

players: {
black: GobanEnginePlayerEntry;
white: GobanEnginePlayerEntry;
} = ...

Type declaration

black: GobanEnginePlayerEntry
white: GobanEnginePlayerEntry

puzzle_collection

puzzle_collection: number = NaN

puzzle_description

puzzle_description: string = "[missing puzzle description]"

puzzle_opponent_move_mode

puzzle_opponent_move_mode: PuzzleOpponentMoveMode = "manual"

puzzle_player_move_mode

puzzle_player_move_mode: PuzzlePlayerMoveMode = "free"

puzzle_rank

puzzle_rank: number = NaN

puzzle_type

puzzle_type: string = "[missing puzzle type]"

removal

removal: boolean[][]

`Optional` rengo

rengo?: boolean

rengo_casual_mode

rengo_casual_mode: boolean

`Optional` rengo_teams

rengo_teams?: {
[colour: string]: GobanEnginePlayerEntry[];
}

Type declaration

[colour: string]: GobanEnginePlayerEntry[]

`Optional` review_id

review_id?: number

score_handicap

score_handicap: boolean = false

score_prisoners

score_prisoners: boolean = false

score_stones

score_stones: boolean = false

score_territory

score_territory: boolean = false

score_territory_in_seki

score_territory_in_seki: boolean = false

`Optional` stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

`Private` superko_algorithm

superko_algorithm: GobanEngineSuperKoAlgorithm = "psk"

territory_included_in_sgf

territory_included_in_sgf: boolean = false

`Optional` throw_all_errors

throw_all_errors?: boolean

time_control

time_control: JGOFTimeControl = ...

white_prisoners

white_prisoners: number

`Readonly` width

width: number = 19

Accessors

cur_move

get cur_move(): MoveTree
Returns MoveTree
- Defined in engine/GobanEngine.ts:362
set cur_move(cur_move): void
Parameters
- cur_move: MoveTree
Returns void
- Defined in engine/GobanEngine.ts:365

cur_review_move

get cur_review_move(): undefined | MoveTree
Returns undefined | MoveTree
- Defined in engine/GobanEngine.ts:374
set cur_review_move(cur_review_move): void
Parameters
- cur_review_move: undefined | MoveTree
Returns void
- Defined in engine/GobanEngine.ts:377

last_official_move

get last_official_move(): MoveTree
Returns MoveTree
- Defined in engine/GobanEngine.ts:386
set last_official_move(last_official_move): void
Parameters
- last_official_move: MoveTree
Returns void
- Defined in engine/GobanEngine.ts:389

outcome

get outcome(): string
Returns string
- Defined in engine/GobanEngine.ts:448
set outcome(outcome): void
Parameters
- outcome: string
Returns void
- Defined in engine/GobanEngine.ts:451

phase

get phase(): GobanEnginePhase
Returns GobanEnginePhase
- Defined in engine/GobanEngine.ts:350
set phase(phase): void
Parameters
- phase: GobanEnginePhase
Returns void
- Defined in engine/GobanEngine.ts:353

rules

get rules(): GobanEngineRules
Returns GobanEngineRules
- Defined in engine/GobanEngine.ts:410
set rules(rules): void
Parameters
- rules: GobanEngineRules
Returns void
- Defined in engine/GobanEngine.ts:413

strict_seki_mode

get strict_seki_mode(): boolean
Returns boolean
- Defined in engine/GobanEngine.ts:398
set strict_seki_mode(strict_seki_mode): void
Parameters
- strict_seki_mode: boolean
Returns void
- Defined in engine/GobanEngine.ts:401

undo_requested

get undo_requested(): undefined | number
Returns undefined | number
- Defined in engine/GobanEngine.ts:436
set undo_requested(undo_requested): void
Parameters
- undo_requested: undefined | number
Returns void
- Defined in engine/GobanEngine.ts:439

winner

get winner(): undefined | number | "black" | "white"
Returns undefined | number | "black" | "white"
- Defined in engine/GobanEngine.ts:422
set winner(winner): void
Parameters
- winner: undefined | number | "black" | "white"
Returns void
- Defined in engine/GobanEngine.ts:425

Methods

boardEquals

boardEquals(other): boolean
Returns true if the .board field from the other board is equal to this one
Parameters
- other: BoardState
Returns boolean
Inherited from BoardState.boardEquals
- Defined in engine/BoardState.ts:378

`Private` captureGroup

captureGroup(group): number
Parameters
- group: RawStoneString
Returns number
- Defined in engine/GobanEngine.ts:1052

clearRemoved

clearRemoved(): void
Clear all stone removals

Returns void
Inherited from BoardState.clearRemoved
- Defined in engine/BoardState.ts:229

cloneBoard

cloneBoard(): JGOFNumericPlayerColor[][]
Returns a clone of .board

Returns JGOFNumericPlayerColor[][]
Inherited from BoardState.cloneBoard
- Defined in engine/BoardState.ts:115

cloneBoardState

cloneBoardState(): BoardState
Clone the entire BoardState

Returns BoardState
Inherited from BoardState.cloneBoardState
- Defined in engine/BoardState.ts:110

colorNotToMove

colorNotToMove(): "black" | "white"
Returns "black" | "white"
- Defined in engine/GobanEngine.ts:1113

colorToMove

colorToMove(): "black" | "white"
Returns "black" | "white"
- Defined in engine/GobanEngine.ts:1110

computeInitialStateForForkedGame

computeInitialStateForForkedGame(): {
black: string;
white: string;
}
Returns {
black: string;
white: string;
}
- black: string
- white: string
- Defined in engine/GobanEngine.ts:1383

computeScore

computeScore(only_prisoners?): Score
Computes the score of the current board state.

If only_prisoners is true, we return the same data structure for convenience, but only the prisoners will be counted, other sources of points will be zero.
Parameters
- Optional only_prisoners: boolean
Returns Score
- Defined in engine/GobanEngine.ts:1436

computeScoringLocations

computeScoringLocations(area_scoring): ScoringLocations
Computes scoring locations for the board. If area_scoring is true, we will use area scoring rules, otherwise we will use territory scoring rules (which implies omitting territory in seki).
Parameters
- area_scoring: boolean
Returns ScoringLocations
Inherited from BoardState.computeScoringLocations
- Defined in engine/BoardState.ts:387

countLiberties

countLiberties(raw_stone_string): number
Parameters
- raw_stone_string: RawStoneString
Returns number
Inherited from BoardState.countLiberties
- Defined in engine/BoardState.ts:309

currentPositionId

currentPositionId(): string
Returns string
- Defined in engine/GobanEngine.ts:791

decodeMoves

decodeMoves(move_obj): JGOFMove[]
Decodes any of the various ways we express moves that we've accumulated over the years into a unified JGOFMove[].
Parameters
- move_obj: undefined | string | JGOFMove | AdHocPackedMove | [object] | AdHocPackedMove[] | JGOFMove[]
Returns JGOFMove[]
- Defined in engine/GobanEngine.ts:702

decodePrettyCoordinates

decodePrettyCoordinates(coordinates): JGOFMove
Decodes a move string like "A11" into a move object like {x: 0, y: 10}. Also handles the special cases like ".." and "pass" which map to {x: -1, y: -1}.
Parameters
- coordinates: string
Returns JGOFMove
- Defined in engine/GobanEngine.ts:731

deleteCurMove

deleteCurMove(): void
Returns void
- Defined in engine/GobanEngine.ts:991

editPlace

editPlace(x, y, color, isTrunkMove?): void
Parameters
- x: number
- y: number
- color: JGOFNumericPlayerColor
- Optional isTrunkMove: boolean
Returns void
- Defined in engine/GobanEngine.ts:1283

emit

emit<K>(event, ...args): boolean
Type Parameters
- K extends keyof GobanEvents
Parameters
- event: K
- Rest ...args: ArgumentMap<GobanEvents>[Extract<K, keyof GobanEvents>]
Returns boolean
Overrides BoardState.emit
- Defined in engine/GobanEngine.ts:2548

encodeMove

encodeMove(lst): string
Parameters
- lst: JGOFMove
Returns string
- Defined in engine/GobanEngine.ts:723

encodeMoves

encodeMoves(lst): string
Parameters
- lst: JGOFMove[]
Returns string
- Defined in engine/GobanEngine.ts:717

estimateScore

estimateScore(trials, tolerance, prefer_remote?, should_autoscore?): ScoreEstimator
Parameters
- trials: number
- tolerance: number
- prefer_remote: boolean = false
- should_autoscore: boolean = false
Returns ScoreEstimator
- Defined in engine/GobanEngine.ts:2466

exportAsPuzzle

exportAsPuzzle(): PuzzleConfig
Returns PuzzleConfig
- Defined in engine/GobanEngine.ts:2510

followPath

followPath(from_turn, moves, cb?): MoveTree[]
Parameters
- from_turn: number
- moves: string | AdHocPackedMove
- Optional cb: ((x, y, edited, color) => void)
  - - (x, y, edited, color): void
    - Parameters
      x: number
      y: number
      edited: boolean
      color: number
      Returns void
Returns MoveTree[]
- Defined in engine/GobanEngine.ts:795

foreachNeighbor

foreachNeighbor(pt_or_raw_stone_string, callback): void
Parameters
- pt_or_raw_stone_string: JGOFIntersection | RawStoneString
- callback: ((x, y) => void)
  - - (x, y): void
    - Parameters
      x: number
      y: number
      Returns void
Returns void
Inherited from BoardState.foreachNeighbor
- Defined in engine/BoardState.ts:324

gameCanBeCancelled

gameCanBeCancelled(): boolean
Returns boolean
- Defined in engine/GobanEngine.ts:1005

getBlackPrisoners

getBlackPrisoners(): number
Returns number
- Defined in engine/GobanEngine.ts:2527

getCurrentMoveNumber

getCurrentMoveNumber(): number
Returns number
- Defined in engine/GobanEngine.ts:1426

getHandicapPointAdjustmentForWhite

getHandicapPointAdjustmentForWhite(): number
Returns number
- Defined in engine/GobanEngine.ts:2535

getMoveByLocation

getMoveByLocation(x, y, include_forward_search): null | MoveTree
Parameters
- x: number
- y: number
- include_forward_search: boolean
Returns null | MoveTree
- Defined in engine/GobanEngine.ts:2485

getMoveDiff

getMoveDiff(): {
from: number;
moves: string;
}
Returns a move string from the given official move number (aka branch point)

Returns {
from: number;
moves: string;
}
- from: number
- moves: string
- Defined in engine/GobanEngine.ts:967

getMoveNumber

getMoveNumber(): number
Returns number
- Defined in engine/GobanEngine.ts:1423

getNeighboringRawStoneStrings

getNeighboringRawStoneStrings(raw_stone_string): RawStoneString[]
Returns an array of groups connected to the given group. This is a bit faster than using StoneGroupBuilder because we only compute the values we need.
Parameters
- raw_stone_string: RawStoneString
Returns RawStoneString[]
Inherited from BoardState.getNeighboringRawStoneStrings
- Defined in engine/BoardState.ts:249

getRawStoneString

getRawStoneString(x, y, clearMarks): RawStoneString
Returns an array of x/y pairs of all the same color
Parameters
- x: number
- y: number
- clearMarks: boolean
Returns RawStoneString
Inherited from BoardState.getRawStoneString
- Defined in engine/BoardState.ts:272

`Private` getState

getState(): BoardState
Returns BoardState
- Defined in engine/GobanEngine.ts:746

getStoneRemovalString

getStoneRemovalString(): string
Returns string
- Defined in engine/GobanEngine.ts:1406

getWhitePrisoners

getWhitePrisoners(): number
Returns number
- Defined in engine/GobanEngine.ts:2530

handicapMovesLeft

handicapMovesLeft(): number
Returns number
- Defined in engine/GobanEngine.ts:1555

initialStatePlace

initialStatePlace(x, y, color, dont_record_placement?): void
Parameters
- x: number
- y: number
- color: JGOFNumericPlayerColor
- Optional dont_record_placement: boolean
Returns void
- Defined in engine/GobanEngine.ts:1310

isActivePlayer

isActivePlayer(player_id): boolean
Parameters
- player_id: number
Returns boolean
- Defined in engine/GobanEngine.ts:1080

isBoardRepeating

isBoardRepeating(superko_rule): boolean
Parameters
- superko_rule: GobanEngineSuperKoAlgorithm
Returns boolean
- Defined in engine/GobanEngine.ts:1262

isLastOfficialMove

isLastOfficialMove(): boolean
returns true if our current move is our last official move

Returns boolean
- Defined in engine/GobanEngine.ts:963

isParticipant

isParticipant(player_id): boolean
Parameters
- player_id: number
Returns boolean
- Defined in engine/GobanEngine.ts:1070

jumpToLastOfficialMove

jumpToLastOfficialMove(): void
Returns void
- Defined in engine/GobanEngine.ts:941

jumpToOfficialMoveNumber

jumpToOfficialMoveNumber(move_number): void
Parameters
- move_number: number
Returns void
- Defined in engine/GobanEngine.ts:1033

`Private` opponent

opponent(): JGOFNumericPlayerColor
Returns JGOFNumericPlayerColor
- Defined in engine/GobanEngine.ts:1048

otherPlayer

otherPlayer(): JGOFNumericPlayerColor
Returns JGOFNumericPlayerColor
- Defined in engine/GobanEngine.ts:1096

`Private` parseSGF

parseSGF(sgf): (() => void)
Parameters
- sgf: string
Returns (() => void)
- - (): void
  - Returns void
- Defined in engine/GobanEngine.ts:1935

place

place(x, y, checkForKo?, errorOnSuperKo?, dontCheckForSuperKo?, dontCheckForSelfCapture?, isTrunkMove?, removed_stones?): number
Returns the number of stones removed. If you want the coordinates of the stones removed, pass in a removed_stones array to append the moves to.
Parameters
- x: number
- y: number
- Optional checkForKo: boolean
- Optional errorOnSuperKo: boolean
- Optional dontCheckForSuperKo: boolean
- Optional dontCheckForSelfCapture: boolean
- Optional isTrunkMove: boolean
- Optional removed_stones: JGOFIntersection[]
Returns number
- Defined in engine/GobanEngine.ts:1132

playerByColor

playerByColor(color): JGOFNumericPlayerColor
Parameters
- color: JGOFNumericPlayerColor | PlayerColor
Returns JGOFNumericPlayerColor
- Defined in engine/GobanEngine.ts:1116

playerColor

playerColor(player_id?): "black" | "white" | "invalid"
Parameters
- Optional player_id: number
Returns "black" | "white" | "invalid"
- Defined in engine/GobanEngine.ts:1099

playerNotToMove

playerNotToMove(): number
Returns number
- Defined in engine/GobanEngine.ts:1093

playerToMove

playerToMove(): number
Returns number
- Defined in engine/GobanEngine.ts:1090

playerToMoveOnOfficialBranch

playerToMoveOnOfficialBranch(): number
Returns number
- Defined in engine/GobanEngine.ts:1085

prettyCoordinates

prettyCoordinates(x): string
Encodes an x,y pair or a move object like {x: 0, y: 0} into a move string like "A1"
Parameters
- x: JGOFMove
Returns string
- Defined in engine/GobanEngine.ts:736
prettyCoordinates(x, y): string
Parameters
- x: number
- y: number
Returns string
- Defined in engine/GobanEngine.ts:737

resetMoveTree

resetMoveTree(): void
Returns void
- Defined in engine/GobanEngine.ts:1364

setAsCurrentReviewMove

setAsCurrentReviewMove(): void
Returns void
- Defined in engine/GobanEngine.ts:985

setLastOfficialMove

setLastOfficialMove(): void
Saves our current move as our last official move

Returns void
- Defined in engine/GobanEngine.ts:949

setNeedsSealing

setNeedsSealing(x, y, needs_sealing?): void
Parameters
- x: number
- y: number
- Optional needs_sealing: boolean
Returns void
- Defined in engine/GobanEngine.ts:1402

setRemoved

setRemoved(x, y, removed, emit_stone_removal_updated?): void
Sets a position as being removed or not removed. If emit_stone_removal_updated is set to false, the "stone-removal.updated" event will not be emitted, and it is up to the caller to emit this event appropriately.
Parameters
- x: number
- y: number
- removed: boolean
- emit_stone_removal_updated: boolean = true
Returns void
Overrides BoardState.setRemoved
- Defined in engine/GobanEngine.ts:2559

`Private` setState

setState(state): BoardState
Parameters
- state: BoardState
Returns BoardState
- Defined in engine/GobanEngine.ts:749

showNext

showNext(): boolean
Returns true if there was a next to show

Returns boolean
- Defined in engine/GobanEngine.ts:905

showNextTrunk

showNextTrunk(): boolean
Returns true if there was a next to show

Returns boolean
- Defined in engine/GobanEngine.ts:917

showPrevious

showPrevious(): boolean
Returns true if there was a previous to show

Returns boolean
- Defined in engine/GobanEngine.ts:892

toggleSingleGroupRemoval

toggleSingleGroupRemoval(x, y, force_removal?): {
group: RawStoneString;
removed: boolean;
}
Toggles a group of stones for removal or restoration.

By default, if we are marking a group for removal but the group is almost certainly alive (two eyes, etc), this will result in a no-op, unless force_removal is set to true.
Parameters
- x: number
- y: number
- force_removal: boolean = false
Returns {
group: RawStoneString;
removed: boolean;
}
- group: RawStoneString
- removed: boolean
Inherited from BoardState.toggleSingleGroupRemoval
- Defined in engine/BoardState.ts:126

updatePlayers

updatePlayers(player_update): void
Parameters
- player_update: JGOFPlayerSummary
Returns void
- Defined in engine/GobanEngine.ts:858

`Static` clearRuleSettings

clearRuleSettings(game_obj): GobanEngineConfig
Parameters
- game_obj: GobanEngineConfig
Returns GobanEngineConfig
- Defined in engine/GobanEngine.ts:1920

`Static` fillDefaults

fillDefaults(game_obj): GobanEngineConfig
This function fills in default values for any missing fields in the config.
Parameters
- game_obj: GobanEngineConfig
Returns GobanEngineConfig
- Defined in engine/GobanEngine.ts:1618

`Static` `Private` migrateConfig

migrateConfig(config): GobanEngineConfig
This function migrates old config's to whatever our current standard is for configs.
Parameters
- config: GobanEngineConfig
Returns GobanEngineConfig
- Defined in engine/GobanEngine.ts:1566

Class GobanEngine

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GobanEngine

Properties

Private _cur_move

Private _cur_review_move

Private _last_official_move

Private _outcome

Private _phase

Private _rules

Private _strict_seki_mode

Private Optional _undo_requested

Private Optional _winner

Private aga_handicap_scoring

Private allow_ko

Private allow_self_capture

Private allow_superko

automatic_stone_removal

black_prisoners

board

board_is_repeating

Readonly config

decoded_moves

Readonly disable_analysis

Private dontStoreBoardHistory

free_handicap_placement

game_id

Protected Optional goban_callback

Optional group_ids

handicap

Optional handicap_rank_difference

Readonly height

initial_state

Readonly is_game_record

komi

Optional latencies

Type declaration

[player_id: string]: number

Private loading_sgf

Private Optional move_before_jump

move_tree

move_tree_layout_dirty

move_tree_layout_hash

Type declaration

[coords: string]: MoveTree

move_tree_layout_vector

Readonly name

Optional needs_sealing

Optional parentEventEmitter

player

player_pool

Type declaration

[id: number]: GobanEnginePlayerEntry

players

Type declaration

black: GobanEnginePlayerEntry

white: GobanEnginePlayerEntry

puzzle_collection

puzzle_description

puzzle_opponent_move_mode

puzzle_player_move_mode

puzzle_rank

puzzle_type

removal

Optional rengo

rengo_casual_mode

Optional rengo_teams

Type declaration

[colour: string]: GobanEnginePlayerEntry[]

Optional review_id

score_handicap

score_prisoners

`Private` _cur_move

`Private` _cur_review_move

`Private` _last_official_move

`Private` _outcome

`Private` _phase

`Private` _rules

`Private` _strict_seki_mode

`Private` `Optional` _undo_requested

`Private` `Optional` _winner

`Private` aga_handicap_scoring

`Private` allow_ko

`Private` allow_self_capture

`Private` allow_superko

`Readonly` config

`Readonly` disable_analysis

`Private` dontStoreBoardHistory

`Protected` `Optional` goban_callback

`Optional` group_ids

`Optional` handicap_rank_difference

`Readonly` height

`Readonly` is_game_record

`Optional` latencies

`Private` loading_sgf

`Private` `Optional` move_before_jump

`Readonly` name

`Optional` needs_sealing

`Optional` parentEventEmitter

`Optional` rengo

`Optional` rengo_teams

`Optional` review_id

`Optional` stalling_score_estimate

`Private` superko_algorithm

`Optional` throw_all_errors

`Readonly` width

`Private` captureGroup

Returns {
black: string;
white: string;
}