Interface GobanConfig

interface GobanConfig {
    aga_handicap_scoring?: boolean;
    allow_ko?: boolean;
    allow_self_capture?: boolean;
    allow_superko?: boolean;
    auth?: string;
    automatic_stone_removal?: boolean;
    black_player_id?: number;
    black_prisoners?: number;
    board?: JGOFNumericPlayerColor[][];
    board_is_repeating?: boolean;
    bounds?: GobanBounds;
    chat_log?: GobanChatLog;
    circle_radius?: number;
    clock?: GameClock;
    connect_to_chat?: number | boolean;
    disable_analysis?: boolean;
    display_width?: number;
    dont_draw_last_move?: boolean;
    dont_show_messages?: boolean;
    double_click_submit?: boolean;
    draw_bottom_labels?: boolean;
    draw_left_labels?: boolean;
    draw_right_labels?: boolean;
    draw_top_labels?: boolean;
    end_time?: number;
    errors?: {
        error: string;
        stack: any;
    }[];
    free_handicap_placement?: boolean;
    game_date?: string;
    game_id?: string | number;
    game_name?: string;
    game_type?: "temporary";
    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting);
    group_ids?: number[];
    handicap?: number;
    handicap_rank_difference?: number;
    height?: number;
    initial_player?: PlayerColor;
    initial_state?: GobanEngineInitialState;
    interactive?: boolean;
    isInPushedAnalysis?: (() => boolean);
    isPlayerController?: (() => boolean);
    isPlayerOwner?: (() => boolean);
    is_game_record?: boolean;
    isobranch_hash?: string;
    komi?: number;
    ladder?: number;
    ladder_id?: number;
    last_move_radius?: number;
    latencies?: {
        [player_id: string]: number;
    };
    leavePushedAnalysis?: (() => void);
    malkovich_log?: GobanChatLog;
    marks?: {
        [mark: string]: string;
    };
    mode?: GobanModes;
    move_tree?: MoveTreeJson;
    moves?: GobanMovesArray;
    name?: string;
    needs_sealing?: JGOFSealingIntersection[];
    ogs?: {
        black_dead_stones: string;
        black_seki_eyes: string;
        black_stones: string;
        black_territory: string;
        white_dead_stones: string;
        white_seki_eyes: string;
        white_stones: string;
        white_territory: string;
    };
    ogs_import?: boolean;
    onError?: ((err) => void);
    onScoreEstimationUpdated?: ((winning_color, points) => void);
    one_click_submit?: boolean;
    opponent_plays_first_after_resume?: boolean;
    original_disable_analysis?: boolean;
    original_sgf?: string;
    outcome?: string;
    pause_control?: AdHocPauseControl;
    paused_since?: number;
    phase?: GobanEnginePhase;
    player?: JGOFNumericPlayerColor;
    player_id?: number;
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    };
    players?: {
        black: GobanEnginePlayerEntry;
        white: GobanEnginePlayerEntry;
    };
    puzzle_autoplace_delay?: number;
    puzzle_collection?: number;
    puzzle_description?: string;
    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode;
    puzzle_player_move_mode?: PuzzlePlayerMoveMode;
    puzzle_rank?: number;
    puzzle_type?: string;
    ranked?: boolean;
    removal?: boolean[][];
    removed?: string | JGOFMove[];
    rengo?: boolean;
    rengo_casual_mode?: boolean;
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    };
    review_id?: number;
    reviews?: {
        [review_id: number]: GobanEnginePlayerEntry;
    };
    rules?: GobanEngineRules;
    score?: Score;
    score_handicap?: boolean;
    score_passes?: boolean;
    score_prisoners?: boolean;
    score_stones?: boolean;
    score_territory?: boolean;
    score_territory_in_seki?: boolean;
    server_socket?: GobanSocket<ClientToServer, ServerToClient>;
    spectator_log?: GobanChatLog;
    square_size?: number | "auto" | ((goban) => number);
    stalling_score_estimate?: StallingScoreEstimate;
    start_time?: number;
    stone_font_scale?: number;
    strict_seki_mode?: boolean;
    superko_algorithm?: GobanEngineSuperKoAlgorithm;
    throw_all_errors?: boolean;
    time_control?: JGOFTimeControl;
    time_per_move?: number;
    tournament_id?: number;
    username?: string;
    variation_stone_opacity?: number;
    white_must_pass_last?: boolean;
    white_player_id?: number;
    white_prisoners?: number;
    width?: number;
    winner?: number | "black" | "white";
}

Hierarchy (view full)

Properties

aga_handicap_scoring? allow_ko? allow_self_capture? allow_superko? auth? automatic_stone_removal? black_player_id? black_prisoners? board? board_is_repeating? bounds? chat_log? circle_radius? clock? connect_to_chat? disable_analysis? display_width? dont_draw_last_move? dont_show_messages? double_click_submit? draw_bottom_labels? draw_left_labels? draw_right_labels? draw_top_labels? end_time? errors? free_handicap_placement? game_date? game_id? game_name? game_type? getPuzzlePlacementSetting? group_ids? handicap? handicap_rank_difference? height? initial_player? initial_state? interactive? isInPushedAnalysis? isPlayerController? isPlayerOwner? is_game_record? isobranch_hash? komi? ladder? ladder_id? last_move_radius? latencies? leavePushedAnalysis? malkovich_log? marks? mode? move_tree? moves? name? needs_sealing? ogs? ogs_import? onError? onScoreEstimationUpdated? one_click_submit? opponent_plays_first_after_resume? original_disable_analysis? original_sgf? outcome? pause_control? paused_since? phase? player? player_id? player_pool? players? puzzle_autoplace_delay? puzzle_collection? puzzle_description? puzzle_opponent_move_mode? puzzle_player_move_mode? puzzle_rank? puzzle_type? ranked? removal? removed? rengo? rengo_casual_mode? rengo_teams? review_id? reviews? rules? score? score_handicap? score_passes? score_prisoners? score_stones? score_territory? score_territory_in_seki? server_socket? spectator_log? square_size? stalling_score_estimate? start_time? stone_font_scale? strict_seki_mode? superko_algorithm? throw_all_errors? time_control? time_per_move? tournament_id? username? variation_stone_opacity? white_must_pass_last? white_player_id? white_prisoners? width? winner?

Properties

Optional aga_handicap_scoring

aga_handicap_scoring?: boolean

Optional allow_ko

allow_ko?: boolean

Optional allow_self_capture

allow_self_capture?: boolean

Optional allow_superko

allow_superko?: boolean

Optional auth

auth?: string

Optional automatic_stone_removal

automatic_stone_removal?: boolean

Optional black_player_id

black_player_id?: number

Optional black_prisoners

black_prisoners?: number

Optional board

board?: JGOFNumericPlayerColor[][]

Optional board_is_repeating

board_is_repeating?: boolean

Optional bounds

bounds?: GobanBounds

Optional chat_log

chat_log?: GobanChatLog

Optional circle_radius

circle_radius?: number

Optional clock

clock?: GameClock

Optional connect_to_chat

connect_to_chat?: number | boolean

Optional disable_analysis

disable_analysis?: boolean

Optional display_width

display_width?: number

Optional dont_draw_last_move

dont_draw_last_move?: boolean

Optional dont_show_messages

dont_show_messages?: boolean

Optional double_click_submit

double_click_submit?: boolean

Optional draw_bottom_labels

draw_bottom_labels?: boolean

Optional draw_left_labels

draw_left_labels?: boolean

Optional draw_right_labels

draw_right_labels?: boolean

Optional draw_top_labels

draw_top_labels?: boolean

Optional end_time

end_time?: number

Optional errors

errors?: {
    error: string;
    stack: any;
}[]

Type declaration

  • error: string
  • stack: any

Optional free_handicap_placement

free_handicap_placement?: boolean

Optional game_date

game_date?: string

Optional game_id

game_id?: string | number

Optional game_name

game_name?: string

Optional game_type

game_type?: "temporary"

Optional getPuzzlePlacementSetting

getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

Type declaration

Optional group_ids

group_ids?: number[]

Optional handicap

handicap?: number

Optional handicap_rank_difference

handicap_rank_difference?: number

Optional height

height?: number

Optional initial_player

initial_player?: PlayerColor

Optional initial_state

initial_state?: GobanEngineInitialState

Optional interactive

interactive?: boolean

Optional isInPushedAnalysis

isInPushedAnalysis?: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Optional isPlayerController

isPlayerController?: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Optional isPlayerOwner

isPlayerOwner?: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Optional is_game_record

is_game_record?: boolean

Optional isobranch_hash

isobranch_hash?: string

Optional komi

komi?: number

Optional ladder

ladder?: number

Optional ladder_id

ladder_id?: number

Optional last_move_radius

last_move_radius?: number

Optional latencies

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

Type declaration

  • [player_id: string]: number

Optional leavePushedAnalysis

leavePushedAnalysis?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional malkovich_log

malkovich_log?: GobanChatLog

Optional marks

marks?: {
    [mark: string]: string;
}

Type declaration

  • [mark: string]: string

Optional mode

mode?: GobanModes

Optional move_tree

move_tree?: MoveTreeJson

Optional moves

moves?: GobanMovesArray

Optional name

name?: string

Optional needs_sealing

needs_sealing?: JGOFSealingIntersection[]

Intersections that need to be sealed before scoring should happen

Optional ogs

ogs?: {
    black_dead_stones: string;
    black_seki_eyes: string;
    black_stones: string;
    black_territory: string;
    white_dead_stones: string;
    white_seki_eyes: string;
    white_stones: string;
    white_territory: string;
}

Type declaration

  • black_dead_stones: string
  • black_seki_eyes: string
  • black_stones: string
  • black_territory: string
  • white_dead_stones: string
  • white_seki_eyes: string
  • white_stones: string
  • white_territory: string

Optional ogs_import

ogs_import?: boolean

Deprecated, I don't think we need this anymore, but need to be sure

Optional onError

onError?: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      • err: Error

      Returns void

Optional onScoreEstimationUpdated

onScoreEstimationUpdated?: ((winning_color, points) => void)

Type declaration

    • (winning_color, points): void

    • Parameters

      • winning_color: "black" | "white"
      • points: number

      Returns void

Optional one_click_submit

one_click_submit?: boolean

Optional opponent_plays_first_after_resume

opponent_plays_first_after_resume?: boolean

Optional original_disable_analysis

original_disable_analysis?: boolean

Optional original_sgf

original_sgf?: string

Optional outcome

outcome?: string

Optional pause_control

pause_control?: AdHocPauseControl

Optional paused_since

paused_since?: number

Optional phase

phase?: GobanEnginePhase

Optional player

player?: JGOFNumericPlayerColor

Optional player_id

player_id?: number

Optional player_pool

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

Type declaration

Optional players

players?: {
    black: GobanEnginePlayerEntry;
    white: GobanEnginePlayerEntry;
}

Type declaration

Optional puzzle_autoplace_delay

puzzle_autoplace_delay?: number

Optional puzzle_collection

puzzle_collection?: number

Optional puzzle_description

puzzle_description?: string

Optional puzzle_opponent_move_mode

puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

Optional puzzle_player_move_mode

puzzle_player_move_mode?: PuzzlePlayerMoveMode

Optional puzzle_rank

puzzle_rank?: number

Optional puzzle_type

puzzle_type?: string

Optional ranked

ranked?: boolean

Optional removal

removal?: boolean[][]

Optional removed

removed?: string | JGOFMove[]

Removed stones in stone removal phase Passing an array of JGOFMove objects is preferred, the string format exists for historical backwards compatibility. It is an encoded move string, e.g. "aa" for A19

Optional rengo

rengo?: boolean

Optional rengo_casual_mode

rengo_casual_mode?: boolean

Optional rengo_teams

rengo_teams?: {
    black: GobanEnginePlayerEntry[];
    white: GobanEnginePlayerEntry[];
}

Type declaration

Optional review_id

review_id?: number

Optional reviews

reviews?: {
    [review_id: number]: GobanEnginePlayerEntry;
}

Type declaration

Optional rules

rules?: GobanEngineRules

Optional score

score?: Score

Optional score_handicap

score_handicap?: boolean

Optional score_passes

score_passes?: boolean

Optional score_prisoners

score_prisoners?: boolean

Optional score_stones

score_stones?: boolean

Optional score_territory

score_territory?: boolean

Optional score_territory_in_seki

score_territory_in_seki?: boolean

Optional server_socket

server_socket?: GobanSocket<ClientToServer, ServerToClient>

Optional spectator_log

spectator_log?: GobanChatLog

Optional square_size

square_size?: number | "auto" | ((goban) => number)

Type declaration

    • (goban): number

    • Parameters

      Returns number

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Optional start_time

start_time?: number

Optional stone_font_scale

stone_font_scale?: number

Optional strict_seki_mode

strict_seki_mode?: boolean

Optional superko_algorithm

superko_algorithm?: GobanEngineSuperKoAlgorithm

Optional throw_all_errors

throw_all_errors?: boolean

When loading initial state or moves, by default GobanEngine will try and handle bad data by just resorting to 'edit placing' moves. If this is true, then those errors are thrown instead.

Optional time_control

time_control?: JGOFTimeControl

Optional time_per_move

time_per_move?: number

Optional tournament_id

tournament_id?: number

Optional username

username?: string

Optional variation_stone_opacity

variation_stone_opacity?: number

Optional white_must_pass_last

white_must_pass_last?: boolean

Optional white_player_id

white_player_id?: number

Optional white_prisoners

white_prisoners?: number

Optional width

width?: number

Optional winner

winner?: number | "black" | "white"

Settings

Member Visibility

Theme

On This Page

aga_handicap_scoringallow_koallow_self_captureallow_superkoauthautomatic_stone_removalblack_player_idblack_prisonersboardboard_is_repeatingboundschat_logcircle_radiusclockconnect_to_chatdisable_analysisdisplay_widthdont_draw_last_movedont_show_messagesdouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegame_typegetPuzzlePlacementSettinggroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwneris_game_recordisobranch_hashkomiladderladder_idlast_move_radiuslatenciesleavePushedAnalysismalkovich_logmarksmodemove_treemovesnameneeds_sealingogsogs_importonErroronScoreEstimationUpdatedone_click_submitopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomepause_controlpaused_sincephaseplayerplayer_idplayer_poolplayerspuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typerankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekiserver_socketspectator_logsquare_sizestalling_score_estimatestart_timestone_font_scalestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetournament_idusernamevariation_stone_opacitywhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner