Class GoEngine

Hierarchy

EventEmitter<Events>
- GoEngine

Index

Constructors

Constructors

constructor

new GoEngine(config: GoEngineConfig, goban_callback?: GobanCore, dontStoreBoardHistory?: boolean): GoEngine
Parameters
- config: GoEngineConfig
- Optional goban_callback: GobanCore
- Optional dontStoreBoardHistory: boolean
Returns GoEngine
Overrides EventEmitter<Events>.constructor
- Defined in GoEngine.ts:468

Properties

`Private` _cur_move

_cur_move: MoveTree

`Private` _last_official_move

_last_official_move: MoveTree

`Private` _outcome

_outcome: string = ""

`Private` _phase

_phase: GoEnginePhase = "play"

`Private` _rules

_rules: GoEngineRules = "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

`Private` black_prisoners

black_prisoners: number = 0

board

board: JGOFNumericPlayerColor[][]

`Private` board_is_repeating

board_is_repeating: boolean

`Readonly` config

config: GoEngineConfig

`Optional` cur_review_move

cur_review_move?: MoveTree

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

`Optional` getState_callback

getState_callback?: (() => any)

Type declaration

- (): any
- Returns any

`Private` `Optional` goban_callback

goban_callback?: GobanCore

`Optional` group_ids

group_ids?: number[]

handicap

handicap: number = NaN

`Readonly` height

height: number = 19

initial_state

initial_state: GoEngineInitialState = ...

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` marks

marks: number[][]

`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` parentEventEmitter

parentEventEmitter?: EventEmitter<Events, any>

player

player: JGOFNumericPlayerColor

player_pool

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

Type declaration

[id: number]: GoEnginePlayerEntry

players

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

Type declaration

black: GoEnginePlayerEntry
white: GoEnginePlayerEntry

puzzle_collection

puzzle_collection: number = NaN

puzzle_description

puzzle_description: string = "[missing puzzle descripton]"

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: (0 | 1 | -1)[][]

`Optional` rengo

rengo?: boolean

rengo_casual_mode

rengo_casual_mode: boolean

`Optional` rengo_teams

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

Type declaration

[colour: string]: GoEnginePlayerEntry[]

`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` setState_callback

setState_callback?: ((state: any) => void)

Type declaration

- (state: any): void
- Parameters
  - state: any
  Returns void

`Private` superko_algorithm

superko_algorithm: GoEngineSuperKoAlgorithm = "psk"

territory_included_in_sgf

territory_included_in_sgf: boolean = false

`Optional` throw_all_errors

throw_all_errors?: boolean

time_control

time_control: JGOFTimeControl = ...

`Private` white_prisoners

white_prisoners: number = 0

`Readonly` width

width: number = 19

Accessors

cur_move

get cur_move(): MoveTree
Returns MoveTree
- Defined in GoEngine.ts:361
set cur_move(cur_move: MoveTree): void
Parameters
- cur_move: MoveTree
Returns void
- Defined in GoEngine.ts:364

last_official_move

get last_official_move(): MoveTree
Returns MoveTree
- Defined in GoEngine.ts:373
set last_official_move(last_official_move: MoveTree): void
Parameters
- last_official_move: MoveTree
Returns void
- Defined in GoEngine.ts:376

outcome

get outcome(): string
Returns string
- Defined in GoEngine.ts:435
set outcome(outcome: string): void
Parameters
- outcome: string
Returns void
- Defined in GoEngine.ts:438

phase

get phase(): GoEnginePhase
Returns GoEnginePhase
- Defined in GoEngine.ts:349
set phase(phase: GoEnginePhase): void
Parameters
- phase: GoEnginePhase
Returns void
- Defined in GoEngine.ts:352

rules

get rules(): GoEngineRules
Returns GoEngineRules
- Defined in GoEngine.ts:397
set rules(rules: GoEngineRules): void
Parameters
- rules: GoEngineRules
Returns void
- Defined in GoEngine.ts:400

strict_seki_mode

get strict_seki_mode(): boolean
Returns boolean
- Defined in GoEngine.ts:385
set strict_seki_mode(strict_seki_mode: boolean): void
Parameters
- strict_seki_mode: boolean
Returns void
- Defined in GoEngine.ts:388

undo_requested

get undo_requested(): undefined | number
Returns undefined | number
- Defined in GoEngine.ts:423
set undo_requested(undo_requested: undefined | number): void
Parameters
- undo_requested: undefined | number
Returns void
- Defined in GoEngine.ts:426

winner

get winner(): undefined | number | "black" | "white"
Returns undefined | number | "black" | "white"
- Defined in GoEngine.ts:409
set winner(winner: undefined | number | "black" | "white"): void
Parameters
- winner: undefined | number | "black" | "white"
Returns void
- Defined in GoEngine.ts:412

Methods

boardMatriciesAreTheSame

boardMatriciesAreTheSame(m1: JGOFNumericPlayerColor[][], m2: JGOFNumericPlayerColor[][]): boolean
Parameters
- m1: JGOFNumericPlayerColor[][]
- m2: JGOFNumericPlayerColor[][]
Returns boolean
- Defined in GoEngine.ts:763

`Private` boardStatesAreTheSame

boardStatesAreTheSame(state1: GoEngineState, state2: GoEngineState): boolean
Parameters
- state1: GoEngineState
- state2: GoEngineState
Returns boolean
- Defined in GoEngine.ts:780

`Private` captureGroup

captureGroup(group: Group): number
Parameters
- group: Group
Returns number
- Defined in GoEngine.ts:1214

clearRemoved

clearRemoved(): void
Returns void
- Defined in GoEngine.ts:1703

colorNotToMove

colorNotToMove(): "black" | "white"
Returns "black" | "white"
- Defined in GoEngine.ts:1291

colorToMove

colorToMove(): "black" | "white"
Returns "black" | "white"
- Defined in GoEngine.ts:1288

computeInitialStateForForkedGame

computeInitialStateForForkedGame(): {
black: string;
white: string;
}
Returns {
black: string;
white: string;
}
- black: string
- white: string
- Defined in GoEngine.ts:1567

computeLibertyMap

computeLibertyMap(): number[][]
Returns number[][]
- Defined in GoEngine.ts:1232

computeScore

computeScore(only_prisoners?: boolean): Score
Parameters
- Optional only_prisoners: boolean
Returns Score
- Defined in GoEngine.ts:1745

`Private` countLiberties

countLiberties(group: Group): number
Parameters
- group: Group
Returns number
- Defined in GoEngine.ts:1200

currentPositionId

currentPositionId(): string
Returns string
- Defined in GoEngine.ts:792

decodeMoves

decodeMoves(move_obj: string | AdHocPackedMove | AdHocPackedMove[] | [object] | JGOFMove[]): JGOFMove[]
Parameters
- move_obj: string | AdHocPackedMove | AdHocPackedMove[] | [object] | JGOFMove[]
Returns JGOFMove[]
- Defined in GoEngine.ts:709

deleteCurMove

deleteCurMove(): void
Returns void
- Defined in GoEngine.ts:994

editPlace

editPlace(x: number, y: number, color: JGOFNumericPlayerColor, isTrunkMove?: boolean): void
Parameters
- x: number
- y: number
- color: JGOFNumericPlayerColor
- Optional isTrunkMove: boolean
Returns void
- Defined in GoEngine.ts:1467

emit

emit<K>(event: K, ...args: ArgumentMap<Events>[Extract<K, keyof Events>]): boolean
Type Parameters
- K extends keyof Events
Parameters
- event: K
- Rest ...args: ArgumentMap<Events>[Extract<K, keyof Events>]
Returns boolean
Overrides EventEmitter.emit
- Defined in GoEngine.ts:2859

estimateScore

estimateScore(trials: number, tolerance: number, prefer_remote?: boolean): ScoreEstimator
Parameters
- trials: number
- tolerance: number
- prefer_remote: boolean = false
Returns ScoreEstimator
- Defined in GoEngine.ts:2794

exportAsPuzzle

exportAsPuzzle(): PuzzleConfig
Returns PuzzleConfig
- Defined in GoEngine.ts:2821

followPath

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

foreachNeighbor

foreachNeighbor(pt_or_group: JGOFIntersection | Group, fn_of_neighbor_pt: ((x: number, y: number) => void)): void
Parameters
- pt_or_group: JGOFIntersection | Group
- fn_of_neighbor_pt: ((x: number, y: number) => void)
  - - (x: number, y: number): void
    - Parameters
      
      x: number
      
      y: number
      
      Returns void
Returns void
- Defined in GoEngine.ts:1080

`Private` foreachNeighbor_checkAndDo

foreachNeighbor_checkAndDo(x: number, y: number, done_array: boolean[], fn_of_neighbor_pt: ((x: number, y: number) => void)): void
Parameters
- x: number
- y: number
- done_array: boolean[]
- fn_of_neighbor_pt: ((x: number, y: number) => void)
  - - (x: number, y: number): void
    - Parameters
      
      x: number
      
      y: number
      
      Returns void
Returns void
- Defined in GoEngine.ts:1066

gameCanBeCancelled

gameCanBeCancelled(): boolean
Returns boolean
- Defined in GoEngine.ts:1008

getBlackPrisoners

getBlackPrisoners(): number
Returns number
- Defined in GoEngine.ts:2838

`Private` getConnectedGroups

getConnectedGroups(group: Group): Group[]
Returns an array of groups connected to the given group
Parameters
- group: Group
Returns Group[]
- Defined in GoEngine.ts:1154

`Private` getConnectedOpenSpace

getConnectedOpenSpace(group: Group): Group
Parameters
- group: Group
Returns Group
- Defined in GoEngine.ts:1175

getCurrentMoveNumber

getCurrentMoveNumber(): number
Returns number
- Defined in GoEngine.ts:1739

`Private` getGroup

getGroup(x: number, y: number, clearMarks: boolean): Group
Returns an array of x/y pairs of all the same color
Parameters
- x: number
- y: number
- clearMarks: boolean
Returns Group
- Defined in GoEngine.ts:1123

getHandicapPointAdjustmentForWhite

getHandicapPointAdjustmentForWhite(): number
Returns number
- Defined in GoEngine.ts:2846

getMoveByLocation

getMoveByLocation(x: number, y: number): null | MoveTree
Parameters
- x: number
- y: number
Returns null | MoveTree
- Defined in GoEngine.ts:2802

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 GoEngine.ts:970

getMoveNumber

getMoveNumber(): number
Returns number
- Defined in GoEngine.ts:1736

`Private` getState

getState(): GoEngineState
Returns GoEngineState
- Defined in GoEngine.ts:714

getStoneRemovalString

getStoneRemovalString(): string
Returns string
- Defined in GoEngine.ts:1719

getWhitePrisoners

getWhitePrisoners(): number
Returns number
- Defined in GoEngine.ts:2841

handicapMovesLeft

handicapMovesLeft(): number
Returns number
- Defined in GoEngine.ts:1922

`Private` incrementCurrentMarker

incrementCurrentMarker(): void
Returns void
- Defined in GoEngine.ts:1057

initialStatePlace

initialStatePlace(x: number, y: number, color: JGOFNumericPlayerColor, dont_record_placement?: boolean): void
Parameters
- x: number
- y: number
- color: JGOFNumericPlayerColor
- Optional dont_record_placement: boolean
Returns void
- Defined in GoEngine.ts:1494

isActivePlayer

isActivePlayer(player_id: number): boolean
Parameters
- player_id: number
Returns boolean
- Defined in GoEngine.ts:1263

isBoardRepeating

isBoardRepeating(superko_rule: GoEngineSuperKoAlgorithm): boolean
Parameters
- superko_rule: GoEngineSuperKoAlgorithm
Returns boolean
- Defined in GoEngine.ts:1444

isLastOfficialMove

isLastOfficialMove(): boolean
return strue if our current move is our last official move

Returns boolean
- Defined in GoEngine.ts:966

isParticipant

isParticipant(player_id: number): boolean
Parameters
- player_id: number
Returns boolean
- Defined in GoEngine.ts:1253

jumpToLastOfficialMove

jumpToLastOfficialMove(): void
Returns void
- Defined in GoEngine.ts:944

jumpToOfficialMoveNumber

jumpToOfficialMoveNumber(move_number: number): void
Parameters
- move_number: number
Returns void
- Defined in GoEngine.ts:1036

`Private` markGroup

markGroup(group: Group): void
Parameters
- group: Group
Returns void
- Defined in GoEngine.ts:1060

`Private` opponent

opponent(): JGOFNumericPlayerColor
Returns JGOFNumericPlayerColor
- Defined in GoEngine.ts:1051

otherPlayer

otherPlayer(): JGOFNumericPlayerColor
Returns JGOFNumericPlayerColor
- Defined in GoEngine.ts:1274

`Private` parseSGF

parseSGF(sgf: string): (() => void)
Parameters
- sgf: string
Returns (() => void)
- - (): void
  - Returns void
- Defined in GoEngine.ts:2268

place

place(x: number, y: number, checkForKo?: boolean, errorOnSuperKo?: boolean, dontCheckForSuperKo?: boolean, dontCheckForSuicide?: boolean, isTrunkMove?: boolean, removed_stones?: JGOFIntersection[]): 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 dontCheckForSuicide: boolean
- Optional isTrunkMove: boolean
- Optional removed_stones: JGOFIntersection[]
Returns number
- Defined in GoEngine.ts:1310

playerByColor

playerByColor(color: JGOFNumericPlayerColor | PlayerColor): JGOFNumericPlayerColor
Parameters
- color: JGOFNumericPlayerColor | PlayerColor
Returns JGOFNumericPlayerColor
- Defined in GoEngine.ts:1294

playerColor

playerColor(player_id?: number): "black" | "white" | "invalid"
Parameters
- Optional player_id: number
Returns "black" | "white" | "invalid"
- Defined in GoEngine.ts:1277

playerNotToMove

playerNotToMove(): number
Returns number
- Defined in GoEngine.ts:1271

playerToMove

playerToMove(): number
Returns number
- Defined in GoEngine.ts:1268

prettyCoords

prettyCoords(x: number, y: number): string
Parameters
- x: number
- y: number
Returns string
- Defined in GoEngine.ts:1054

resetMoveTree

resetMoveTree(): void
Returns void
- Defined in GoEngine.ts:1548

setAsCurrentReviewMove

setAsCurrentReviewMove(): void
Returns void
- Defined in GoEngine.ts:988

`Private` setGroupForRemoval

setGroupForRemoval(x: number, y: number, toggle_set: 0 | 1 | -1, emit_stone_removal_updated?: boolean): [0 | 1 | -1, Group]
Sets an entire group 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
- toggle_set: 0 | 1 | -1
- emit_stone_removal_updated: boolean = true
Returns [0 | 1 | -1, Group]
- Defined in GoEngine.ts:1653

setLastOfficialMove

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

Returns void
- Defined in GoEngine.ts:952

setRemoved

setRemoved(x: number, y: number, removed: boolean | 0 | 1, emit_stone_removal_updated?: boolean): 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 | 0 | 1
- emit_stone_removal_updated: boolean = true
Returns void
- Defined in GoEngine.ts:1686

`Private` setState

setState(state: GoEngineState): GoEngineState
Parameters
- state: GoEngineState
Returns GoEngineState
- Defined in GoEngine.ts:734

showNext

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

Returns boolean
- Defined in GoEngine.ts:906

showNextTrunk

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

Returns boolean
- Defined in GoEngine.ts:918

showPrevious

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

Returns boolean
- Defined in GoEngine.ts:893

toggleMetaGroupRemoval

toggleMetaGroupRemoval(x: number, y: number): [0 | 1, Group][]
Parameters
- x: number
- y: number
Returns [0 | 1, Group][]
- Defined in GoEngine.ts:1586

updatePlayers

updatePlayers(player_update: JGOFPlayerSummary): void
Parameters
- player_update: JGOFPlayerSummary
Returns void
- Defined in GoEngine.ts:859

`Static` clearRuleSettings

clearRuleSettings(game_obj: GoEngineConfig): GoEngineConfig
Parameters
- game_obj: GoEngineConfig
Returns GoEngineConfig
- Defined in GoEngine.ts:2253

`Static` fillDefaults

fillDefaults(game_obj: GoEngineConfig): GoEngineConfig
Parameters
- game_obj: GoEngineConfig
Returns GoEngineConfig
- Defined in GoEngine.ts:1975

`Static` `Private` normalizeConfig

normalizeConfig(config: GoEngineConfig): void
Parameters
- config: GoEngineConfig
Returns void
- Defined in GoEngine.ts:1929

Class GoEngine

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: GoEngineConfig

Optional goban_callback: GobanCore

Optional dontStoreBoardHistory: boolean

Returns GoEngine

Properties

Private _cur_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

Private black_prisoners

board

Private board_is_repeating

Readonly config

Optional cur_review_move

decoded_moves

Readonly disable_analysis

Private dontStoreBoardHistory

free_handicap_placement

game_id

Optional getState_callback

Type declaration

Returns any

Private Optional goban_callback

Optional group_ids

handicap

Readonly height

initial_state

komi

Optional latencies

Type declaration

[player_id: string]: number

Private loading_sgf

Private marks

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 parentEventEmitter

player

player_pool

Type declaration

[id: number]: GoEnginePlayerEntry

players

Type declaration

black: GoEnginePlayerEntry

white: GoEnginePlayerEntry

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

`Optional` goban_callback: GobanCore

`Optional` dontStoreBoardHistory: boolean

`Private` _cur_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

`Private` black_prisoners

`Private` board_is_repeating

`Readonly` config

`Optional` cur_review_move

`Readonly` disable_analysis

`Private` dontStoreBoardHistory

`Optional` getState_callback

`Private` `Optional` goban_callback

`Optional` group_ids

`Readonly` height

`Optional` latencies

`Private` loading_sgf

`Private` marks

`Private` `Optional` move_before_jump

`Readonly` name

`Optional` parentEventEmitter

`Optional` rengo

`Optional` rengo_teams

`Optional` review_id

`Optional` setState_callback

`Private` superko_algorithm

`Optional` throw_all_errors

`Private` white_prisoners

`Readonly` width

`Private` boardStatesAreTheSame