diff --git a/docs/classes/BoardState.html b/docs/classes/BoardState.html index 5d07b3a4..4dd0a7cc 100644 --- a/docs/classes/BoardState.html +++ b/docs/classes/BoardState.html @@ -1,4 +1,4 @@ -BoardState | goban

Class BoardState

Hierarchy (view full)

Implements

Constructors

constructor +BoardState | goban

Class BoardState

Hierarchy (view full)

Implements

Constructors

Properties

black_prisoners board board_is_repeating @@ -25,23 +25,23 @@ default to 19x19 if no board is provided.

Any state matrices (board, removal, etc..) provided will be cloned and must have the same dimensionality.

-

Parameters

Returns BoardState

Properties

black_prisoners: number
board_is_repeating: boolean
goban_callback?: GobanBase
height: number = 19
removal: boolean[][]
white_prisoners: number
width: number = 19

Methods

  • Returns true if the .board field from the other board is equal to this one

    -

    Parameters

    Returns boolean

Properties

black_prisoners: number
board_is_repeating: boolean
goban_callback?: GobanBase
height: number = 19
removal: boolean[][]
white_prisoners: number
width: number = 19

Methods

  • Returns true if the .board field from the other board is equal to this one

    +

    Parameters

    Returns boolean

  • 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

  • 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

  • Toggles a group of stones for removal or restoration.

    +

    Parameters

    • x: number
    • y: number
    • removed: boolean
    • emit_stone_removal_updated: boolean = true

    Returns void

  • 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;
    }

\ No newline at end of file +

Parameters

  • x: number
  • y: number
  • force_removal: boolean = false

Returns {
    group: RawStoneString;
    removed: boolean;
}

\ No newline at end of file diff --git a/docs/classes/ConditionalMoveTree.html b/docs/classes/ConditionalMoveTree.html index c1cb7eaa..c17fc8ec 100644 --- a/docs/classes/ConditionalMoveTree.html +++ b/docs/classes/ConditionalMoveTree.html @@ -1,4 +1,4 @@ -ConditionalMoveTree | goban

Class ConditionalMoveTree

Constructors

constructor +ConditionalMoveTree | goban

Class ConditionalMoveTree

Constructors

Properties

Constructors

Properties

children: {
    [move: string]: ConditionalMoveTree;
}

Type declaration

move: null | string

Methods

\ No newline at end of file +

Constructors

Properties

children: {
    [move: string]: ConditionalMoveTree;
}

Type declaration

move: null | string

Methods

\ No newline at end of file diff --git a/docs/classes/Goban.html b/docs/classes/Goban.html index b559491f..8674995b 100644 --- a/docs/classes/Goban.html +++ b/docs/classes/Goban.html @@ -2,7 +2,7 @@ classes, types, and enums.

You can't create an instance of a Goban directly, you have to create an instance of one of the renderers, such as GobanSVG.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

__board_redraw_pen_layer_timer: any = null
__clock_timer?: Timeout
__draw_state: string[][]
__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean
__update_move_tree: any = null
analysis_move_counter: number
analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
analysis_removal_state?: boolean
analysis_scoring_color?: string
analysis_scoring_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
bounded_height: number
bounded_width: number
bounds: GobanBounds
chat_log: GobanChatLog = []
circle_radius: number
clock_should_be_paused_for_move_submission: boolean = false
colored_circles?: (undefined | ColoredCircle)[][]
conditional_path: string = ""
conditional_starting_color: "black" | "white" | "invalid" = "invalid"
conditional_tree: ConditionalMoveTree = ...
config: GobanConfig
connectToReviewSent?: boolean
current_cmove?: ConditionalMoveTree
currently_my_cmove: boolean = false
dirty_redraw: any = null
disconnectedFromGame: boolean = true
display_width?: number
done_loading_review: boolean = false
dont_draw_last_move: boolean
double_click_submit: boolean
draw_bottom_labels: boolean
draw_left_labels: boolean
draw_right_labels: boolean
draw_top_labels: boolean
edit_color?: "black" | "white"
engine: GobanEngine
errorHandler: ((e) => void)

Type declaration

    • (e): void
    • Parameters

      • e: Error

      Returns void

game_id: number
game_type: string
getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
goban_id: number = ++last_goban_id

Base fields *

-
heatmap?: NumberMatrix
height: number
highlight_movetree_moves: boolean
interactive: boolean
isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerController: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

label_character: string
label_mark: string = "[UNSET]"
last_clock?: AdHocClock
last_emitted_clock?: JGOFClockWithTransmitting
last_hover_square?: JGOFIntersection
last_move?: MoveTree
last_move_radius: number
last_paused_by_player_state: null | boolean = null
last_paused_state: null | boolean = null
last_phase?: GobanEnginePhase
last_review_message: ReviewMessage
last_sound_played_for_a_stone_placement?: string
last_stone_sound: number
leavePushedAnalysis: (() => void)

Type declaration

    • (): void
    • Returns void

marked_analysis_score?: boolean[][]
move_selected?: JGOFIntersection
no_display: boolean
onError?: ((error) => void)

Type declaration

    • (error): void
    • Parameters

      • error: Error

      Returns void

on_game_screen: boolean
one_click_submit: boolean
original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number
    • Parameters

      Returns number

parent: HTMLElement
pause_control?: AdHocPauseControl
paused_since?: number
pen_marks: any[]
player_id: number
preloaded_data?: GobanConfig
previous_mode: string
puzzle_autoplace_delay: number
restrict_moves_to_movetree: boolean
review_had_gamedata: boolean
review_id: number
scoring_mode: boolean | "stalling-scoring-mode"
sendLatencyTimer?: Timeout
sent_timed_out_message: boolean = false
shift_key_is_down: boolean
show_move_numbers: boolean
show_variation_move_numbers: boolean
showing_scores: boolean = false
socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
square_size: number = 10
stalling_score_estimate?: StallingScoreEstimate
stone_placement_enabled: boolean
stone_removal_auto_scoring_done?: boolean = false
variation_stone_opacity: number
visual_undo_request_indicator: boolean
width: number
THEMES: ThemesInterface = THEMES
THEMES_SORTED: {
    black: GobanTheme[];
    board: GobanTheme[];
    white: GobanTheme[];
    [key: string]: GobanTheme[];
} = THEMES_SORTED

Type declaration

setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

Type declaration

    • (newCallbacks): void
    • Set's callback functions to be called in various situations. You can set any +

Constructors

Properties

__board_redraw_pen_layer_timer: any = null
__clock_timer?: Timeout
__draw_state: string[][]
__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean
__update_move_tree: any = null
analysis_move_counter: number
analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
analysis_removal_state?: boolean
analysis_scoring_color?: string
analysis_scoring_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
bounded_height: number
bounded_width: number
bounds: GobanBounds
chat_log: GobanChatLog = []
circle_radius: number
clock_should_be_paused_for_move_submission: boolean = false
colored_circles?: (undefined | ColoredCircle)[][]
conditional_path: string = ""
conditional_starting_color: "black" | "white" | "invalid" = "invalid"
conditional_tree: ConditionalMoveTree = ...
config: GobanConfig
connectToReviewSent?: boolean
current_cmove?: ConditionalMoveTree
currently_my_cmove: boolean = false
dirty_redraw: any = null
disconnectedFromGame: boolean = true
display_width?: number
done_loading_review: boolean = false
dont_draw_last_move: boolean
double_click_submit: boolean
draw_bottom_labels: boolean
draw_left_labels: boolean
draw_right_labels: boolean
draw_top_labels: boolean
edit_color?: "black" | "white"
engine: GobanEngine
errorHandler: ((e) => void)

Type declaration

    • (e): void
    • Parameters

      • e: Error

      Returns void

game_id: number
game_type: string
getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
goban_id: number = ++last_goban_id

Base fields *

+
heatmap?: NumberMatrix
height: number
highlight_movetree_moves: boolean
interactive: boolean
isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerController: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

label_character: string
label_mark: string = "[UNSET]"
last_clock?: AdHocClock
last_emitted_clock?: JGOFClockWithTransmitting
last_hover_square?: JGOFIntersection
last_move?: MoveTree
last_move_radius: number
last_paused_by_player_state: null | boolean = null
last_paused_state: null | boolean = null
last_phase?: GobanEnginePhase
last_review_message: ReviewMessage
last_sound_played_for_a_stone_placement?: string
last_stone_sound: number
leavePushedAnalysis: (() => void)

Type declaration

    • (): void
    • Returns void

marked_analysis_score?: boolean[][]
move_selected?: JGOFIntersection
no_display: boolean
onError?: ((error) => void)

Type declaration

    • (error): void
    • Parameters

      • error: Error

      Returns void

on_game_screen: boolean
one_click_submit: boolean
original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number
    • Parameters

      Returns number

parent: HTMLElement
pause_control?: AdHocPauseControl
paused_since?: number
pen_marks: any[]
player_id: number
preloaded_data?: GobanConfig
previous_mode: string
puzzle_autoplace_delay: number
restrict_moves_to_movetree: boolean
review_had_gamedata: boolean
review_id: number
scoring_mode: boolean | "stalling-scoring-mode"
sendLatencyTimer?: Timeout
sent_timed_out_message: boolean = false
shift_key_is_down: boolean
show_move_numbers: boolean
show_variation_move_numbers: boolean
showing_scores: boolean = false
socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
square_size: number = 10
stalling_score_estimate?: StallingScoreEstimate
stone_placement_enabled: boolean
stone_removal_auto_scoring_done?: boolean = false
variation_stone_opacity: number
visual_undo_request_indicator: boolean
width: number
THEMES: ThemesInterface = THEMES
THEMES_SORTED: {
    black: GobanTheme[];
    board: GobanTheme[];
    white: GobanTheme[];
    [key: string]: GobanTheme[];
} = THEMES_SORTED

Type declaration

setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

Type declaration

    • (newCallbacks): void
    • Set's callback functions to be called in various situations. You can set any or all of the callbacks, only the provided callbacks will be updated.

      -

      Parameters

      Returns void

setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

Type declaration

    • (_catalog, _debug_mode?): void
    • Parameters

      Returns void

Accessors

Methods

setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

Type declaration

    • (_catalog, _debug_mode?): void
    • Parameters

      Returns void

Accessors

Methods

\ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/docs/classes/GobanBase.html b/docs/classes/GobanBase.html index 1acb7bd3..6df4223b 100644 --- a/docs/classes/GobanBase.html +++ b/docs/classes/GobanBase.html @@ -2,7 +2,7 @@ classes, types, and enums.

You can't create an instance of a Goban directly, you have to create an instance of one of the renderers, such as GobanSVG.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Constructors

Properties

_destroyed: boolean = false
engine: GobanEngine
goban_id: number = ++last_goban_id

Base fields *

-
setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

Type declaration

    • (newCallbacks): void
    • Set's callback functions to be called in various situations. You can set any +

Constructors

Properties

_destroyed: boolean = false
engine: GobanEngine
goban_id: number = ++last_goban_id

Base fields *

+
setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

Type declaration

    • (newCallbacks): void
    • Set's callback functions to be called in various situations. You can set any or all of the callbacks, only the provided callbacks will be updated.

      -

      Parameters

      Returns void

setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

Type declaration

    • (_catalog, _debug_mode?): void
    • Parameters

      Returns void

Accessors

Methods

setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

Type declaration

    • (_catalog, _debug_mode?): void
    • Parameters

      Returns void

Accessors

Methods

\ No newline at end of file +

Parameters

Returns JGOFMove

\ No newline at end of file diff --git a/docs/classes/GobanCanvas.html b/docs/classes/GobanCanvas.html index 97d4bc12..5dab42c4 100644 --- a/docs/classes/GobanCanvas.html +++ b/docs/classes/GobanCanvas.html @@ -2,7 +2,7 @@ classes, types, and enums.

You can't create an instance of a Goban directly, you have to create an instance of one of the renderers, such as GobanSVG.

-

Hierarchy (view full)

Implements

Constructors

Hierarchy (view full)

Implements

Constructors

Properties

__board_redraw_pen_layer_timer: any = null
__borders_initialized: boolean = false
__clock_timer?: Timeout
__draw_state: string[][]
__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean
__set_board_height: number = -1
__set_board_width: number = -1
__update_move_tree: any = null
analysis_move_counter: number
analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
analysis_removal_state?: boolean
autoplaying_puzzle_move: boolean = false
board: HTMLCanvasElement
bounded_height: number
bounded_width: number
bounds: GobanBounds
byoyomi_label: string = ""
chat_log: GobanChatLog = []
circle_radius: number
clock_should_be_paused_for_move_submission: boolean = false
colored_circles?: (undefined | ColoredCircle)[][]
conditional_path: string = ""
conditional_starting_color: "black" | "white" | "invalid" = "invalid"
conditional_tree: ConditionalMoveTree = ...
config: GobanConfig
connectToReviewSent?: boolean
ctx: CanvasRenderingContext2D
current_cmove?: ConditionalMoveTree
current_pen_mark?: {
    color: string;
    points: [number, number];
}

Type declaration

  • color: string
  • points: [number, number]
currently_my_cmove: boolean = false
dirty_redraw: any = null
disconnectedFromGame: boolean = true
display_width?: number
done_loading_review: boolean = false
dont_draw_last_move: boolean
double_click_submit: boolean
draw_bottom_labels: boolean
draw_left_labels: boolean
draw_right_labels: boolean
draw_top_labels: boolean
drawing_enabled: boolean = true
edit_color?: "black" | "white"
engine: GobanEngine
errorHandler: ((e) => void)

Type declaration

    • (e): void
    • Parameters

      • e: Error

      Returns void

game_id: number
game_type: string
getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
goban_id: number = ++last_goban_id

Base fields *

-
handleShiftKey: ((ev) => void)

Type declaration

    • (ev): void
    • Parameters

      • ev: KeyboardEvent

      Returns void

heatmap?: NumberMatrix
height: number
highlight_movetree_moves: boolean
interactive: boolean
isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerController: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

label_character: string
label_mark: string = "[UNSET]"
labeling_mode?: "put" | "clear"
last_clock?: AdHocClock
last_emitted_clock?: JGOFClockWithTransmitting
last_hover_square?: JGOFIntersection
last_label_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
last_move?: MoveTree
last_move_opacity: number = 1
last_move_radius: number
last_paused_by_player_state: null | boolean = null
last_paused_state: null | boolean = null
last_pen_position?: [number, number]
last_phase?: GobanEnginePhase
last_review_message: ReviewMessage
last_sound_played_for_a_stone_placement?: string
last_stone_sound: number
leavePushedAnalysis: (() => void)

Type declaration

    • (): void
    • Returns void

marked_analysis_score?: boolean[][]
message_div?: HTMLDivElement
message_td?: HTMLElement
message_text?: HTMLDivElement
message_timeout?: number
metrics: GobanMetrics = ...
move_selected?: JGOFIntersection
move_tree_canvas?: HTMLCanvasElement
move_tree_container?: HTMLElement
move_tree_inner_container?: HTMLDivElement
no_display: boolean
onError?: ((error) => void)

Type declaration

    • (error): void
    • Parameters

      • error: Error

      Returns void

on_game_screen: boolean
one_click_submit: boolean
original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number
    • Parameters

      Returns number

parent: HTMLElement
pause_control?: AdHocPauseControl
paused_since?: number
pen_ctx?: CanvasRenderingContext2D
pen_layer?: HTMLCanvasElement
pen_marks: any[]
player_id: number
preloaded_data?: GobanConfig
previous_mode: string
puzzle_autoplace_delay: number
ready_to_draw: boolean = false
restrict_moves_to_movetree: boolean
review_had_gamedata: boolean
review_id: number
scoring_mode: boolean | "stalling-scoring-mode"
sendLatencyTimer?: Timeout
sent_timed_out_message: boolean = false
shadow_ctx?: CanvasRenderingContext2D
shadow_layer?: HTMLCanvasElement
shift_key_is_down: boolean
show_move_numbers: boolean
show_variation_move_numbers: boolean
showing_scores: boolean = false
socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
square_size: number = 10
stalling_score_estimate?: StallingScoreEstimate
stone_placement_enabled: boolean
stone_removal_auto_scoring_done?: boolean = false
theme_black: GobanTheme
theme_black_stones: any[] = []
theme_black_text_color: string = HOT_PINK
theme_blank_text_color: string = HOT_PINK
theme_board: GobanTheme
theme_faded_line_color: string = HOT_PINK
theme_faded_star_color: string = HOT_PINK
theme_line_color: string = ""
theme_star_color: string = ""
theme_stone_radius: number = 10
theme_white: GobanTheme
theme_white_stones: any[] = []
theme_white_text_color: string = HOT_PINK
themes: GobanSelectedThemes = ...
title_div?: HTMLElement
variation_stone_opacity: number
visual_undo_request_indicator: boolean
width: number
THEMES: ThemesInterface = THEMES
THEMES_SORTED: {
    black: GobanTheme[];
    board: GobanTheme[];
    white: GobanTheme[];
    [key: string]: GobanTheme[];
} = THEMES_SORTED

Type declaration

setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

Type declaration

    • (newCallbacks): void
    • Set's callback functions to be called in various situations. You can set any +

Constructors

Properties

__board_redraw_pen_layer_timer: any = null
__borders_initialized: boolean = false
__clock_timer?: Timeout
__draw_state: string[][]
__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean
__set_board_height: number = -1
__set_board_width: number = -1
__update_move_tree: any = null
analysis_move_counter: number
analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
analysis_removal_state?: boolean
autoplaying_puzzle_move: boolean = false
board: HTMLCanvasElement
bounded_height: number
bounded_width: number
bounds: GobanBounds
byoyomi_label: string = ""
chat_log: GobanChatLog = []
circle_radius: number
clock_should_be_paused_for_move_submission: boolean = false
colored_circles?: (undefined | ColoredCircle)[][]
conditional_path: string = ""
conditional_starting_color: "black" | "white" | "invalid" = "invalid"
conditional_tree: ConditionalMoveTree = ...
config: GobanConfig
connectToReviewSent?: boolean
ctx: CanvasRenderingContext2D
current_cmove?: ConditionalMoveTree
current_pen_mark?: {
    color: string;
    points: [number, number];
}

Type declaration

  • color: string
  • points: [number, number]
currently_my_cmove: boolean = false
dirty_redraw: any = null
disconnectedFromGame: boolean = true
display_width?: number
done_loading_review: boolean = false
dont_draw_last_move: boolean
double_click_submit: boolean
draw_bottom_labels: boolean
draw_left_labels: boolean
draw_right_labels: boolean
draw_top_labels: boolean
drawing_enabled: boolean = true
edit_color?: "black" | "white"
engine: GobanEngine
errorHandler: ((e) => void)

Type declaration

    • (e): void
    • Parameters

      • e: Error

      Returns void

game_id: number
game_type: string
getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
goban_id: number = ++last_goban_id

Base fields *

+
handleShiftKey: ((ev) => void)

Type declaration

    • (ev): void
    • Parameters

      • ev: KeyboardEvent

      Returns void

heatmap?: NumberMatrix
height: number
highlight_movetree_moves: boolean
interactive: boolean
isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerController: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

label_character: string
label_mark: string = "[UNSET]"
labeling_mode?: "put" | "clear"
last_clock?: AdHocClock
last_emitted_clock?: JGOFClockWithTransmitting
last_hover_square?: JGOFIntersection
last_label_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
last_move?: MoveTree
last_move_opacity: number = 1
last_move_radius: number
last_paused_by_player_state: null | boolean = null
last_paused_state: null | boolean = null
last_pen_position?: [number, number]
last_phase?: GobanEnginePhase
last_review_message: ReviewMessage
last_sound_played_for_a_stone_placement?: string
last_stone_sound: number
leavePushedAnalysis: (() => void)

Type declaration

    • (): void
    • Returns void

marked_analysis_score?: boolean[][]
message_div?: HTMLDivElement
message_td?: HTMLElement
message_text?: HTMLDivElement
message_timeout?: number
metrics: GobanMetrics = ...
move_selected?: JGOFIntersection
move_tree_canvas?: HTMLCanvasElement
move_tree_container?: HTMLElement
move_tree_inner_container?: HTMLDivElement
no_display: boolean
onError?: ((error) => void)

Type declaration

    • (error): void
    • Parameters

      • error: Error

      Returns void

on_game_screen: boolean
one_click_submit: boolean
original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number
    • Parameters

      Returns number

parent: HTMLElement
pause_control?: AdHocPauseControl
paused_since?: number
pen_ctx?: CanvasRenderingContext2D
pen_layer?: HTMLCanvasElement
pen_marks: any[]
player_id: number
preloaded_data?: GobanConfig
previous_mode: string
puzzle_autoplace_delay: number
ready_to_draw: boolean = false
restrict_moves_to_movetree: boolean
review_had_gamedata: boolean
review_id: number
scoring_mode: boolean | "stalling-scoring-mode"
sendLatencyTimer?: Timeout
sent_timed_out_message: boolean = false
shadow_ctx?: CanvasRenderingContext2D
shadow_layer?: HTMLCanvasElement
shift_key_is_down: boolean
show_move_numbers: boolean
show_variation_move_numbers: boolean
showing_scores: boolean = false
socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
square_size: number = 10
stalling_score_estimate?: StallingScoreEstimate
stone_placement_enabled: boolean
stone_removal_auto_scoring_done?: boolean = false
theme_black: GobanTheme
theme_black_stones: any[] = []
theme_black_text_color: string = HOT_PINK
theme_blank_text_color: string = HOT_PINK
theme_board: GobanTheme
theme_faded_line_color: string = HOT_PINK
theme_faded_star_color: string = HOT_PINK
theme_line_color: string = ""
theme_star_color: string = ""
theme_stone_radius: number = 10
theme_white: GobanTheme
theme_white_stones: any[] = []
theme_white_text_color: string = HOT_PINK
themes: GobanSelectedThemes = ...
title_div?: HTMLElement
variation_stone_opacity: number
visual_undo_request_indicator: boolean
width: number
THEMES: ThemesInterface = THEMES
THEMES_SORTED: {
    black: GobanTheme[];
    board: GobanTheme[];
    white: GobanTheme[];
    [key: string]: GobanTheme[];
} = THEMES_SORTED

Type declaration

setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

Type declaration

    • (newCallbacks): void
    • Set's callback functions to be called in various situations. You can set any or all of the callbacks, only the provided callbacks will be updated.

      -

      Parameters

      Returns void

setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

Type declaration

    • (_catalog, _debug_mode?): void
    • Parameters

      Returns void

Accessors

Methods

setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

Type declaration

    • (_catalog, _debug_mode?): void
    • Parameters

      Returns void

Accessors

Methods

\ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/docs/classes/GobanEngine.html b/docs/classes/GobanEngine.html index 39a8c818..f3172b3a 100644 --- a/docs/classes/GobanEngine.html +++ b/docs/classes/GobanEngine.html @@ -1,4 +1,4 @@ -GobanEngine | goban

Class GobanEngine

Hierarchy (view full)

Constructors

constructor +GobanEngine | goban

Class GobanEngine

Hierarchy (view full)

Constructors

Properties

_cur_move: MoveTree
_cur_review_move: undefined | MoveTree
_last_official_move: MoveTree
_outcome: string = ""
_phase: GobanEnginePhase = "play"
_rules: GobanEngineRules = "japanese"
_strict_seki_mode: boolean = false
_undo_requested?: number
_winner?: number | "black" | "white"
aga_handicap_scoring: boolean = false
allow_ko: boolean = false
allow_self_capture: boolean = false
allow_superko: boolean = false
automatic_stone_removal: boolean = false
black_prisoners: number
board_is_repeating: boolean
decoded_moves: JGOFMove[] = []
disable_analysis: boolean = false
dontStoreBoardHistory: boolean
free_handicap_placement: boolean = false
game_id: number = NaN
goban_callback?: GobanBase
group_ids?: number[]
handicap: number = NaN
handicap_rank_difference?: number
height: number = 19
initial_state: GobanEngineInitialState = ...
komi: number = NaN
latencies?: {
    [player_id: string]: number;
}

Type declaration

  • [player_id: string]: number
loading_sgf: boolean = false
move_before_jump?: MoveTree
move_tree: MoveTree
move_tree_layout_dirty: boolean = false
move_tree_layout_hash: {
    [coords: string]: MoveTree;
} = {}

Type declaration

move_tree_layout_vector: number[] = []
name: string = ""
needs_sealing?: JGOFSealingIntersection[]
parentEventEmitter?: EventEmitter<GobanEvents, any>
player_pool: {
    [id: number]: GobanEnginePlayerEntry;
}

Type declaration

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

Type declaration

puzzle_collection: number = NaN
puzzle_description: string = "[missing puzzle description]"
puzzle_opponent_move_mode: PuzzleOpponentMoveMode = "manual"
puzzle_player_move_mode: PuzzlePlayerMoveMode = "free"
puzzle_rank: number = NaN
puzzle_type: string = "[missing puzzle type]"
removal: boolean[][]
rengo?: boolean
rengo_casual_mode: boolean
rengo_teams?: {
    [colour: string]: GobanEnginePlayerEntry[];
}

Type declaration

review_id?: number
score_handicap: boolean = false
score_prisoners: boolean = false
score_stones: boolean = false
score_territory: boolean = false
score_territory_in_seki: boolean = false
stalling_score_estimate?: StallingScoreEstimate
superko_algorithm: GobanEngineSuperKoAlgorithm = "psk"
territory_included_in_sgf: boolean = false
throw_all_errors?: boolean
time_control: JGOFTimeControl = ...
white_prisoners: number
width: number = 19

Accessors

  • get winner(): undefined | number | "black" | "white"
  • Returns undefined | number | "black" | "white"

  • set winner(winner): void
  • Parameters

    • winner: undefined | number | "black" | "white"

    Returns void

Methods

  • Returns {
        black: string;
        white: string;
    }

    • black: string
    • white: string
  • Computes the score of the current board state.

    +

Constructors

Properties

_cur_move: MoveTree
_cur_review_move: undefined | MoveTree
_last_official_move: MoveTree
_outcome: string = ""
_phase: GobanEnginePhase = "play"
_rules: GobanEngineRules = "japanese"
_strict_seki_mode: boolean = false
_undo_requested?: number
_winner?: number | "black" | "white"
aga_handicap_scoring: boolean = false
allow_ko: boolean = false
allow_self_capture: boolean = false
allow_superko: boolean = false
automatic_stone_removal: boolean = false
black_prisoners: number
board_is_repeating: boolean
decoded_moves: JGOFMove[] = []
disable_analysis: boolean = false
dontStoreBoardHistory: boolean
free_handicap_placement: boolean = false
game_id: number = NaN
goban_callback?: GobanBase
group_ids?: number[]
handicap: number = NaN
handicap_rank_difference?: number
height: number = 19
initial_state: GobanEngineInitialState = ...
komi: number = NaN
latencies?: {
    [player_id: string]: number;
}

Type declaration

  • [player_id: string]: number
loading_sgf: boolean = false
move_before_jump?: MoveTree
move_tree: MoveTree
move_tree_layout_dirty: boolean = false
move_tree_layout_hash: {
    [coords: string]: MoveTree;
} = {}

Type declaration

move_tree_layout_vector: number[] = []
name: string = ""
needs_sealing?: JGOFSealingIntersection[]
parentEventEmitter?: EventEmitter<GobanEvents, any>
player_pool: {
    [id: number]: GobanEnginePlayerEntry;
}

Type declaration

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

Type declaration

puzzle_collection: number = NaN
puzzle_description: string = "[missing puzzle description]"
puzzle_opponent_move_mode: PuzzleOpponentMoveMode = "manual"
puzzle_player_move_mode: PuzzlePlayerMoveMode = "free"
puzzle_rank: number = NaN
puzzle_type: string = "[missing puzzle type]"
removal: boolean[][]
rengo?: boolean
rengo_casual_mode: boolean
rengo_teams?: {
    [colour: string]: GobanEnginePlayerEntry[];
}

Type declaration

review_id?: number
score_handicap: boolean = false
score_prisoners: boolean = false
score_stones: boolean = false
score_territory: boolean = false
score_territory_in_seki: boolean = false
stalling_score_estimate?: StallingScoreEstimate
superko_algorithm: GobanEngineSuperKoAlgorithm = "psk"
territory_included_in_sgf: boolean = false
throw_all_errors?: boolean
time_control: JGOFTimeControl = ...
white_prisoners: number
width: number = 19

Accessors

  • get winner(): undefined | number | "black" | "white"
  • Returns undefined | number | "black" | "white"

  • set winner(winner): void
  • Parameters

    • winner: undefined | number | "black" | "white"

    Returns void

Methods

  • Returns {
        black: string;
        white: string;
    }

    • black: string
    • white: string
  • 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

  • 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

  • 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[]

  • Returns a move string from the given official move number (aka branch point)

    -

    Returns {
        from: number;
        moves: string;
    }

    • from: number
    • moves: string
  • 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[]

  • Returns a move string from the given official move number (aka branch point)

    +

    Returns {
        from: number;
        moves: string;
    }

    • from: number
    • moves: string
  • returns true if our current move is our last official move

    -

    Returns boolean

  • returns true if our current move is our last official move

    +

    Returns boolean

  • 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

  • Parameters

    • Optional player_id: number

    Returns "black" | "white" | "invalid"

  • Encodes an x,y pair or a move object like {x: 0, y: 0} into a move string like "A1"

    -

    Parameters

    Returns string

  • Parameters

    • x: number
    • y: number

    Returns string

  • Saves our current move as our last official move

    -

    Returns void

  • Parameters

    • x: number
    • y: number
    • Optional needs_sealing: boolean

    Returns void

  • Sets a position as being removed or not removed. If +

    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

  • Parameters

    • Optional player_id: number

    Returns "black" | "white" | "invalid"

  • Encodes an x,y pair or a move object like {x: 0, y: 0} into a move string like "A1"

    +

    Parameters

    Returns string

  • Parameters

    • x: number
    • y: number

    Returns string

  • Saves our current move as our last official move

    +

    Returns void

  • Parameters

    • x: number
    • y: number
    • Optional needs_sealing: boolean

    Returns 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

  • Toggles a group of stones for removal or restoration.

    +

    Parameters

    • x: number
    • y: number
    • removed: boolean
    • emit_stone_removal_updated: boolean = true

    Returns void

  • 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;
    }

\ No newline at end of file +

Parameters

Returns GobanEngineConfig

\ No newline at end of file diff --git a/docs/classes/GobanError.html b/docs/classes/GobanError.html index 494c156b..26ea853c 100644 --- a/docs/classes/GobanError.html +++ b/docs/classes/GobanError.html @@ -1,2 +1,2 @@ -GobanError | goban

Class GobanError

Hierarchy (view full)

Constructors

Constructors

\ No newline at end of file +GobanError | goban

Class GobanError

Hierarchy (view full)

Constructors

Constructors

\ No newline at end of file diff --git a/docs/classes/GobanInteractive.html b/docs/classes/GobanInteractive.html index 52c13018..aec4b96c 100644 --- a/docs/classes/GobanInteractive.html +++ b/docs/classes/GobanInteractive.html @@ -1,7 +1,7 @@ GobanInteractive | goban

Class GobanInteractiveAbstract

This class serves as a functionality layer encapsulating core interactions we do with a Goban, we have it as a separate base class simply to help with code organization and to keep our Goban class size down.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

__board_redraw_pen_layer_timer: any = null
__clock_timer?: Timeout
__draw_state: string[][]
__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean
__update_move_tree: any = null
_analyze_subtool: string = "alternate"
_analyze_tool: AnalysisTool = "stone"
_mode: GobanModes = "play"
_review_controller_id?: number
_review_owner_id?: number
_score_estimator: null | ScoreEstimator = null
_submit_move?: (() => void)

Type declaration

    • (): void
    • Returns void

_title: string = "play"
analysis_move_counter: number
analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
analysis_removal_state?: boolean
bounded_height: number
bounded_width: number
bounds: GobanBounds
chat_log: GobanChatLog = []
circle_radius: number
clock_should_be_paused_for_move_submission: boolean = false
colored_circles?: (undefined | ColoredCircle)[][]
conditional_path: string = ""
conditional_starting_color: "black" | "white" | "invalid" = "invalid"
conditional_tree: ConditionalMoveTree = ...
config: GobanConfig
current_cmove?: ConditionalMoveTree
currently_my_cmove: boolean = false
dirty_redraw: any = null
disconnectedFromGame: boolean = true
display_width?: number
done_loading_review: boolean = false
dont_draw_last_move: boolean
double_click_submit: boolean
draw_bottom_labels: boolean
draw_left_labels: boolean
draw_right_labels: boolean
draw_top_labels: boolean
edit_color?: "black" | "white"
engine: GobanEngine
errorHandler: ((e) => void)

Type declaration

    • (e): void
    • Parameters

      • e: Error

      Returns void

game_id: number
game_type: string
getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
goban_id: number = ++last_goban_id

Base fields *

-
heatmap?: NumberMatrix
height: number
highlight_movetree_moves: boolean
interactive: boolean
isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerController: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

label_character: string
label_mark: string = "[UNSET]"
last_clock?: AdHocClock
last_emitted_captured_stones: JGOFIntersection[] = []
last_emitted_clock?: JGOFClockWithTransmitting
last_hover_square?: JGOFIntersection
last_move?: MoveTree
last_move_radius: number
last_paused_by_player_state: null | boolean = null
last_paused_state: null | boolean = null
last_phase?: GobanEnginePhase
last_review_message: ReviewMessage
last_sound_played_for_a_stone_placement?: string
last_stone_sound: number
leavePushedAnalysis: (() => void)

Type declaration

    • (): void
    • Returns void

marked_analysis_score?: boolean[][]
move_selected?: JGOFIntersection
no_display: boolean
onError?: ((error) => void)

Type declaration

    • (error): void
    • Parameters

      • error: Error

      Returns void

on_game_screen: boolean
one_click_submit: boolean
original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number
    • Parameters

      Returns number

pause_control?: AdHocPauseControl
paused_since?: number
pen_marks: any[]
player_id: number
preloaded_data?: GobanConfig
previous_mode: string
puzzle_autoplace_delay: number
restrict_moves_to_movetree: boolean
review_had_gamedata: boolean
review_id: number
scoring_mode: boolean | "stalling-scoring-mode"
sendLatencyTimer?: Timeout
sent_timed_out_message: boolean
shift_key_is_down: boolean
show_move_numbers: boolean
show_variation_move_numbers: boolean
showing_scores: boolean = false
square_size: number = 10
stalling_score_estimate?: StallingScoreEstimate
stone_placement_enabled: boolean
stone_removal_auto_scoring_done?: boolean = false
variation_stone_opacity: number
visual_undo_request_indicator: boolean
width: number
setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

Type declaration

    • (newCallbacks): void
    • Set's callback functions to be called in various situations. You can set any +

Constructors

Properties

__board_redraw_pen_layer_timer: any = null
__clock_timer?: Timeout
__draw_state: string[][]
__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean
__update_move_tree: any = null
_analyze_subtool: string = "alternate"
_analyze_tool: AnalysisTool = "stone"
_mode: GobanModes = "play"
_review_controller_id?: number
_review_owner_id?: number
_score_estimator: null | ScoreEstimator = null
_submit_move?: (() => void)

Type declaration

    • (): void
    • Returns void

_title: string = "play"
analysis_move_counter: number
analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number
analysis_removal_state?: boolean
bounded_height: number
bounded_width: number
bounds: GobanBounds
chat_log: GobanChatLog = []
circle_radius: number
clock_should_be_paused_for_move_submission: boolean = false
colored_circles?: (undefined | ColoredCircle)[][]
conditional_path: string = ""
conditional_starting_color: "black" | "white" | "invalid" = "invalid"
conditional_tree: ConditionalMoveTree = ...
config: GobanConfig
current_cmove?: ConditionalMoveTree
currently_my_cmove: boolean = false
dirty_redraw: any = null
disconnectedFromGame: boolean = true
display_width?: number
done_loading_review: boolean = false
dont_draw_last_move: boolean
double_click_submit: boolean
draw_bottom_labels: boolean
draw_left_labels: boolean
draw_right_labels: boolean
draw_top_labels: boolean
edit_color?: "black" | "white"
engine: GobanEngine
errorHandler: ((e) => void)

Type declaration

    • (e): void
    • Parameters

      • e: Error

      Returns void

game_id: number
game_type: string
getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
goban_id: number = ++last_goban_id

Base fields *

+
heatmap?: NumberMatrix
height: number
highlight_movetree_moves: boolean
interactive: boolean
isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerController: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

label_character: string
label_mark: string = "[UNSET]"
last_clock?: AdHocClock
last_emitted_captured_stones: JGOFIntersection[] = []
last_emitted_clock?: JGOFClockWithTransmitting
last_hover_square?: JGOFIntersection
last_move?: MoveTree
last_move_radius: number
last_paused_by_player_state: null | boolean = null
last_paused_state: null | boolean = null
last_phase?: GobanEnginePhase
last_review_message: ReviewMessage
last_sound_played_for_a_stone_placement?: string
last_stone_sound: number
leavePushedAnalysis: (() => void)

Type declaration

    • (): void
    • Returns void

marked_analysis_score?: boolean[][]
move_selected?: JGOFIntersection
no_display: boolean
onError?: ((error) => void)

Type declaration

    • (error): void
    • Parameters

      • error: Error

      Returns void

on_game_screen: boolean
one_click_submit: boolean
original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number
    • Parameters

      Returns number

pause_control?: AdHocPauseControl
paused_since?: number
pen_marks: any[]
player_id: number
preloaded_data?: GobanConfig
previous_mode: string
puzzle_autoplace_delay: number
restrict_moves_to_movetree: boolean
review_had_gamedata: boolean
review_id: number
scoring_mode: boolean | "stalling-scoring-mode"
sendLatencyTimer?: Timeout
sent_timed_out_message: boolean
shift_key_is_down: boolean
show_move_numbers: boolean
show_variation_move_numbers: boolean
showing_scores: boolean = false
square_size: number = 10
stalling_score_estimate?: StallingScoreEstimate
stone_placement_enabled: boolean
stone_removal_auto_scoring_done?: boolean = false
variation_stone_opacity: number
visual_undo_request_indicator: boolean
width: number
setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

Type declaration

    • (newCallbacks): void
    • Set's callback functions to be called in various situations. You can set any or all of the callbacks, only the provided callbacks will be updated.

      -

      Parameters

      Returns void

setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

Type declaration

    • (_catalog, _debug_mode?): void
    • Parameters

      Returns void

Accessors

  • get destroyed(): boolean
  • Returns boolean

Methods

  • Decodes any of the various ways we express moves that we've accumulated over the years into +

    Parameters

    Returns void

setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

Type declaration

    • (_catalog, _debug_mode?): void
    • Parameters

      Returns void

Accessors

  • get destroyed(): boolean
  • Returns boolean

Methods

  • 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

  • Parameters

    • x: number
    • y: number
    • mark: string
    • Optional drawSquare: boolean

    Returns void

  • Parameters

    • perGameSettingAppliesToNonPlayers: boolean = false

    Returns boolean

  • Parameters

    • x: number
    • y: number
    • mark: string
    • Optional drawSquare: boolean

    Returns void

  • Parameters

    • perGameSettingAppliesToNonPlayers: boolean = false

    Returns boolean

  • Goban calls some abstract methods as part of the construction process. Because our subclasses might (and do) need to do some of their own config before these are called, we set this function to be called by our subclass after it's done it's own internal config stuff.

    -

    Returns GobanEngine

  • Parameters

    • colored_marks: {
          [key: string]: {
              color: string;
              move: string;
          };
      }
      • [key: string]: {
            color: string;
            move: string;
        }
        • color: string
        • move: string

    Returns void

  • Parameters

    • x: number
    • y: number
    • mark: string
    • Optional drawSquare: boolean

    Returns void

  • Called when a location is marked or unmarked for removal

    -

    Parameters

    • x: number
    • y: number
    • removed: boolean
    • emit_stone_removal_updated: boolean = true

    Returns void

  • Parameters

    • Optional set_override: "letters" | "numbers"

    Returns void

  • Parameters

    • x: number
    • y: number
    • mark: string
    • Optional drawSquare: boolean

    Returns void

  • Parameters

    • x: number
    • y: number
    • mark: string | number
    • Optional dont_draw: boolean

    Returns void

  • Parameters

    • coordinates: string
    • mark: string | number
    • Optional dont_draw: boolean

    Returns void

  • Parameters

    • colored_marks: {
          [key: string]: {
              color: string;
              move: string;
          };
      }
      • [key: string]: {
            color: string;
            move: string;
        }
        • color: string
        • move: string

    Returns void

  • Parameters

    • x: number
    • y: number
    • mark: string
    • Optional drawSquare: boolean

    Returns void

  • Called when a location is marked or unmarked for removal

    +

    Parameters

    • x: number
    • y: number
    • removed: boolean
    • emit_stone_removal_updated: boolean = true

    Returns void

  • Parameters

    • Optional set_override: "letters" | "numbers"

    Returns void

  • Parameters

    • x: number
    • y: number
    • mark: string
    • Optional drawSquare: boolean

    Returns void

  • Parameters

    • x: number
    • y: number
    • mark: string | number
    • Optional dont_draw: boolean

    Returns void

  • Parameters

    • coordinates: string
    • mark: string | number
    • Optional dont_draw: boolean

    Returns void

  • This is a callback that gets called by GobanEngine.getState to save and board state as it pushes and pops state. Our renderers can override this to save state they need.

    -

    Parameters

    • marks: {
          [mark: string]: string;
      }
      • [mark: string]: string
    • Optional dont_draw: boolean

    Returns void

  • Parameters

    • x: number
    • y: number
    • mark: string
    • drawSquare: boolean = true

    Returns void

  • Parameters

    • Optional dont_jump_to_official_move: boolean

    Returns boolean

  • Parameters

    • x: number
    • y: number
    • mark: string | number
    • Optional dont_draw: boolean

    Returns void

  • Parameters

    • msg_id: MessageID
    • Optional parameters: {
          [key: string]: any;
      }
      • [key: string]: any
    • Optional timeout: number

    Returns void

  • Parameters

    • x: number
    • y: number
    • mark: string | number
    • Optional force_label: boolean
    • Optional force_put: boolean

    Returns boolean

  • Parameters

    • x: number
    • y: number
    • anti_slip: boolean = true

    Returns {
        i: number;
        j: number;
        valid: boolean;
    }

    • i: number
    • j: number
    • valid: boolean
\ No newline at end of file +

Parameters

Returns void

\ No newline at end of file diff --git a/docs/classes/GobanMoveError.html b/docs/classes/GobanMoveError.html index 6f6dd0a1..6fda7b85 100644 --- a/docs/classes/GobanMoveError.html +++ b/docs/classes/GobanMoveError.html @@ -1,6 +1,6 @@ -GobanMoveError | goban

Class GobanMoveError

Hierarchy (view full)

Constructors

constructor +GobanMoveError | goban

Class GobanMoveError

Hierarchy (view full)

Constructors

Properties

coords: string
game_id: number
move_number: number
\ No newline at end of file +

Constructors

Properties

coords: string
game_id: number
move_number: number
\ No newline at end of file diff --git a/docs/classes/GobanSocket.html b/docs/classes/GobanSocket.html index 37f8d71e..5e442c5e 100644 --- a/docs/classes/GobanSocket.html +++ b/docs/classes/GobanSocket.html @@ -8,7 +8,7 @@
  • Optional promise support for sends
  • Latency tracking (doubling as keep alive)
  • -

    Type Parameters

    Hierarchy

    Constructors

    Type Parameters

    Hierarchy

    Constructors

    Properties

    authentication?: DataArgument<SendProtocol["authenticate"]>
    callbacks: Map<number, ((data?, error?) => void)> = ...

    Type declaration

      • (data?, error?): void
      • Parameters

        Returns void

    clock_drift: number = 0.0
    current_ping_interval: number
    last_request_id: number = 0
    latency: number = 0.0
    manually_disconnected: boolean = false
    ping_timer?: Timeout
    promises_in_flight: Map<number, {
        args: any[];
        command: string;
        reject: ((...args) => void);
        resolve: ((...args) => void);
    }> = ...

    Type declaration

    • args: any[]
    • command: string
    • reject: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • resolve: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    reconnect_tries: number = 0
    reconnecting: boolean = false
    send_queue: (() => void)[] = []

    Type declaration

      • (): void
      • Returns void

    socket: WebSocket
    timeout_timer?: Timeout
    url: string

    Accessors

    Methods

    \ No newline at end of file +

    Constructors

    Properties

    authentication?: DataArgument<SendProtocol["authenticate"]>
    callbacks: Map<number, ((data?, error?) => void)> = ...

    Type declaration

      • (data?, error?): void
      • Parameters

        Returns void

    clock_drift: number = 0.0
    current_ping_interval: number
    last_request_id: number = 0
    latency: number = 0.0
    manually_disconnected: boolean = false
    ping_timer?: Timeout
    promises_in_flight: Map<number, {
        args: any[];
        command: string;
        reject: ((...args) => void);
        resolve: ((...args) => void);
    }> = ...

    Type declaration

    • args: any[]
    • command: string
    • reject: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • resolve: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    reconnect_tries: number = 0
    reconnecting: boolean = false
    send_queue: (() => void)[] = []

    Type declaration

      • (): void
      • Returns void

    socket: WebSocket
    timeout_timer?: Timeout
    url: string

    Accessors

    Methods

    \ No newline at end of file diff --git a/docs/classes/GobanTheme.html b/docs/classes/GobanTheme.html index 56691131..e1f2a363 100644 --- a/docs/classes/GobanTheme.html +++ b/docs/classes/GobanTheme.html @@ -1,4 +1,4 @@ -GobanTheme | goban

    Class GobanTheme

    Constructors

    constructor +GobanTheme | goban

    Class GobanTheme

    Constructors

    Properties

    Constructors

    Properties

    name: string
    parent?: GobanTheme
    styles: {
        [style_name: string]: string;
    } = {}

    Type declaration

    • [style_name: string]: string

    Accessors

    Methods

    • Parameters

      • ctx: CanvasRenderingContext2D
      • _shadow_ctx: null | CanvasRenderingContext2D
      • _stone: any
      • cx: number
      • cy: number
      • radius: number

      Returns void

    • Parameters

      • cell: SVGGraphicsElement
      • shadow_cell: undefined | SVGGraphicsElement
      • stone: string
      • cx: number
      • cy: number
      • radius: number

      Returns [SVGElement, undefined | SVGElement]

    • Parameters

      • cell: SVGGraphicsElement
      • shadow_cell: undefined | SVGGraphicsElement
      • stone: string
      • cx: number
      • cy: number
      • radius: number
      • shadow_circle_color: string

      Returns [SVGElement, undefined | SVGElement]

    • Parameters

      • shadow_cell: undefined | SVGGraphicsElement
      • cx: number
      • cy: number
      • radius: number
      • color: string

      Returns undefined | SVGElement

    • Parameters

      • ctx: CanvasRenderingContext2D
      • _shadow_ctx: null | CanvasRenderingContext2D
      • _stone: any
      • cx: number
      • cy: number
      • radius: number

      Returns void

    • Parameters

      • cell: SVGGraphicsElement
      • shadow_cell: undefined | SVGGraphicsElement
      • stone: string
      • cx: number
      • cy: number
      • radius: number

      Returns [SVGElement, undefined | SVGElement]

    • Parameters

      • _radius: number
      • _seed: number
      • _deferredRenderCallback: (() => void)
          • (): void
          • Returns void

      Returns any

    • Parameters

      • defs: SVGDefsElement
      • radius: number
      • _seed: number
      • _deferredRenderCallback: (() => void)
          • (): void
          • Returns void

      Returns string[]

    • Parameters

      • _radius: number
      • _seed: number
      • _deferredRenderCallback: (() => void)
          • (): void
          • Returns void

      Returns any

    • Parameters

      • defs: SVGDefsElement
      • radius: number
      • _seed: number
      • _deferredRenderCallback: (() => void)
          • (): void
          • Returns void

      Returns string[]

    \ No newline at end of file +

    Constructors

    Properties

    name: string
    parent?: GobanTheme
    styles: {
        [style_name: string]: string;
    } = {}

    Type declaration

    • [style_name: string]: string

    Accessors

    Methods

    • Parameters

      • ctx: CanvasRenderingContext2D
      • _shadow_ctx: null | CanvasRenderingContext2D
      • _stone: any
      • cx: number
      • cy: number
      • radius: number

      Returns void

    • Parameters

      • cell: SVGGraphicsElement
      • shadow_cell: undefined | SVGGraphicsElement
      • stone: string
      • cx: number
      • cy: number
      • radius: number

      Returns [SVGElement, undefined | SVGElement]

    • Parameters

      • cell: SVGGraphicsElement
      • shadow_cell: undefined | SVGGraphicsElement
      • stone: string
      • cx: number
      • cy: number
      • radius: number
      • shadow_circle_color: string

      Returns [SVGElement, undefined | SVGElement]

    • Parameters

      • shadow_cell: undefined | SVGGraphicsElement
      • cx: number
      • cy: number
      • radius: number
      • color: string

      Returns undefined | SVGElement

    • Parameters

      • ctx: CanvasRenderingContext2D
      • _shadow_ctx: null | CanvasRenderingContext2D
      • _stone: any
      • cx: number
      • cy: number
      • radius: number

      Returns void

    • Parameters

      • cell: SVGGraphicsElement
      • shadow_cell: undefined | SVGGraphicsElement
      • stone: string
      • cx: number
      • cy: number
      • radius: number

      Returns [SVGElement, undefined | SVGElement]

    • Parameters

      • _radius: number
      • _seed: number
      • _deferredRenderCallback: (() => void)
          • (): void
          • Returns void

      Returns any

    • Parameters

      • defs: SVGDefsElement
      • radius: number
      • _seed: number
      • _deferredRenderCallback: (() => void)
          • (): void
          • Returns void

      Returns string[]

    • Parameters

      • _radius: number
      • _seed: number
      • _deferredRenderCallback: (() => void)
          • (): void
          • Returns void

      Returns any

    • Parameters

      • defs: SVGDefsElement
      • radius: number
      • _seed: number
      • _deferredRenderCallback: (() => void)
          • (): void
          • Returns void

      Returns string[]

    \ No newline at end of file diff --git a/docs/classes/MoveTree.html b/docs/classes/MoveTree.html index 5be0e556..b4d5ca37 100644 --- a/docs/classes/MoveTree.html +++ b/docs/classes/MoveTree.html @@ -1,4 +1,4 @@ -MoveTree | goban

    Class MoveTree

    Constructors

    constructor +MoveTree | goban

    Class MoveTree

    Constructors

    Properties

    active_path_number: number = 0
    branches: MoveTree[]
    chat_log?: MoveTreeChatLine[]
    correct_answer: boolean = false
    edited: boolean
    engine: GobanEngine
    hint_next?: MoveTree
    id: number
    isobranch_hash?: string
    isobranches: any
    label: string = "[unset]"
    label_metrics?: any
    layout_cx: number = 0
    layout_cy: number = 0
    layout_x: number = 0
    layout_y: number = 0
    line_color: number
    marks?: MarkInterface[][]
    move_number: number
    parent: null | MoveTree
    pen_marks: MoveTreePenMarks = []
    played_by: undefined | number
    player_update: undefined | JGOFPlayerSummary
    pretty_coordinates: string
    stashed_marks: MarkInterface[][][] = []
    text: string
    trunk: boolean
    trunk_next?: MoveTree
    wrong_answer: boolean = false
    x: number
    y: number
    active_path_number: number = 0

    ** Layout & Rendering ***

    -
    current_line_color: number = 0
    isobranch_colors: {
        strong: string;
        weak: string;
    } = ...

    Type declaration

    • strong: string
    • weak: string
    line_colors: string[] = ...
    stone_padding: 3 = 3
    stone_radius: 11 = 11
    stone_square_size: number = ...

    Accessors

    • get stoneColor(): "black" | "white" | "empty"
    • Returns "black" | "white" | "empty"

    Methods

    • Calls a callback for each positions that has a mark on it

      -

      Parameters

      • fn: ((i, j) => void)
          • (i, j): void
          • Parameters

            • i: number
            • j: number

            Returns void

      Returns void

    • Returns true if there are any marks that have been set

      -

      Returns boolean

    • Parameters

      • x: number
      • min_y: number
      • layout_hash: {
            [coords: string]: MoveTree;
        }
      • line_color: number

      Returns number

    • Loads the state of this MoveTree node from a MoveTreeJson object

      -

      Parameters

      Returns void

    • Recomputes the isobranches for the entire tree. This needs to be called on the root node.

      -

      Returns void

    • Saves the current marks in our stash, restore them with popMarks

      -

      Returns void

    \ No newline at end of file +

    Constructors

    Properties

    active_path_number: number = 0
    branches: MoveTree[]
    chat_log?: MoveTreeChatLine[]
    correct_answer: boolean = false
    edited: boolean
    engine: GobanEngine
    hint_next?: MoveTree
    id: number
    isobranch_hash?: string
    isobranches: any
    label: string = "[unset]"
    label_metrics?: any
    layout_cx: number = 0
    layout_cy: number = 0
    layout_x: number = 0
    layout_y: number = 0
    line_color: number
    marks?: MarkInterface[][]
    move_number: number
    parent: null | MoveTree
    pen_marks: MoveTreePenMarks = []
    played_by: undefined | number
    player_update: undefined | JGOFPlayerSummary
    pretty_coordinates: string
    stashed_marks: MarkInterface[][][] = []
    text: string
    trunk: boolean
    trunk_next?: MoveTree
    wrong_answer: boolean = false
    x: number
    y: number
    active_path_number: number = 0

    ** Layout & Rendering ***

    +
    current_line_color: number = 0
    isobranch_colors: {
        strong: string;
        weak: string;
    } = ...

    Type declaration

    • strong: string
    • weak: string
    line_colors: string[] = ...
    stone_padding: 3 = 3
    stone_radius: 11 = 11
    stone_square_size: number = ...

    Accessors

    • get stoneColor(): "black" | "white" | "empty"
    • Returns "black" | "white" | "empty"

    Methods

    • Calls a callback for each positions that has a mark on it

      +

      Parameters

      • fn: ((i, j) => void)
          • (i, j): void
          • Parameters

            • i: number
            • j: number

            Returns void

      Returns void

    • Returns true if there are any marks that have been set

      +

      Returns boolean

    • Parameters

      • x: number
      • min_y: number
      • layout_hash: {
            [coords: string]: MoveTree;
        }
      • line_color: number

      Returns number

    • Loads the state of this MoveTree node from a MoveTreeJson object

      +

      Parameters

      Returns void

    • Recomputes the isobranches for the entire tree. This needs to be called on the root node.

      +

      Returns void

    • Saves the current marks in our stash, restore them with popMarks

      +

      Returns void

    \ No newline at end of file diff --git a/docs/classes/SVGRenderer.html b/docs/classes/SVGRenderer.html index b2efc8e9..bf2342cc 100644 --- a/docs/classes/SVGRenderer.html +++ b/docs/classes/SVGRenderer.html @@ -2,7 +2,7 @@ classes, types, and enums.

    You can't create an instance of a Goban directly, you have to create an instance of one of the renderers, such as GobanSVG.

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    __board_redraw_pen_layer_timer: any = null
    __clock_timer?: Timeout
    __draw_state: string[][]
    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean
    __set_board_height: number = -1
    __set_board_width: number = -1
    __update_move_tree: any = null
    analysis_move_counter: number
    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number
    analysis_removal_state?: boolean
    autoplaying_puzzle_move: boolean = false
    bounded_height: number
    bounded_width: number
    bounds: GobanBounds
    byoyomi_label: string = ""
    chat_log: GobanChatLog = []
    circle_radius: number
    clock_should_be_paused_for_move_submission: boolean = false
    colored_circles?: (undefined | ColoredCircle)[][]
    conditional_path: string = ""
    conditional_starting_color: "black" | "white" | "invalid" = "invalid"
    conditional_tree: ConditionalMoveTree = ...
    config: GobanConfig
    connectToReviewSent?: boolean
    coordinate_labels_layer?: SVGGraphicsElement
    current_cmove?: ConditionalMoveTree
    current_pen_mark?: {
        color: string;
        points: [number, number];
    }

    Type declaration

    • color: string
    • points: [number, number]
    currently_my_cmove: boolean = false
    dirty_redraw: any = null
    disconnectedFromGame: boolean = true
    display_width?: number
    done_loading_review: boolean = false
    dont_draw_last_move: boolean
    double_click_submit: boolean
    draw_bottom_labels: boolean
    draw_left_labels: boolean
    draw_right_labels: boolean
    draw_top_labels: boolean
    drawing_enabled: boolean = true
    edit_color?: "black" | "white"
    engine: GobanEngine
    errorHandler: ((e) => void)

    Type declaration

      • (e): void
      • Parameters

        • e: Error

        Returns void

    event_layer: HTMLDivElement
    game_id: number
    game_type: string
    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
    goban_id: number = ++last_goban_id

    Base fields *

    -
    grid: SVGGraphicsElement[][] = []
    grid_layer?: SVGGraphicsElement
    handleShiftKey: ((ev) => void)

    Type declaration

      • (ev): void
      • Parameters

        • ev: KeyboardEvent

        Returns void

    heatmap?: NumberMatrix
    height: number
    highlight_movetree_moves: boolean
    interactive: boolean
    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    label_character: string
    label_mark: string = "[UNSET]"
    labeling_mode?: "put" | "clear"
    last_clock?: AdHocClock
    last_emitted_clock?: JGOFClockWithTransmitting
    last_hover_square?: JGOFIntersection
    last_label_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number
    last_move?: MoveTree
    last_move_opacity: number = 1
    last_move_radius: number
    last_paused_by_player_state: null | boolean = null
    last_paused_state: null | boolean = null
    last_pen_position?: [number, number]
    last_phase?: GobanEnginePhase
    last_review_message: ReviewMessage
    last_sound_played_for_a_stone_placement?: string
    last_stone_sound: number
    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void
      • Returns void

    lines_layer?: SVGGraphicsElement
    marked_analysis_score?: boolean[][]
    message_div?: HTMLDivElement
    message_td?: HTMLElement
    message_text?: HTMLDivElement
    message_timeout?: number
    metrics: GobanMetrics = ...
    move_selected?: JGOFIntersection
    move_tree_container?: HTMLElement
    move_tree_inner_container?: HTMLDivElement
    move_tree_svg?: SVGElement
    no_display: boolean
    onError?: ((error) => void)

    Type declaration

      • (error): void
      • Parameters

        • error: Error

        Returns void

    on_game_screen: boolean
    one_click_submit: boolean
    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    parent: HTMLElement
    pause_control?: AdHocPauseControl
    paused_since?: number
    pen_layer?: SVGGraphicsElement
    pen_marks: any[]
    player_id: number
    preloaded_data?: GobanConfig
    previous_mode: string
    puzzle_autoplace_delay: number
    ready_to_draw: boolean = false
    restrict_moves_to_movetree: boolean
    review_had_gamedata: boolean
    review_id: number
    scoring_mode: boolean | "stalling-scoring-mode"
    sendLatencyTimer?: Timeout
    sent_timed_out_message: boolean = false
    shadow_grid: (undefined | SVGElement)[][] = []
    shadow_layer?: SVGGraphicsElement
    shift_key_is_down: boolean
    show_move_numbers: boolean
    show_variation_move_numbers: boolean
    showing_scores: boolean = false
    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
    square_size: number = 10
    stalling_score_estimate?: StallingScoreEstimate
    stone_placement_enabled: boolean
    stone_removal_auto_scoring_done?: boolean = false
    svg: SVGElement
    svg_defs: SVGDefsElement
    theme_black: GobanTheme
    theme_black_stones: any[] = []
    theme_black_text_color: string = HOT_PINK
    theme_blank_text_color: string = HOT_PINK
    theme_board: GobanTheme
    theme_faded_line_color: string = HOT_PINK
    theme_faded_star_color: string = HOT_PINK
    theme_line_color: string = ""
    theme_star_color: string = ""
    theme_stone_radius: number = 10
    theme_white: GobanTheme
    theme_white_stones: any[] = []
    theme_white_text_color: string = HOT_PINK
    themes: GobanSelectedThemes = ...
    title_div?: HTMLElement
    variation_stone_opacity: number
    visual_undo_request_indicator: boolean
    width: number
    THEMES: ThemesInterface = THEMES
    THEMES_SORTED: {
        black: GobanTheme[];
        board: GobanTheme[];
        white: GobanTheme[];
        [key: string]: GobanTheme[];
    } = THEMES_SORTED

    Type declaration

    setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

    Type declaration

      • (newCallbacks): void
      • Set's callback functions to be called in various situations. You can set any +

    Constructors

    Properties

    __board_redraw_pen_layer_timer: any = null
    __clock_timer?: Timeout
    __draw_state: string[][]
    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean
    __set_board_height: number = -1
    __set_board_width: number = -1
    __update_move_tree: any = null
    analysis_move_counter: number
    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number
    analysis_removal_state?: boolean
    autoplaying_puzzle_move: boolean = false
    bounded_height: number
    bounded_width: number
    bounds: GobanBounds
    byoyomi_label: string = ""
    chat_log: GobanChatLog = []
    circle_radius: number
    clock_should_be_paused_for_move_submission: boolean = false
    colored_circles?: (undefined | ColoredCircle)[][]
    conditional_path: string = ""
    conditional_starting_color: "black" | "white" | "invalid" = "invalid"
    conditional_tree: ConditionalMoveTree = ...
    config: GobanConfig
    connectToReviewSent?: boolean
    coordinate_labels_layer?: SVGGraphicsElement
    current_cmove?: ConditionalMoveTree
    current_pen_mark?: {
        color: string;
        points: [number, number];
    }

    Type declaration

    • color: string
    • points: [number, number]
    currently_my_cmove: boolean = false
    dirty_redraw: any = null
    disconnectedFromGame: boolean = true
    display_width?: number
    done_loading_review: boolean = false
    dont_draw_last_move: boolean
    double_click_submit: boolean
    draw_bottom_labels: boolean
    draw_left_labels: boolean
    draw_right_labels: boolean
    draw_top_labels: boolean
    drawing_enabled: boolean = true
    edit_color?: "black" | "white"
    engine: GobanEngine
    errorHandler: ((e) => void)

    Type declaration

      • (e): void
      • Parameters

        • e: Error

        Returns void

    event_layer: HTMLDivElement
    game_id: number
    game_type: string
    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
    goban_id: number = ++last_goban_id

    Base fields *

    +
    grid: SVGGraphicsElement[][] = []
    grid_layer?: SVGGraphicsElement
    handleShiftKey: ((ev) => void)

    Type declaration

      • (ev): void
      • Parameters

        • ev: KeyboardEvent

        Returns void

    heatmap?: NumberMatrix
    height: number
    highlight_movetree_moves: boolean
    interactive: boolean
    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    label_character: string
    label_mark: string = "[UNSET]"
    labeling_mode?: "put" | "clear"
    last_clock?: AdHocClock
    last_emitted_clock?: JGOFClockWithTransmitting
    last_hover_square?: JGOFIntersection
    last_label_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number
    last_move?: MoveTree
    last_move_opacity: number = 1
    last_move_radius: number
    last_paused_by_player_state: null | boolean = null
    last_paused_state: null | boolean = null
    last_pen_position?: [number, number]
    last_phase?: GobanEnginePhase
    last_review_message: ReviewMessage
    last_sound_played_for_a_stone_placement?: string
    last_stone_sound: number
    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void
      • Returns void

    lines_layer?: SVGGraphicsElement
    marked_analysis_score?: boolean[][]
    message_div?: HTMLDivElement
    message_td?: HTMLElement
    message_text?: HTMLDivElement
    message_timeout?: number
    metrics: GobanMetrics = ...
    move_selected?: JGOFIntersection
    move_tree_container?: HTMLElement
    move_tree_inner_container?: HTMLDivElement
    move_tree_svg?: SVGElement
    no_display: boolean
    onError?: ((error) => void)

    Type declaration

      • (error): void
      • Parameters

        • error: Error

        Returns void

    on_game_screen: boolean
    one_click_submit: boolean
    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    parent: HTMLElement
    pause_control?: AdHocPauseControl
    paused_since?: number
    pen_layer?: SVGGraphicsElement
    pen_marks: any[]
    player_id: number
    preloaded_data?: GobanConfig
    previous_mode: string
    puzzle_autoplace_delay: number
    ready_to_draw: boolean = false
    restrict_moves_to_movetree: boolean
    review_had_gamedata: boolean
    review_id: number
    scoring_mode: boolean | "stalling-scoring-mode"
    sendLatencyTimer?: Timeout
    sent_timed_out_message: boolean = false
    shadow_grid: (undefined | SVGElement)[][] = []
    shadow_layer?: SVGGraphicsElement
    shift_key_is_down: boolean
    show_move_numbers: boolean
    show_variation_move_numbers: boolean
    showing_scores: boolean = false
    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
    square_size: number = 10
    stalling_score_estimate?: StallingScoreEstimate
    stone_placement_enabled: boolean
    stone_removal_auto_scoring_done?: boolean = false
    svg: SVGElement
    svg_defs: SVGDefsElement
    theme_black: GobanTheme
    theme_black_stones: any[] = []
    theme_black_text_color: string = HOT_PINK
    theme_blank_text_color: string = HOT_PINK
    theme_board: GobanTheme
    theme_faded_line_color: string = HOT_PINK
    theme_faded_star_color: string = HOT_PINK
    theme_line_color: string = ""
    theme_star_color: string = ""
    theme_stone_radius: number = 10
    theme_white: GobanTheme
    theme_white_stones: any[] = []
    theme_white_text_color: string = HOT_PINK
    themes: GobanSelectedThemes = ...
    title_div?: HTMLElement
    variation_stone_opacity: number
    visual_undo_request_indicator: boolean
    width: number
    THEMES: ThemesInterface = THEMES
    THEMES_SORTED: {
        black: GobanTheme[];
        board: GobanTheme[];
        white: GobanTheme[];
        [key: string]: GobanTheme[];
    } = THEMES_SORTED

    Type declaration

    setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

    Type declaration

      • (newCallbacks): void
      • Set's callback functions to be called in various situations. You can set any or all of the callbacks, only the provided callbacks will be updated.

        -

        Parameters

        Returns void

    setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

    Type declaration

      • (_catalog, _debug_mode?): void
      • Parameters

        Returns void

    Accessors

    Methods

    setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

    Type declaration

      • (_catalog, _debug_mode?): void
      • Parameters

        Returns void

    Accessors

    Methods

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/classes/ScoreEstimator.html b/docs/classes/ScoreEstimator.html index d34697a2..d6d32e2a 100644 --- a/docs/classes/ScoreEstimator.html +++ b/docs/classes/ScoreEstimator.html @@ -1,4 +1,4 @@ -ScoreEstimator | goban

    Class ScoreEstimator

    Hierarchy (view full)

    Constructors

    constructor +ScoreEstimator | goban

    Class ScoreEstimator

    Hierarchy (view full)

    Constructors

    Properties

    amount: number = NaN
    autoscore: boolean = false
    autoscored_needs_sealing?: JGOFSealingIntersection[]
    autoscored_removed?: JGOFMove[]
    autoscored_state?: JGOFNumericPlayerColor[][]
    black: PlayerScore = ...
    black_prisoners: number
    board_is_repeating: boolean
    color_to_move: "black" | "white"
    engine: GobanEngine
    estimated_hard_score: number
    goban_callback?: GobanBase
    height: number = 19
    ownership: number[][]
    prefer_remote: boolean
    removal: boolean[][]
    territory: number[][]
    tolerance: number
    trials: number
    when_ready: Promise<void>
    white: PlayerScore = ...
    white_prisoners: number
    width: number = 19
    winner: string = ""

    Methods

    • Computes scoring locations for the board. If area_scoring is true, we +

    Constructors

    Properties

    amount: number = NaN
    autoscore: boolean = false
    autoscored_needs_sealing?: JGOFSealingIntersection[]
    autoscored_removed?: JGOFMove[]
    autoscored_state?: JGOFNumericPlayerColor[][]
    black: PlayerScore = ...
    black_prisoners: number
    board_is_repeating: boolean
    color_to_move: "black" | "white"
    engine: GobanEngine
    estimated_hard_score: number
    goban_callback?: GobanBase
    height: number = 19
    ownership: number[][]
    prefer_remote: boolean
    removal: boolean[][]
    territory: number[][]
    tolerance: number
    trials: number
    when_ready: Promise<void>
    white: PlayerScore = ...
    white_prisoners: number
    width: number = 19
    winner: string = ""

    Methods

    • Parameters

      • trials: number
      • tolerance: number
      • autoscore: boolean

      Returns Promise<void>

    • Parameters

      • trials: number
      • tolerance: number

      Returns Promise<void>

    • Parameters

      • trials: number
      • tolerance: number
      • autoscore: boolean

      Returns Promise<void>

    • Parameters

      • trials: number
      • tolerance: number

      Returns Promise<void>

    • Parameters

      • i: number
      • j: number
      • mod_key: boolean
      • press_duration_ms: number

      Returns void

    • Parameters

      • i: number
      • j: number
      • mod_key: boolean
      • press_duration_ms: number

      Returns 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

      Returns void

    • 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;
      }

    • Parameters

      • estimated_score: number
      • ownership: number[][]
      • Optional score: number

      Returns void

    \ No newline at end of file +

    Parameters

    Returns {
        group: RawStoneString;
        removed: boolean;
    }

    \ No newline at end of file diff --git a/docs/classes/StoneString.html b/docs/classes/StoneString.html index 2153afca..14b6970b 100644 --- a/docs/classes/StoneString.html +++ b/docs/classes/StoneString.html @@ -1,6 +1,6 @@ StoneString | goban

    Class StoneString

    A StoneString instance represents a group of intersections that are connected to each other and are all the same color.

    -

    Constructors

    Constructors

    Properties

    Constructors

    Properties

    __added_neighbors: {
        [group_id: number]: boolean;
    }

    Type declaration

    • [group_id: number]: boolean
    id: number
    intersections: JGOFIntersection[]
    is_territory: boolean = false
    neighboring_space: StoneString[]
    neighboring_stone_strings: StoneString[]
    neighbors: StoneString[]
    territory_color: JGOFNumericPlayerColor = 0

    Methods

    • Adds a stone string to our neighbor list. This should probably only be called by StoneStringBuilder.

      -

      Parameters

      Returns void

    • Add a stone to the group. This should probably only be called by StoneStringBuilder.

      -

      Parameters

      • x: number
      • y: number

      Returns void

    • Compute if this string is considered potential territory (if all of it's +

    Constructors

    Properties

    __added_neighbors: {
        [group_id: number]: boolean;
    }

    Type declaration

    • [group_id: number]: boolean
    id: number
    intersections: JGOFIntersection[]
    is_territory: boolean = false
    neighboring_space: StoneString[]
    neighboring_stone_strings: StoneString[]
    neighbors: StoneString[]
    territory_color: JGOFNumericPlayerColor = 0

    Methods

    • Adds a stone string to our neighbor list. This should probably only be called by StoneStringBuilder.

      +

      Parameters

      Returns void

    • Add a stone to the group. This should probably only be called by StoneStringBuilder.

      +

      Parameters

      • x: number
      • y: number

      Returns void

    • Compute if this string is considered potential territory (if all of it's neighbors are the same color). NOTE: This does not perform any advanced logic to determine seki status or anything like that, this only looks to see if the string contains EMPTY locations and that all of the surrounding neighboring are the same color. This should probably only be called by StoneStringBuilder.

      -

      Returns void

    • Parameters

      • fn: ((stone_string) => void)
          • (stone_string): void
          • Parameters

            Returns void

      Returns void

    • Parameters

      • fn: ((stone_string) => void)
          • (stone_string): void
          • Parameters

            Returns void

      Returns void

    • Parameters

      • fn: ((stone_string) => void)
          • (stone_string): void
          • Parameters

            Returns void

      Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/classes/StoneStringBuilder.html b/docs/classes/StoneStringBuilder.html index 75f9e8c6..1d303c7c 100644 --- a/docs/classes/StoneStringBuilder.html +++ b/docs/classes/StoneStringBuilder.html @@ -1,7 +1,7 @@ -StoneStringBuilder | goban

    Class StoneStringBuilder

    Constructors

    constructor +StoneStringBuilder | goban

    Class StoneStringBuilder

    Constructors

    Properties

    state: BoardState
    stone_string_id_map: number[][]
    stone_strings: StoneString[]

    Methods

    \ No newline at end of file +

    Constructors

    Properties

    state: BoardState
    stone_string_id_map: number[][]
    stone_strings: StoneString[]

    Methods

    \ No newline at end of file diff --git a/docs/classes/TestGoban.html b/docs/classes/TestGoban.html index 390e2dbc..049d46b4 100644 --- a/docs/classes/TestGoban.html +++ b/docs/classes/TestGoban.html @@ -1,5 +1,5 @@ TestGoban | goban

    Class TestGoban

    This is a minimal implementation of Goban, primarily used for unit tests.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    __board_redraw_pen_layer_timer: any = null
    __clock_timer?: Timeout
    __draw_state: string[][]
    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean
    __update_move_tree: any = null
    analysis_move_counter: number
    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number
    analysis_removal_state?: boolean
    bounded_height: number
    bounded_width: number
    bounds: GobanBounds
    chat_log: GobanChatLog = []
    circle_radius: number
    clock_should_be_paused_for_move_submission: boolean = false
    colored_circles?: (undefined | ColoredCircle)[][]
    conditional_path: string = ""
    conditional_starting_color: "black" | "white" | "invalid" = "invalid"
    conditional_tree: ConditionalMoveTree = ...
    config: GobanConfig
    connectToReviewSent?: boolean
    current_cmove?: ConditionalMoveTree
    currently_my_cmove: boolean = false
    dirty_redraw: any = null
    disconnectedFromGame: boolean = true
    display_width?: number
    done_loading_review: boolean = false
    dont_draw_last_move: boolean
    double_click_submit: boolean
    draw_bottom_labels: boolean
    draw_left_labels: boolean
    draw_right_labels: boolean
    draw_top_labels: boolean
    edit_color?: "black" | "white"
    engine: GobanEngine
    errorHandler: ((e) => void)

    Type declaration

      • (e): void
      • Parameters

        • e: Error

        Returns void

    game_id: number
    game_type: string
    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
    goban_id: number = ++last_goban_id

    Base fields *

    -
    heatmap?: NumberMatrix
    height: number
    highlight_movetree_moves: boolean
    interactive: boolean
    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    label_character: string
    label_mark: string = "[UNSET]"
    last_clock?: AdHocClock
    last_emitted_clock?: JGOFClockWithTransmitting
    last_hover_square?: JGOFIntersection
    last_move?: MoveTree
    last_move_radius: number
    last_paused_by_player_state: null | boolean = null
    last_paused_state: null | boolean = null
    last_phase?: GobanEnginePhase
    last_review_message: ReviewMessage
    last_sound_played_for_a_stone_placement?: string
    last_stone_sound: number
    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void
      • Returns void

    marked_analysis_score?: boolean[][]
    move_selected?: JGOFIntersection
    no_display: boolean
    onError?: ((error) => void)

    Type declaration

      • (error): void
      • Parameters

        • error: Error

        Returns void

    on_game_screen: boolean
    one_click_submit: boolean
    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    parent: HTMLElement
    pause_control?: AdHocPauseControl
    paused_since?: number
    pen_marks: any[]
    player_id: number
    preloaded_data?: GobanConfig
    previous_mode: string
    puzzle_autoplace_delay: number
    restrict_moves_to_movetree: boolean
    review_had_gamedata: boolean
    review_id: number
    scoring_mode: boolean | "stalling-scoring-mode"
    sendLatencyTimer?: Timeout
    sent_timed_out_message: boolean = false
    shift_key_is_down: boolean
    show_move_numbers: boolean
    show_variation_move_numbers: boolean
    showing_scores: boolean = false
    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
    square_size: number = 10
    stalling_score_estimate?: StallingScoreEstimate
    stone_placement_enabled: boolean
    stone_removal_auto_scoring_done?: boolean = false
    variation_stone_opacity: number
    visual_undo_request_indicator: boolean
    width: number
    THEMES: ThemesInterface = THEMES
    THEMES_SORTED: {
        black: GobanTheme[];
        board: GobanTheme[];
        white: GobanTheme[];
        [key: string]: GobanTheme[];
    } = THEMES_SORTED

    Type declaration

    setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

    Type declaration

      • (newCallbacks): void
      • Set's callback functions to be called in various situations. You can set any +

    Constructors

    Properties

    __board_redraw_pen_layer_timer: any = null
    __clock_timer?: Timeout
    __draw_state: string[][]
    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean
    __update_move_tree: any = null
    analysis_move_counter: number
    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number
    analysis_removal_state?: boolean
    bounded_height: number
    bounded_width: number
    bounds: GobanBounds
    chat_log: GobanChatLog = []
    circle_radius: number
    clock_should_be_paused_for_move_submission: boolean = false
    colored_circles?: (undefined | ColoredCircle)[][]
    conditional_path: string = ""
    conditional_starting_color: "black" | "white" | "invalid" = "invalid"
    conditional_tree: ConditionalMoveTree = ...
    config: GobanConfig
    connectToReviewSent?: boolean
    current_cmove?: ConditionalMoveTree
    currently_my_cmove: boolean = false
    dirty_redraw: any = null
    disconnectedFromGame: boolean = true
    display_width?: number
    done_loading_review: boolean = false
    dont_draw_last_move: boolean
    double_click_submit: boolean
    draw_bottom_labels: boolean
    draw_left_labels: boolean
    draw_right_labels: boolean
    draw_top_labels: boolean
    edit_color?: "black" | "white"
    engine: GobanEngine
    errorHandler: ((e) => void)

    Type declaration

      • (e): void
      • Parameters

        • e: Error

        Returns void

    game_id: number
    game_type: string
    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
    goban_id: number = ++last_goban_id

    Base fields *

    +
    heatmap?: NumberMatrix
    height: number
    highlight_movetree_moves: boolean
    interactive: boolean
    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    label_character: string
    label_mark: string = "[UNSET]"
    last_clock?: AdHocClock
    last_emitted_clock?: JGOFClockWithTransmitting
    last_hover_square?: JGOFIntersection
    last_move?: MoveTree
    last_move_radius: number
    last_paused_by_player_state: null | boolean = null
    last_paused_state: null | boolean = null
    last_phase?: GobanEnginePhase
    last_review_message: ReviewMessage
    last_sound_played_for_a_stone_placement?: string
    last_stone_sound: number
    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void
      • Returns void

    marked_analysis_score?: boolean[][]
    move_selected?: JGOFIntersection
    no_display: boolean
    onError?: ((error) => void)

    Type declaration

      • (error): void
      • Parameters

        • error: Error

        Returns void

    on_game_screen: boolean
    one_click_submit: boolean
    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    parent: HTMLElement
    pause_control?: AdHocPauseControl
    paused_since?: number
    pen_marks: any[]
    player_id: number
    preloaded_data?: GobanConfig
    previous_mode: string
    puzzle_autoplace_delay: number
    restrict_moves_to_movetree: boolean
    review_had_gamedata: boolean
    review_id: number
    scoring_mode: boolean | "stalling-scoring-mode"
    sendLatencyTimer?: Timeout
    sent_timed_out_message: boolean = false
    shift_key_is_down: boolean
    show_move_numbers: boolean
    show_variation_move_numbers: boolean
    showing_scores: boolean = false
    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
    square_size: number = 10
    stalling_score_estimate?: StallingScoreEstimate
    stone_placement_enabled: boolean
    stone_removal_auto_scoring_done?: boolean = false
    variation_stone_opacity: number
    visual_undo_request_indicator: boolean
    width: number
    THEMES: ThemesInterface = THEMES
    THEMES_SORTED: {
        black: GobanTheme[];
        board: GobanTheme[];
        white: GobanTheme[];
        [key: string]: GobanTheme[];
    } = THEMES_SORTED

    Type declaration

    setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

    Type declaration

      • (newCallbacks): void
      • Set's callback functions to be called in various situations. You can set any or all of the callbacks, only the provided callbacks will be updated.

        -

        Parameters

        Returns void

    setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

    Type declaration

      • (_catalog, _debug_mode?): void
      • Parameters

        Returns void

    Accessors

    • get analyze_subtool(): string
    • Returns string

    • set analyze_subtool(analyze_subtool): void
    • Parameters

      • analyze_subtool: string

      Returns void

    • get destroyed(): boolean
    • Returns boolean

    • get review_controller_id(): undefined | number
    • Returns undefined | number

    • set review_controller_id(review_controller_id): void
    • Parameters

      • review_controller_id: undefined | number

      Returns void

    • get review_owner_id(): undefined | number
    • Returns undefined | number

    • set review_owner_id(review_owner_id): void
    • Parameters

      • review_owner_id: undefined | number

      Returns void

    • get submit_move(): undefined | (() => void)
    • Returns undefined | (() => void)

    • set submit_move(submit_move): void
    • Parameters

      • submit_move: undefined | (() => void)

      Returns void

    Methods

    • Decodes any of the various ways we express moves that we've accumulated over the years into +

      Parameters

      Returns void

    setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

    Type declaration

      • (_catalog, _debug_mode?): void
      • Parameters

        Returns void

    Accessors

    • get analyze_subtool(): string
    • Returns string

    • set analyze_subtool(analyze_subtool): void
    • Parameters

      • analyze_subtool: string

      Returns void

    • get destroyed(): boolean
    • Returns boolean

    • get review_controller_id(): undefined | number
    • Returns undefined | number

    • set review_controller_id(review_controller_id): void
    • Parameters

      • review_controller_id: undefined | number

      Returns void

    • get review_owner_id(): undefined | number
    • Returns undefined | number

    • set review_owner_id(review_owner_id): void
    • Parameters

      • review_owner_id: undefined | number

      Returns void

    • get submit_move(): undefined | (() => void)
    • Returns undefined | (() => void)

    • set submit_move(submit_move): void
    • Parameters

      • submit_move: undefined | (() => void)

      Returns void

    Methods

    • 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

    • Marks scores on the board when in analysis mode. Note: this will not clear existing scores, this is intentional as I think it's the expected behavior of reviewers

      -

      Returns void

    • Goban calls some abstract methods as part of the construction process. Because our subclasses might (and do) need to do some of their own config before these are called, we set this function to be called by our subclass after it's done it's own internal config stuff.

      -

      Returns GobanEngine

    • When we think our clock has runout, send a message to the server letting it know. Otherwise we have to wait for the server grace period to expire for it to time us out.

      -

      Returns void

    • Parameters

      • colored_marks: {
            [key: string]: {
                color: string;
                move: string;
            };
        }
        • [key: string]: {
              color: string;
              move: string;
          }
          • color: string
          • move: string

      Returns void

    • Called when a location is marked or unmarked for removal

      -

      Parameters

      • x: number
      • y: number
      • removed: boolean
      • emit_stone_removal_updated: boolean = true

      Returns void

    • Parameters

      • colored_marks: {
            [key: string]: {
                color: string;
                move: string;
            };
        }
        • [key: string]: {
              color: string;
              move: string;
          }
          • color: string
          • move: string

      Returns void

    • Called when a location is marked or unmarked for removal

      +

      Parameters

      • x: number
      • y: number
      • removed: boolean
      • emit_stone_removal_updated: boolean = true

      Returns void

    • This is a callback that gets called by GobanEngine.getState to save and board state as it pushes and pops state. Our renderers can override this to save state they need.

      -

      Parameters

      • marks: {
            [mark: string]: string;
        }
        • [mark: string]: string
      • Optional dont_draw: boolean

      Returns void

    • This is a callback that gets called by GobanEngine.setState to load +

      Parameters

      • marks: {
            [mark: string]: string;
        }
        • [mark: string]: string
      • Optional dont_draw: boolean

      Returns void

    • Parameters

      • msg_id: MessageID
      • Optional parameters: {
            [key: string]: any;
        }
        • [key: string]: any
      • Optional timeout: number

      Returns void

    • Parameters

      • x: number
      • y: number
      • mark: string | number
      • Optional force_label: boolean
      • Optional force_put: boolean

      Returns boolean

    • Parameters

      • x: number
      • y: number
      • anti_slip: boolean = true

      Returns {
          i: number;
          j: number;
          valid: boolean;
      }

      • i: number
      • j: number
      • valid: boolean
    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/classes/_internal_.OGSConnectivity.html b/docs/classes/_internal_.OGSConnectivity.html index db5a32f0..b739a9ac 100644 --- a/docs/classes/_internal_.OGSConnectivity.html +++ b/docs/classes/_internal_.OGSConnectivity.html @@ -2,7 +2,7 @@ that manages connections to the online-go.com servers.

    We have it as a separate base class simply to help with code organization and to keep our Goban class size down.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    __board_redraw_pen_layer_timer: any = null
    __clock_timer?: Timeout
    __draw_state: string[][]
    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean
    __update_move_tree: any = null
    analysis_move_counter: number
    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number
    analysis_removal_state?: boolean
    bounded_height: number
    bounded_width: number
    bounds: GobanBounds
    chat_log: GobanChatLog = []
    circle_radius: number
    clock_should_be_paused_for_move_submission: boolean = false
    colored_circles?: (undefined | ColoredCircle)[][]
    conditional_path: string = ""
    conditional_starting_color: "black" | "white" | "invalid" = "invalid"
    conditional_tree: ConditionalMoveTree = ...
    config: GobanConfig
    connectToReviewSent?: boolean
    current_cmove?: ConditionalMoveTree
    currently_my_cmove: boolean = false
    dirty_redraw: any = null
    disconnectedFromGame: boolean = true
    display_width?: number
    done_loading_review: boolean = false
    dont_draw_last_move: boolean
    double_click_submit: boolean
    draw_bottom_labels: boolean
    draw_left_labels: boolean
    draw_right_labels: boolean
    draw_top_labels: boolean
    edit_color?: "black" | "white"
    engine: GobanEngine
    errorHandler: ((e) => void)

    Type declaration

      • (e): void
      • Parameters

        • e: Error

        Returns void

    game_id: number
    game_type: string
    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
    goban_id: number = ++last_goban_id

    Base fields *

    -
    heatmap?: NumberMatrix
    height: number
    highlight_movetree_moves: boolean
    interactive: boolean
    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    label_character: string
    label_mark: string = "[UNSET]"
    last_clock?: AdHocClock
    last_emitted_clock?: JGOFClockWithTransmitting
    last_hover_square?: JGOFIntersection
    last_move?: MoveTree
    last_move_radius: number
    last_paused_by_player_state: null | boolean = null
    last_paused_state: null | boolean = null
    last_phase?: GobanEnginePhase
    last_review_message: ReviewMessage
    last_sound_played_for_a_stone_placement?: string
    last_stone_sound: number
    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void
      • Returns void

    marked_analysis_score?: boolean[][]
    move_selected?: JGOFIntersection
    no_display: boolean
    onError?: ((error) => void)

    Type declaration

      • (error): void
      • Parameters

        • error: Error

        Returns void

    on_game_screen: boolean
    one_click_submit: boolean
    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    pause_control?: AdHocPauseControl
    paused_since?: number
    pen_marks: any[]
    player_id: number
    preloaded_data?: GobanConfig
    previous_mode: string
    puzzle_autoplace_delay: number
    restrict_moves_to_movetree: boolean
    review_had_gamedata: boolean
    review_id: number
    scoring_mode: boolean | "stalling-scoring-mode"
    sendLatencyTimer?: Timeout
    sent_timed_out_message: boolean = false
    shift_key_is_down: boolean
    show_move_numbers: boolean
    show_variation_move_numbers: boolean
    showing_scores: boolean = false
    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
    square_size: number = 10
    stalling_score_estimate?: StallingScoreEstimate
    stone_placement_enabled: boolean
    stone_removal_auto_scoring_done?: boolean = false
    variation_stone_opacity: number
    visual_undo_request_indicator: boolean
    width: number
    setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

    Type declaration

      • (newCallbacks): void
      • Set's callback functions to be called in various situations. You can set any +

    Constructors

    Properties

    __board_redraw_pen_layer_timer: any = null
    __clock_timer?: Timeout
    __draw_state: string[][]
    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean
    __update_move_tree: any = null
    analysis_move_counter: number
    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number
    analysis_removal_state?: boolean
    bounded_height: number
    bounded_width: number
    bounds: GobanBounds
    chat_log: GobanChatLog = []
    circle_radius: number
    clock_should_be_paused_for_move_submission: boolean = false
    colored_circles?: (undefined | ColoredCircle)[][]
    conditional_path: string = ""
    conditional_starting_color: "black" | "white" | "invalid" = "invalid"
    conditional_tree: ConditionalMoveTree = ...
    config: GobanConfig
    connectToReviewSent?: boolean
    current_cmove?: ConditionalMoveTree
    currently_my_cmove: boolean = false
    dirty_redraw: any = null
    disconnectedFromGame: boolean = true
    display_width?: number
    done_loading_review: boolean = false
    dont_draw_last_move: boolean
    double_click_submit: boolean
    draw_bottom_labels: boolean
    draw_left_labels: boolean
    draw_right_labels: boolean
    draw_top_labels: boolean
    edit_color?: "black" | "white"
    engine: GobanEngine
    errorHandler: ((e) => void)

    Type declaration

      • (e): void
      • Parameters

        • e: Error

        Returns void

    game_id: number
    game_type: string
    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)
    goban_id: number = ++last_goban_id

    Base fields *

    +
    heatmap?: NumberMatrix
    height: number
    highlight_movetree_moves: boolean
    interactive: boolean
    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    label_character: string
    label_mark: string = "[UNSET]"
    last_clock?: AdHocClock
    last_emitted_clock?: JGOFClockWithTransmitting
    last_hover_square?: JGOFIntersection
    last_move?: MoveTree
    last_move_radius: number
    last_paused_by_player_state: null | boolean = null
    last_paused_state: null | boolean = null
    last_phase?: GobanEnginePhase
    last_review_message: ReviewMessage
    last_sound_played_for_a_stone_placement?: string
    last_stone_sound: number
    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void
      • Returns void

    marked_analysis_score?: boolean[][]
    move_selected?: JGOFIntersection
    no_display: boolean
    onError?: ((error) => void)

    Type declaration

      • (error): void
      • Parameters

        • error: Error

        Returns void

    on_game_screen: boolean
    one_click_submit: boolean
    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    pause_control?: AdHocPauseControl
    paused_since?: number
    pen_marks: any[]
    player_id: number
    preloaded_data?: GobanConfig
    previous_mode: string
    puzzle_autoplace_delay: number
    restrict_moves_to_movetree: boolean
    review_had_gamedata: boolean
    review_id: number
    scoring_mode: boolean | "stalling-scoring-mode"
    sendLatencyTimer?: Timeout
    sent_timed_out_message: boolean = false
    shift_key_is_down: boolean
    show_move_numbers: boolean
    show_variation_move_numbers: boolean
    showing_scores: boolean = false
    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []
    square_size: number = 10
    stalling_score_estimate?: StallingScoreEstimate
    stone_placement_enabled: boolean
    stone_removal_auto_scoring_done?: boolean = false
    variation_stone_opacity: number
    visual_undo_request_indicator: boolean
    width: number
    setCallbacks: ((newCallbacks) => void) = setGobanCallbacks

    Type declaration

      • (newCallbacks): void
      • Set's callback functions to be called in various situations. You can set any or all of the callbacks, only the provided callbacks will be updated.

        -

        Parameters

        Returns void

    setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

    Type declaration

      • (_catalog, _debug_mode?): void
      • Parameters

        Returns void

    Accessors

    Methods

    setTranslations: ((_catalog, _debug_mode?) => void) = setGobanTranslations

    Type declaration

      • (_catalog, _debug_mode?): void
      • Parameters

        Returns void

    Accessors

    Methods

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/enums/JGOFNumericPlayerColor.html b/docs/enums/JGOFNumericPlayerColor.html index 1cc405df..684b1866 100644 --- a/docs/enums/JGOFNumericPlayerColor.html +++ b/docs/enums/JGOFNumericPlayerColor.html @@ -1,4 +1,4 @@ -JGOFNumericPlayerColor | goban

    Enumeration JGOFNumericPlayerColor

    Enumeration Members

    BLACK +JGOFNumericPlayerColor | goban

    Enumeration JGOFNumericPlayerColor

    Enumeration Members

    Enumeration Members

    BLACK: 1
    EMPTY: 0
    WHITE: 2
    \ No newline at end of file +

    Enumeration Members

    BLACK: 1
    EMPTY: 0
    WHITE: 2
    \ No newline at end of file diff --git a/docs/enums/protocol.RemoteStorageReplication.html b/docs/enums/protocol.RemoteStorageReplication.html index 95be7382..ec009057 100644 --- a/docs/enums/protocol.RemoteStorageReplication.html +++ b/docs/enums/protocol.RemoteStorageReplication.html @@ -1,13 +1,13 @@ RemoteStorageReplication | goban

    Enumeration RemoteStorageReplication

    This enum defines the various replication strategies for the remote storage system. For more details on the remote storage replication system see: https://github.com/online-go/online-go.com/blob/devel/src/lib/data.ts

    -

    Enumeration Members

    Enumeration Members

    LOCAL_OVERWRITES_REMOTE: 1

    Locally set data will overwrite remotely set data, but if not set will default to remotely set data

    -
    NONE: 0

    No replication of this change

    -
    REMOTE_ONLY: 4

    Remotely set data, but do not update our local value

    -
    REMOTE_OVERWRITES_LOCAL: 2

    Remotely set data will overwrite locally set data

    -
    \ No newline at end of file +
    NONE: 0

    No replication of this change

    +
    REMOTE_ONLY: 4

    Remotely set data, but do not update our local value

    +
    REMOTE_OVERWRITES_LOCAL: 2

    Remotely set data will overwrite locally set data

    +
    \ No newline at end of file diff --git a/docs/functions/adjust_estimate.html b/docs/functions/adjust_estimate.html index e9e88bf6..a5423237 100644 --- a/docs/functions/adjust_estimate.html +++ b/docs/functions/adjust_estimate.html @@ -4,4 +4,4 @@
  • area_map: number[][]

    Representation of the ownership, 1=Black, -1=White, 0=Undecided using Area rules

  • score: number

    estimated score (not accounting for captures)

    -
  • Returns {
        ownership: Matrix<number>;
        score: number;
    }

    \ No newline at end of file +

    Returns {
        ownership: Matrix<number>;
        score: number;
    }

    \ No newline at end of file diff --git a/docs/functions/allocateCanvasOrError.html b/docs/functions/allocateCanvasOrError.html index 87312c2a..0d7d98ac 100644 --- a/docs/functions/allocateCanvasOrError.html +++ b/docs/functions/allocateCanvasOrError.html @@ -5,4 +5,4 @@

    If string dimensions are used we'll use setAttribute, if numbers are used we'll set the canvas .width and .height parameter. This is for device scaling considerations when the given dimensions are scaled on HDPI devices.

    -

    Parameters

    Returns HTMLCanvasElement

    \ No newline at end of file +

    Parameters

    Returns HTMLCanvasElement

    \ No newline at end of file diff --git a/docs/functions/autoscore.html b/docs/functions/autoscore.html index 683e0054..a11666f0 100644 --- a/docs/functions/autoscore.html +++ b/docs/functions/autoscore.html @@ -1 +1 @@ -autoscore | goban

    Function autoscore

    \ No newline at end of file +autoscore | goban

    Function autoscore

    \ No newline at end of file diff --git a/docs/functions/char2num.html b/docs/functions/char2num.html index 06b1be1a..9ede8ed1 100644 --- a/docs/functions/char2num.html +++ b/docs/functions/char2num.html @@ -1 +1 @@ -char2num | goban

    Function char2num

    \ No newline at end of file +char2num | goban

    Function char2num

    \ No newline at end of file diff --git a/docs/functions/cloneMatrix.html b/docs/functions/cloneMatrix.html index 1aeb3b11..72500db3 100644 --- a/docs/functions/cloneMatrix.html +++ b/docs/functions/cloneMatrix.html @@ -1,2 +1,2 @@ cloneMatrix | goban

    Function cloneMatrix

    • Returns a cloned copy of the provided matrix

      -

      Type Parameters

      • T

      Parameters

      • matrix: T[][]

      Returns T[][]

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T[][]

    \ No newline at end of file diff --git a/docs/functions/closeErrorCodeToString.html b/docs/functions/closeErrorCodeToString.html index fb2d080a..d5f2fe36 100644 --- a/docs/functions/closeErrorCodeToString.html +++ b/docs/functions/closeErrorCodeToString.html @@ -1 +1 @@ -closeErrorCodeToString | goban

    Function closeErrorCodeToString

    \ No newline at end of file +closeErrorCodeToString | goban

    Function closeErrorCodeToString

    \ No newline at end of file diff --git a/docs/functions/color_blend.html b/docs/functions/color_blend.html index cd3915ca..023b933e 100644 --- a/docs/functions/color_blend.html +++ b/docs/functions/color_blend.html @@ -1,2 +1,2 @@ color_blend | goban

    Function color_blend

    • Simple 50% blend of two colors in hex format

      -

      Parameters

      • c1: string
      • c2: string

      Returns string

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/docs/functions/computeAverageMoveTime.html b/docs/functions/computeAverageMoveTime.html index 177ed47f..a91a690c 100644 --- a/docs/functions/computeAverageMoveTime.html +++ b/docs/functions/computeAverageMoveTime.html @@ -1,2 +1,2 @@ computeAverageMoveTime | goban

    Function computeAverageMoveTime

    \ No newline at end of file +

    Parameters

    Returns number

    \ No newline at end of file diff --git a/docs/functions/createDeviceScaledCanvas.html b/docs/functions/createDeviceScaledCanvas.html index 0666be13..7a47affe 100644 --- a/docs/functions/createDeviceScaledCanvas.html +++ b/docs/functions/createDeviceScaledCanvas.html @@ -1 +1 @@ -createDeviceScaledCanvas | goban

    Function createDeviceScaledCanvas

    • Parameters

      • width: number
      • height: number

      Returns HTMLCanvasElement

    \ No newline at end of file +createDeviceScaledCanvas | goban

    Function createDeviceScaledCanvas

    • Parameters

      • width: number
      • height: number

      Returns HTMLCanvasElement

    \ No newline at end of file diff --git a/docs/functions/createGoban.html b/docs/functions/createGoban.html index 05789448..bd542f8a 100644 --- a/docs/functions/createGoban.html +++ b/docs/functions/createGoban.html @@ -1 +1 @@ -createGoban | goban

    Function createGoban

    \ No newline at end of file +createGoban | goban

    Function createGoban

    \ No newline at end of file diff --git a/docs/functions/decodeCoordinate.html b/docs/functions/decodeCoordinate.html index 4d70dd8e..07d07d87 100644 --- a/docs/functions/decodeCoordinate.html +++ b/docs/functions/decodeCoordinate.html @@ -1,2 +1,2 @@ decodeCoordinate | goban

    Function decodeCoordinate

    \ No newline at end of file +

    Parameters

    Returns number

    \ No newline at end of file diff --git a/docs/functions/decodeGTPCoordinates.html b/docs/functions/decodeGTPCoordinates.html index d15f1c3f..9783d73d 100644 --- a/docs/functions/decodeGTPCoordinates.html +++ b/docs/functions/decodeGTPCoordinates.html @@ -1,2 +1,2 @@ decodeGTPCoordinates | goban

    Function decodeGTPCoordinates

    \ No newline at end of file +

    Parameters

    Returns JGOFMove

    \ No newline at end of file diff --git a/docs/functions/decodeMoves.html b/docs/functions/decodeMoves.html index b854f06f..4b31ed32 100644 --- a/docs/functions/decodeMoves.html +++ b/docs/functions/decodeMoves.html @@ -1,3 +1,3 @@ decodeMoves | goban

    Function decodeMoves

    \ No newline at end of file +

    Parameters

    Returns JGOFMove[]

    \ No newline at end of file diff --git a/docs/functions/decodePrettyCoordinates.html b/docs/functions/decodePrettyCoordinates.html index 4413e8a9..c765c214 100644 --- a/docs/functions/decodePrettyCoordinates.html +++ b/docs/functions/decodePrettyCoordinates.html @@ -1,2 +1,2 @@ decodePrettyCoordinates | goban

    Function decodePrettyCoordinates

    \ No newline at end of file +

    Parameters

    Returns JGOFMove

    \ No newline at end of file diff --git a/docs/functions/decodePrettyXCoordinate.html b/docs/functions/decodePrettyXCoordinate.html index f9fd4aa8..a88cd0d6 100644 --- a/docs/functions/decodePrettyXCoordinate.html +++ b/docs/functions/decodePrettyXCoordinate.html @@ -1,2 +1,2 @@ decodePrettyXCoordinate | goban

    Function decodePrettyXCoordinate

    • Decodes the pretty X coordinate to a number

      -

      Parameters

      • ch: string

      Returns number

    \ No newline at end of file +

    Parameters

    Returns number

    \ No newline at end of file diff --git a/docs/functions/deepClone.html b/docs/functions/deepClone.html index bc4d3b38..52540535 100644 --- a/docs/functions/deepClone.html +++ b/docs/functions/deepClone.html @@ -1,2 +1,2 @@ deepClone | goban

    Function deepClone

    \ No newline at end of file +

    Parameters

    Returns any

    \ No newline at end of file diff --git a/docs/functions/deepEqual.html b/docs/functions/deepEqual.html index 2b3e9c26..f402ebd5 100644 --- a/docs/functions/deepEqual.html +++ b/docs/functions/deepEqual.html @@ -1,2 +1,2 @@ deepEqual | goban

    Function deepEqual

    \ No newline at end of file +

    Parameters

    Returns boolean

    \ No newline at end of file diff --git a/docs/functions/deviceCanvasScalingRatio.html b/docs/functions/deviceCanvasScalingRatio.html index 4d52ba61..27da4878 100644 --- a/docs/functions/deviceCanvasScalingRatio.html +++ b/docs/functions/deviceCanvasScalingRatio.html @@ -1 +1 @@ -deviceCanvasScalingRatio | goban

    Function deviceCanvasScalingRatio

    \ No newline at end of file +deviceCanvasScalingRatio | goban

    Function deviceCanvasScalingRatio

    \ No newline at end of file diff --git a/docs/functions/elementOffset.html b/docs/functions/elementOffset.html index d903d8c5..6a81cc74 100644 --- a/docs/functions/elementOffset.html +++ b/docs/functions/elementOffset.html @@ -1 +1 @@ -elementOffset | goban

    Function elementOffset

    • Parameters

      • element: HTMLElement

      Returns {
          left: number;
          top: number;
      }

      • left: number
      • top: number
    \ No newline at end of file +elementOffset | goban

    Function elementOffset

    • Parameters

      • element: HTMLElement

      Returns {
          left: number;
          top: number;
      }

      • left: number
      • top: number
    \ No newline at end of file diff --git a/docs/functions/encodeCoordinate.html b/docs/functions/encodeCoordinate.html index 9ac74769..3a1a353c 100644 --- a/docs/functions/encodeCoordinate.html +++ b/docs/functions/encodeCoordinate.html @@ -1,2 +1,2 @@ encodeCoordinate | goban

    Function encodeCoordinate

    • Encodes a single coordinate to a number

      -

      Parameters

      • coor: number

      Returns string

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/docs/functions/encodeMove.html b/docs/functions/encodeMove.html index 12439afb..3847d91c 100644 --- a/docs/functions/encodeMove.html +++ b/docs/functions/encodeMove.html @@ -1 +1 @@ -encodeMove | goban

    Function encodeMove

    \ No newline at end of file +encodeMove | goban

    Function encodeMove

    \ No newline at end of file diff --git a/docs/functions/encodeMoveToArray.html b/docs/functions/encodeMoveToArray.html index 6e4ccd7e..47bbe3cc 100644 --- a/docs/functions/encodeMoveToArray.html +++ b/docs/functions/encodeMoveToArray.html @@ -1 +1 @@ -encodeMoveToArray | goban

    Function encodeMoveToArray

    \ No newline at end of file +encodeMoveToArray | goban

    Function encodeMoveToArray

    \ No newline at end of file diff --git a/docs/functions/encodeMoves.html b/docs/functions/encodeMoves.html index 9c15c49c..b9896272 100644 --- a/docs/functions/encodeMoves.html +++ b/docs/functions/encodeMoves.html @@ -1 +1 @@ -encodeMoves | goban

    Function encodeMoves

    \ No newline at end of file +encodeMoves | goban

    Function encodeMoves

    \ No newline at end of file diff --git a/docs/functions/encodeMovesToArray.html b/docs/functions/encodeMovesToArray.html index e44be3bd..e91fbc7a 100644 --- a/docs/functions/encodeMovesToArray.html +++ b/docs/functions/encodeMovesToArray.html @@ -1 +1 @@ -encodeMovesToArray | goban

    Function encodeMovesToArray

    \ No newline at end of file +encodeMovesToArray | goban

    Function encodeMovesToArray

    \ No newline at end of file diff --git a/docs/functions/encodePrettyXCoordinate.html b/docs/functions/encodePrettyXCoordinate.html index d395f302..1bbedda4 100644 --- a/docs/functions/encodePrettyXCoordinate.html +++ b/docs/functions/encodePrettyXCoordinate.html @@ -1,2 +1,2 @@ encodePrettyXCoordinate | goban

    Function encodePrettyXCoordinate

    • Encodes an X coordinate to a display encoding

      -

      Parameters

      • coor: number

      Returns string

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/docs/functions/escapeSGFText.html b/docs/functions/escapeSGFText.html index 2651e1d3..833d5cba 100644 --- a/docs/functions/escapeSGFText.html +++ b/docs/functions/escapeSGFText.html @@ -1 +1 @@ -escapeSGFText | goban

    Function escapeSGFText

    • Parameters

      • txt: string
      • escapeColon: boolean = false

      Returns string

    \ No newline at end of file +escapeSGFText | goban

    Function escapeSGFText

    • Parameters

      • txt: string
      • escapeColon: boolean = false

      Returns string

    \ No newline at end of file diff --git a/docs/functions/getRandomInt.html b/docs/functions/getRandomInt.html index 839bc853..598e3853 100644 --- a/docs/functions/getRandomInt.html +++ b/docs/functions/getRandomInt.html @@ -1,2 +1,2 @@ getRandomInt | goban

    Function getRandomInt

    • Returns a random integer between min (inclusive) and max (exclusive)

      -

      Parameters

      • min: number
      • max: number

      Returns number

    \ No newline at end of file +

    Parameters

    Returns number

    \ No newline at end of file diff --git a/docs/functions/getRelativeEventPosition.html b/docs/functions/getRelativeEventPosition.html index 5164e91d..0e67d94a 100644 --- a/docs/functions/getRelativeEventPosition.html +++ b/docs/functions/getRelativeEventPosition.html @@ -1,2 +1,2 @@ getRelativeEventPosition | goban

    Function getRelativeEventPosition

    • Returns {x,y} of the event relative to the event target

      -

      Parameters

      • event: TouchEvent | MouseEvent
      • Optional target: HTMLElement

      Returns {
          x: number;
          y: number;
      }

      • x: number
      • y: number
    \ No newline at end of file +

    Parameters

    Returns {
        x: number;
        y: number;
    }

    \ No newline at end of file diff --git a/docs/functions/getWorstMoves.html b/docs/functions/getWorstMoves.html index d95a6408..5fb5b43e 100644 --- a/docs/functions/getWorstMoves.html +++ b/docs/functions/getWorstMoves.html @@ -1,4 +1,4 @@ getWorstMoves | goban

    Function getWorstMoves

    \ No newline at end of file +

    Parameters

    Returns AIReviewWorstMoveEntry[]

    \ No newline at end of file diff --git a/docs/functions/init_remote_ownership_estimator.html b/docs/functions/init_remote_ownership_estimator.html index bf127638..c0a2de37 100644 --- a/docs/functions/init_remote_ownership_estimator.html +++ b/docs/functions/init_remote_ownership_estimator.html @@ -1 +1 @@ -init_remote_ownership_estimator | goban

    Function init_remote_ownership_estimator

    \ No newline at end of file +init_remote_ownership_estimator | goban

    Function init_remote_ownership_estimator

    \ No newline at end of file diff --git a/docs/functions/init_wasm_ownership_estimator.html b/docs/functions/init_wasm_ownership_estimator.html index 5143badc..fc4cbc85 100644 --- a/docs/functions/init_wasm_ownership_estimator.html +++ b/docs/functions/init_wasm_ownership_estimator.html @@ -1 +1 @@ -init_wasm_ownership_estimator | goban

    Function init_wasm_ownership_estimator

    \ No newline at end of file +init_wasm_ownership_estimator | goban

    Function init_wasm_ownership_estimator

    \ No newline at end of file diff --git a/docs/functions/makeEmptyMatrix.html b/docs/functions/makeEmptyMatrix.html index 2b20041b..68d9ad89 100644 --- a/docs/functions/makeEmptyMatrix.html +++ b/docs/functions/makeEmptyMatrix.html @@ -1 +1 @@ -makeEmptyMatrix | goban

    Function makeEmptyMatrix

    • Type Parameters

      • T

      Parameters

      • width: number
      • height: number

      Returns (T | undefined)[][]

    \ No newline at end of file +makeEmptyMatrix | goban

    Function makeEmptyMatrix

    • Type Parameters

      • T

      Parameters

      • width: number
      • height: number

      Returns (T | undefined)[][]

    \ No newline at end of file diff --git a/docs/functions/makeMatrix.html b/docs/functions/makeMatrix.html index 32d7c803..7e6bc74c 100644 --- a/docs/functions/makeMatrix.html +++ b/docs/functions/makeMatrix.html @@ -1 +1 @@ -makeMatrix | goban

    Function makeMatrix

    \ No newline at end of file +makeMatrix | goban

    Function makeMatrix

    \ No newline at end of file diff --git a/docs/functions/makeObjectMatrix.html b/docs/functions/makeObjectMatrix.html index 341c1d0d..82c4070e 100644 --- a/docs/functions/makeObjectMatrix.html +++ b/docs/functions/makeObjectMatrix.html @@ -1 +1 @@ -makeObjectMatrix | goban

    Function makeObjectMatrix

    • Type Parameters

      • T

      Parameters

      • width: number
      • height: number

      Returns T[][]

    \ No newline at end of file +makeObjectMatrix | goban

    Function makeObjectMatrix

    • Type Parameters

      • T

      Parameters

      • width: number
      • height: number

      Returns T[][]

    \ No newline at end of file diff --git a/docs/functions/matricesAreEqual.html b/docs/functions/matricesAreEqual.html index 2a326723..4fda290d 100644 --- a/docs/functions/matricesAreEqual.html +++ b/docs/functions/matricesAreEqual.html @@ -1,3 +1,3 @@ matricesAreEqual | goban

    Function matricesAreEqual

    • Returns true if the contents of the two 2d matrices are equal when the cells are compared with ===

      -

      Type Parameters

      • T

      Parameters

      • m1: T[][]
      • m2: T[][]

      Returns boolean

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns boolean

    \ No newline at end of file diff --git a/docs/functions/newlines_to_spaces.html b/docs/functions/newlines_to_spaces.html index b233959e..609f69eb 100644 --- a/docs/functions/newlines_to_spaces.html +++ b/docs/functions/newlines_to_spaces.html @@ -1,3 +1,3 @@ newlines_to_spaces | goban

    Function newlines_to_spaces

    • SGF "simple text", eg used in the LB property, we can't have newlines. This strips them and replaces them with spaces.

      -

      Parameters

      • txt: string

      Returns string

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/docs/functions/niceInterval.html b/docs/functions/niceInterval.html index 46c132a6..6e025bb6 100644 --- a/docs/functions/niceInterval.html +++ b/docs/functions/niceInterval.html @@ -1,4 +1,4 @@ niceInterval | goban

    Function niceInterval

    • Like setInterval, but debounces catchups (multiple invocation in rapid succession less than our desired interval) that happen in some browsers when tabs wake up from sleep. Cleared with the standard clearInterval.

      -

      Parameters

      • callback: (() => void)
          • (): void
          • Returns void

      • interval: number

      Returns ReturnType<typeof setInterval>

    \ No newline at end of file +

    Parameters

    Returns ReturnType<typeof setInterval>

    \ No newline at end of file diff --git a/docs/functions/num2char.html b/docs/functions/num2char.html index 1a6197ec..d90f7c3c 100644 --- a/docs/functions/num2char.html +++ b/docs/functions/num2char.html @@ -1 +1 @@ -num2char | goban

    Function num2char

    \ No newline at end of file +num2char | goban

    Function num2char

    \ No newline at end of file diff --git a/docs/functions/ojeSequenceToMoves.html b/docs/functions/ojeSequenceToMoves.html index 23b274bf..8ecbcd5b 100644 --- a/docs/functions/ojeSequenceToMoves.html +++ b/docs/functions/ojeSequenceToMoves.html @@ -1 +1 @@ -ojeSequenceToMoves | goban

    Function ojeSequenceToMoves

    \ No newline at end of file +ojeSequenceToMoves | goban

    Function ojeSequenceToMoves

    \ No newline at end of file diff --git a/docs/functions/placeRenderedImageStone.html b/docs/functions/placeRenderedImageStone.html index 35439b8f..8578e781 100644 --- a/docs/functions/placeRenderedImageStone.html +++ b/docs/functions/placeRenderedImageStone.html @@ -1 +1 @@ -placeRenderedImageStone | goban

    Function placeRenderedImageStone

    • Parameters

      • ctx: CanvasRenderingContext2D
      • shadow_ctx: null | CanvasRenderingContext2D
      • stone: StoneType
      • cx: number
      • cy: number
      • radius: number

      Returns void

    \ No newline at end of file +placeRenderedImageStone | goban

    Function placeRenderedImageStone

    • Parameters

      • ctx: CanvasRenderingContext2D
      • shadow_ctx: null | CanvasRenderingContext2D
      • stone: StoneType
      • cx: number
      • cy: number
      • radius: number

      Returns void

    \ No newline at end of file diff --git a/docs/functions/positionId.html b/docs/functions/positionId.html index 98d8a05d..e80ac712 100644 --- a/docs/functions/positionId.html +++ b/docs/functions/positionId.html @@ -1 +1 @@ -positionId | goban

    Function positionId

    \ No newline at end of file +positionId | goban

    Function positionId

    \ No newline at end of file diff --git a/docs/functions/preRenderImageStone.html b/docs/functions/preRenderImageStone.html index 1f7947bb..a73a77fe 100644 --- a/docs/functions/preRenderImageStone.html +++ b/docs/functions/preRenderImageStone.html @@ -1 +1 @@ -preRenderImageStone | goban

    Function preRenderImageStone

    \ No newline at end of file +preRenderImageStone | goban

    Function preRenderImageStone

    \ No newline at end of file diff --git a/docs/functions/prettyCoordinates.html b/docs/functions/prettyCoordinates.html index ec1619d2..7bf6f10d 100644 --- a/docs/functions/prettyCoordinates.html +++ b/docs/functions/prettyCoordinates.html @@ -1,2 +1,2 @@ prettyCoordinates | goban

    Function prettyCoordinates

    • Encodes an x,y pair to "pretty" coordinates, like "A3", or "K10"

      -

      Parameters

      • x: number
      • y: number
      • board_height: number

      Returns string

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/docs/functions/resizeDeviceScaledCanvas.html b/docs/functions/resizeDeviceScaledCanvas.html index 37922d3b..fb7e4fed 100644 --- a/docs/functions/resizeDeviceScaledCanvas.html +++ b/docs/functions/resizeDeviceScaledCanvas.html @@ -1 +1 @@ -resizeDeviceScaledCanvas | goban

    Function resizeDeviceScaledCanvas

    • Parameters

      • canvas: HTMLCanvasElement
      • width: number
      • height: number

      Returns HTMLCanvasElement

    \ No newline at end of file +resizeDeviceScaledCanvas | goban

    Function resizeDeviceScaledCanvas

    • Parameters

      • canvas: HTMLCanvasElement
      • width: number
      • height: number

      Returns HTMLCanvasElement

    \ No newline at end of file diff --git a/docs/functions/setGobanCallbacks.html b/docs/functions/setGobanCallbacks.html index 70793214..f12e964b 100644 --- a/docs/functions/setGobanCallbacks.html +++ b/docs/functions/setGobanCallbacks.html @@ -1,3 +1,3 @@ setGobanCallbacks | goban

    Function setGobanCallbacks

    • Set's callback functions to be called in various situations. You can set any or all of the callbacks, only the provided callbacks will be updated.

      -

      Parameters

      Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/docs/functions/setGobanRenderer.html b/docs/functions/setGobanRenderer.html index 2860478b..33639cce 100644 --- a/docs/functions/setGobanRenderer.html +++ b/docs/functions/setGobanRenderer.html @@ -1 +1 @@ -setGobanRenderer | goban

    Function setGobanRenderer

    • Parameters

      • _renderer: "canvas" | "svg"

      Returns void

    \ No newline at end of file +setGobanRenderer | goban

    Function setGobanRenderer

    • Parameters

      • _renderer: "canvas" | "svg"

      Returns void

    \ No newline at end of file diff --git a/docs/functions/set_local_ownership_estimator.html b/docs/functions/set_local_ownership_estimator.html index 73cae7df..a713fd4e 100644 --- a/docs/functions/set_local_ownership_estimator.html +++ b/docs/functions/set_local_ownership_estimator.html @@ -1 +1 @@ -set_local_ownership_estimator | goban

    Function set_local_ownership_estimator

    \ No newline at end of file +set_local_ownership_estimator | goban

    Function set_local_ownership_estimator

    \ No newline at end of file diff --git a/docs/functions/shortDurationString.html b/docs/functions/shortDurationString.html index aff859a4..14c6214d 100644 --- a/docs/functions/shortDurationString.html +++ b/docs/functions/shortDurationString.html @@ -1,2 +1,2 @@ shortDurationString | goban

    Function shortDurationString

    • Takes a number of seconds and returns a string like "1d 3h 2m 52s"

      -

      Parameters

      • seconds: number

      Returns string

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/docs/functions/sortMoves.html b/docs/functions/sortMoves.html index 3ff2bd71..d82fa257 100644 --- a/docs/functions/sortMoves.html +++ b/docs/functions/sortMoves.html @@ -1,2 +1,2 @@ sortMoves | goban

    Function sortMoves

    \ No newline at end of file +

    Parameters

    Returns string

  • Parameters

    Returns JGOFMove[]

  • \ No newline at end of file diff --git a/docs/functions/translate._.html b/docs/functions/translate._.html index 4dfaa335..c3ea6379 100644 --- a/docs/functions/translate._.html +++ b/docs/functions/translate._.html @@ -1 +1 @@ -_ | goban

    Function _

    \ No newline at end of file +_ | goban

    Function _

    \ No newline at end of file diff --git a/docs/functions/translate.interpolate.html b/docs/functions/translate.interpolate.html index ab6ca53d..b7866566 100644 --- a/docs/functions/translate.interpolate.html +++ b/docs/functions/translate.interpolate.html @@ -1 +1 @@ -interpolate | goban

    Function interpolate

    • Parameters

      • str: string
      • params: any

      Returns string

    \ No newline at end of file +interpolate | goban

    Function interpolate

    • Parameters

      • str: string
      • params: any

      Returns string

    \ No newline at end of file diff --git a/docs/functions/translate.setGobanTranslations.html b/docs/functions/translate.setGobanTranslations.html index 298bf2f0..25858bf3 100644 --- a/docs/functions/translate.setGobanTranslations.html +++ b/docs/functions/translate.setGobanTranslations.html @@ -1 +1 @@ -setGobanTranslations | goban

    Function setGobanTranslations

    \ No newline at end of file +setGobanTranslations | goban

    Function setGobanTranslations

    \ No newline at end of file diff --git a/docs/functions/validateCanvas.html b/docs/functions/validateCanvas.html index 900e5768..3e9871c4 100644 --- a/docs/functions/validateCanvas.html +++ b/docs/functions/validateCanvas.html @@ -1,4 +1,4 @@ validateCanvas | goban

    Function validateCanvas

    • Validates that a canvas was created successfully and a 2d context can be allocated for it. If not, we call the GobanCore.canvasAllocationErrorHandler hook.

      -

      Parameters

      • canvas: null | HTMLCanvasElement
      • Optional err: Error
      • Optional width: string | number
      • Optional height: string | number

      Returns boolean

    \ No newline at end of file +

    Parameters

    Returns boolean

    \ No newline at end of file diff --git a/docs/functions/voronoi_estimate_ownership.html b/docs/functions/voronoi_estimate_ownership.html index f281f040..846e1161 100644 --- a/docs/functions/voronoi_estimate_ownership.html +++ b/docs/functions/voronoi_estimate_ownership.html @@ -1,4 +1,4 @@ voronoi_estimate_ownership | goban

    Function voronoi_estimate_ownership

    \ No newline at end of file +

    Parameters

    Returns number[][]

    \ No newline at end of file diff --git a/docs/functions/wasm_estimate_ownership.html b/docs/functions/wasm_estimate_ownership.html index 179e1240..cf95f9b3 100644 --- a/docs/functions/wasm_estimate_ownership.html +++ b/docs/functions/wasm_estimate_ownership.html @@ -1 +1 @@ -wasm_estimate_ownership | goban

    Function wasm_estimate_ownership

    \ No newline at end of file +wasm_estimate_ownership | goban

    Function wasm_estimate_ownership

    \ No newline at end of file diff --git a/docs/interfaces/AIReviewWorstMoveEntry.html b/docs/interfaces/AIReviewWorstMoveEntry.html index d0ba4061..6b474446 100644 --- a/docs/interfaces/AIReviewWorstMoveEntry.html +++ b/docs/interfaces/AIReviewWorstMoveEntry.html @@ -1,5 +1,5 @@ -AIReviewWorstMoveEntry | goban

    Interface AIReviewWorstMoveEntry

    interface AIReviewWorstMoveEntry {
        delta: number;
        move: JGOFIntersection;
        move_number: number;
        player: JGOFNumericPlayerColor;
    }

    Properties

    delta +AIReviewWorstMoveEntry | goban

    Interface AIReviewWorstMoveEntry

    interface AIReviewWorstMoveEntry {
        delta: number;
        move: JGOFIntersection;
        move_number: number;
        player: JGOFNumericPlayerColor;
    }

    Properties

    delta: number
    move_number: number
    \ No newline at end of file +

    Properties

    delta: number
    move_number: number
    \ No newline at end of file diff --git a/docs/interfaces/AdHocClock.html b/docs/interfaces/AdHocClock.html index 82e53f05..8c4a434f 100644 --- a/docs/interfaces/AdHocClock.html +++ b/docs/interfaces/AdHocClock.html @@ -1,4 +1,4 @@ -AdHocClock | goban

    Interface AdHocClock

    interface AdHocClock {
        black_player_id: number;
        black_time: number | AdHocPlayerClock;
        current_player: number;
        expiration: number;
        game_id: number;
        last_move: number;
        pause?: {
            pause_control: AdHocPauseControl;
            paused: boolean;
            paused_since: number;
        };
        paused_since?: number;
        start_mode?: boolean;
        title: string;
        white_player_id: number;
        white_time: number | AdHocPlayerClock;
    }

    Properties

    black_player_id +AdHocClock | goban

    Interface AdHocClock

    interface AdHocClock {
        black_player_id: number;
        black_time: number | AdHocPlayerClock;
        current_player: number;
        expiration: number;
        game_id: number;
        last_move: number;
        pause?: {
            pause_control: AdHocPauseControl;
            paused: boolean;
            paused_since: number;
        };
        paused_since?: number;
        start_mode?: boolean;
        title: string;
        white_player_id: number;
        white_time: number | AdHocPlayerClock;
    }

    Properties

    black_player_id: number

    OGS player id for black

    -
    black_time: number | AdHocPlayerClock

    Time left on black's clock. If this is a number (such as is the case +

    black_time: number | AdHocPlayerClock

    Time left on black's clock. If this is a number (such as is the case with simple time), it is expressed in milliseconds.

    -
    current_player: number

    Current player to move

    -
    expiration: number

    Time the game will end if no move is played, in milliseconds since +

    current_player: number

    Current player to move

    +
    expiration: number

    Time the game will end if no move is played, in milliseconds since 1970. This is computed by adding together any main and overtime left on the clock. If start_mode is set, this is the number of milliseconds left on the start clock.

    -
    game_id: number

    OGS Game id

    -
    last_move: number

    Time the last move was made, in milliseconds since 1970

    -
    pause?: {
        pause_control: AdHocPauseControl;
        paused: boolean;
        paused_since: number;
    }

    If set, this AdHocClock is updating the pause state

    -

    Type declaration

    paused_since?: number

    Time the game was paused. This field erroneously exists even after the +

    game_id: number

    OGS Game id

    +
    last_move: number

    Time the last move was made, in milliseconds since 1970

    +
    pause?: {
        pause_control: AdHocPauseControl;
        paused: boolean;
        paused_since: number;
    }

    If set, this AdHocClock is updating the pause state

    +

    Type declaration

    paused_since?: number

    Time the game was paused. This field erroneously exists even after the game has been resumed, this will be removed in these cases.

    -
    start_mode?: boolean

    If true, the game has not started and this is the count down until +

    start_mode?: boolean

    If true, the game has not started and this is the count down until the game is canceled if a move has not been played yet. If this is true, then the duration left on the start clock is stored in expiration (in ms)

    -
    title: string

    Title of the game. This field will be removed.

    -
    white_player_id: number

    OGS player id for white

    -
    white_time: number | AdHocPlayerClock

    Time left on white's clock. If this is a number (such as is the case +

    title: string

    Title of the game. This field will be removed.

    +
    white_player_id: number

    OGS player id for white

    +
    white_time: number | AdHocPlayerClock

    Time left on white's clock. If this is a number (such as is the case with simple time), it is expressed in milliseconds.k

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/AdHocFormat.html b/docs/interfaces/AdHocFormat.html index 68683d14..870569d0 100644 --- a/docs/interfaces/AdHocFormat.html +++ b/docs/interfaces/AdHocFormat.html @@ -1,8 +1,8 @@ AdHocFormat | goban

    Interface AdHocFormat

    The to-be-deprecated format used by Online-Go.com, will be replaced by JGOF as we develop a migration plan

    -
    interface AdHocFormat {
        black: AdHocPlayer;
        clock: AdHocClock;
        pause_control: AdHocPauseControl;
        time_control: JGOFTimeControl;
        white: AdHocPlayer;
    }

    Properties

    interface AdHocFormat {
        black: AdHocPlayer;
        clock: AdHocClock;
        pause_control: AdHocPauseControl;
        time_control: JGOFTimeControl;
        white: AdHocPlayer;
    }

    Properties

    clock: AdHocClock
    pause_control: AdHocPauseControl
    time_control: JGOFTimeControl
    \ No newline at end of file +

    Properties

    clock: AdHocClock
    pause_control: AdHocPauseControl
    time_control: JGOFTimeControl
    \ No newline at end of file diff --git a/docs/interfaces/AdHocPauseControl.html b/docs/interfaces/AdHocPauseControl.html index be065ec4..eb8e4962 100644 --- a/docs/interfaces/AdHocPauseControl.html +++ b/docs/interfaces/AdHocPauseControl.html @@ -1,6 +1,6 @@ -AdHocPauseControl | goban

    Interface AdHocPauseControl

    interface AdHocPauseControl {
        moderator_paused?: {
            moderator_id: number;
        };
        paused?: {
            pauses_left: number;
            pausing_player_id: number;
        };
        stone-removal?: true;
        system?: true;
        weekend?: true;
        [vacation: string]: any;
    }

    Indexable

    [vacation: string]: any

    Properties

    moderator_paused? +AdHocPauseControl | goban

    Interface AdHocPauseControl

    interface AdHocPauseControl {
        moderator_paused?: {
            moderator_id: number;
        };
        paused?: {
            pauses_left: number;
            pausing_player_id: number;
        };
        stone-removal?: true;
        system?: true;
        weekend?: true;
        [vacation: string]: any;
    }

    Indexable

    [vacation: string]: any

    Properties

    moderator_paused?: {
        moderator_id: number;
    }

    Type declaration

    • moderator_id: number
    paused?: {
        pauses_left: number;
        pausing_player_id: number;
    }

    Type declaration

    • pauses_left: number
    • pausing_player_id: number
    stone-removal?: true
    system?: true
    weekend?: true
    \ No newline at end of file +

    Properties

    moderator_paused?: {
        moderator_id: number;
    }

    Type declaration

    • moderator_id: number
    paused?: {
        pauses_left: number;
        pausing_player_id: number;
    }

    Type declaration

    • pauses_left: number
    • pausing_player_id: number
    stone-removal?: true
    system?: true
    weekend?: true
    \ No newline at end of file diff --git a/docs/interfaces/AdHocPlayer.html b/docs/interfaces/AdHocPlayer.html index d82905f7..d0bd9b88 100644 --- a/docs/interfaces/AdHocPlayer.html +++ b/docs/interfaces/AdHocPlayer.html @@ -1,3 +1,3 @@ -AdHocPlayer | goban

    Interface AdHocPlayer

    interface AdHocPlayer {
        id: number;
        name: string;
    }

    Properties

    id +AdHocPlayer | goban

    Interface AdHocPlayer

    interface AdHocPlayer {
        id: number;
        name: string;
    }

    Properties

    Properties

    id: number
    name: string
    \ No newline at end of file +

    Properties

    id: number
    name: string
    \ No newline at end of file diff --git a/docs/interfaces/AdHocPlayerClock.html b/docs/interfaces/AdHocPlayerClock.html index 170a4a17..fa42a65a 100644 --- a/docs/interfaces/AdHocPlayerClock.html +++ b/docs/interfaces/AdHocPlayerClock.html @@ -1,4 +1,4 @@ -AdHocPlayerClock | goban

    Interface AdHocPlayerClock

    interface AdHocPlayerClock {
        block_time?: number;
        moves_left?: number;
        period_time?: number;
        periods?: number;
        skip_bonus?: boolean;
        thinking_time: number;
    }

    Properties

    block_time? +AdHocPlayerClock | goban

    Interface AdHocPlayerClock

    interface AdHocPlayerClock {
        block_time?: number;
        moves_left?: number;
        period_time?: number;
        periods?: number;
        skip_bonus?: boolean;
        thinking_time: number;
    }

    Properties

    block_time?: number

    Used with canadian time control. Time left (in seconds) to make the remainder of your moves in yu

    -
    moves_left?: number

    Used with canadian time control. Number of moves left before a new +

    moves_left?: number

    Used with canadian time control. Number of moves left before a new block of time.

    -
    period_time?: number

    Used with byo-yomi time control. Length of each period, in seconds.

    -
    periods?: number

    Used with byo-yomi time control. Number of periods left.

    -
    skip_bonus?: boolean

    Used with fischer time control to denote that the next move should not +

    period_time?: number

    Used with byo-yomi time control. Length of each period, in seconds.

    +
    periods?: number

    Used with byo-yomi time control. Number of periods left.

    +
    skip_bonus?: boolean

    Used with fischer time control to denote that the next move should not increment the clock.

    -
    thinking_time: number

    Thinking time left, in seconds. Also used as main time for byo-yomi and +

    thinking_time: number

    Thinking time left, in seconds. Also used as main time for byo-yomi and canadian clocks.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/AudioClockEvent.html b/docs/interfaces/AudioClockEvent.html index bae67bf6..3365a8b7 100644 --- a/docs/interfaces/AudioClockEvent.html +++ b/docs/interfaces/AudioClockEvent.html @@ -1,14 +1,14 @@ -AudioClockEvent | goban

    Interface AudioClockEvent

    interface AudioClockEvent {
        clock: JGOFPlayerClock;
        color: PlayerColor;
        countdown_seconds: number;
        in_overtime: boolean;
        player_id: string;
        time_control_system: JGOFTimeControlSystem;
    }

    Properties

    clock +AudioClockEvent | goban

    Interface AudioClockEvent

    interface AudioClockEvent {
        clock: JGOFPlayerClock;
        color: PlayerColor;
        countdown_seconds: number;
        in_overtime: boolean;
        player_id: string;
        time_control_system: JGOFTimeControlSystem;
    }

    Properties

    Full player clock information

    -

    The player whose turn it is

    -
    countdown_seconds: number

    Number of seconds left in the current period

    -
    in_overtime: boolean

    True if we are in overtime. This is only ever set for systems that have +

    The player whose turn it is

    +
    countdown_seconds: number

    Number of seconds left in the current period

    +
    in_overtime: boolean

    True if we are in overtime. This is only ever set for systems that have a concept of overtime.

    -
    player_id: string

    The player (id) whose turn it is

    -
    time_control_system: JGOFTimeControlSystem

    Time control system being used by the clock

    -
    \ No newline at end of file +
    player_id: string

    The player (id) whose turn it is

    +
    time_control_system: JGOFTimeControlSystem

    Time control system being used by the clock

    +
    \ No newline at end of file diff --git a/docs/interfaces/BoardConfig.html b/docs/interfaces/BoardConfig.html index a62b3b33..6dd01e5c 100644 --- a/docs/interfaces/BoardConfig.html +++ b/docs/interfaces/BoardConfig.html @@ -1,4 +1,4 @@ -BoardConfig | goban

    Interface BoardConfig

    interface BoardConfig {
        black_prisoners?: number;
        board?: JGOFNumericPlayerColor[][];
        board_is_repeating?: boolean;
        height?: number;
        isobranch_hash?: string;
        player?: JGOFNumericPlayerColor;
        removal?: boolean[][];
        white_prisoners?: number;
        width?: number;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    black_prisoners? +BoardConfig | goban

    Interface BoardConfig

    interface BoardConfig {
        black_prisoners?: number;
        board?: JGOFNumericPlayerColor[][];
        board_is_repeating?: boolean;
        height?: number;
        isobranch_hash?: string;
        player?: JGOFNumericPlayerColor;
        removal?: boolean[][];
        white_prisoners?: number;
        width?: number;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    black_prisoners?: number
    board_is_repeating?: boolean
    height?: number
    isobranch_hash?: string
    removal?: boolean[][]
    white_prisoners?: number
    width?: number
    \ No newline at end of file +

    Properties

    black_prisoners?: number
    board_is_repeating?: boolean
    height?: number
    isobranch_hash?: string
    removal?: boolean[][]
    white_prisoners?: number
    width?: number
    \ No newline at end of file diff --git a/docs/interfaces/CanvasRendererGobanConfig.html b/docs/interfaces/CanvasRendererGobanConfig.html index fd92a170..d60e9287 100644 --- a/docs/interfaces/CanvasRendererGobanConfig.html +++ b/docs/interfaces/CanvasRendererGobanConfig.html @@ -1,4 +1,4 @@ -CanvasRendererGobanConfig | goban

    Interface CanvasRendererGobanConfig

    interface CanvasRendererGobanConfig {
        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_div?: HTMLElement;
        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);
        isobranch_hash?: string;
        komi?: number;
        ladder?: number;
        ladder_id?: number;
        last_move_opacity?: number;
        last_move_radius?: number;
        latencies?: {
            [player_id: string]: number;
        };
        leavePushedAnalysis?: (() => void);
        malkovich_log?: GobanChatLog;
        marks?: {
            [mark: string]: string;
        };
        mode?: GobanModes;
        move_tree?: MoveTreeJson;
        move_tree_container?: HTMLElement;
        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;
        strict_seki_mode?: boolean;
        superko_algorithm?: GobanEngineSuperKoAlgorithm;
        throw_all_errors?: boolean;
        time_control?: JGOFTimeControl;
        time_per_move?: number;
        title_div?: HTMLElement;
        tournament_id?: number;
        username?: string;
        variation_stone_opacity?: number;
        visual_undo_request_indicator?: boolean;
        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? +CanvasRendererGobanConfig | goban

    Interface CanvasRendererGobanConfig

    interface CanvasRendererGobanConfig {
        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_div?: HTMLElement;
        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);
        isobranch_hash?: string;
        komi?: number;
        ladder?: number;
        ladder_id?: number;
        last_move_opacity?: number;
        last_move_radius?: number;
        latencies?: {
            [player_id: string]: number;
        };
        leavePushedAnalysis?: (() => void);
        malkovich_log?: GobanChatLog;
        marks?: {
            [mark: string]: string;
        };
        mode?: GobanModes;
        move_tree?: MoveTreeJson;
        move_tree_container?: HTMLElement;
        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;
        strict_seki_mode?: boolean;
        superko_algorithm?: GobanEngineSuperKoAlgorithm;
        throw_all_errors?: boolean;
        time_control?: JGOFTimeControl;
        time_per_move?: number;
        title_div?: HTMLElement;
        tournament_id?: number;
        username?: string;
        variation_stone_opacity?: number;
        visual_undo_request_indicator?: boolean;
        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?: 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_div?: HTMLElement
    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;
    }[]

    Type declaration

    • 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)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isobranch_hash?: string
    komi?: number
    ladder?: number
    ladder_id?: number
    last_move_opacity?: number
    last_move_radius?: number
    latencies?: {
        [player_id: string]: number;
    }

    Type declaration

    • [player_id: string]: number
    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void
      • Returns void

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

    Type declaration

    • [mark: string]: string
    mode?: GobanModes
    move_tree?: MoveTreeJson
    move_tree_container?: HTMLElement
    name?: string
    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    -
    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
    ogs_import?: boolean

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

    -
    onError?: ((err) => void)

    Type declaration

      • (err): void
      • Parameters

        • err: Error

        Returns void

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

    Type declaration

      • (winning_color, points): void
      • Parameters

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

        Returns 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
    player_id?: number
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    }

    Type declaration

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

    Type declaration

    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[]

    Removed stones in stone removal phase +

    Properties

    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_div?: HTMLElement
    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;
    }[]

    Type declaration

    • 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)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isobranch_hash?: string
    komi?: number
    ladder?: number
    ladder_id?: number
    last_move_opacity?: number
    last_move_radius?: number
    latencies?: {
        [player_id: string]: number;
    }

    Type declaration

    • [player_id: string]: number
    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void
      • Returns void

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

    Type declaration

    • [mark: string]: string
    mode?: GobanModes
    move_tree?: MoveTreeJson
    move_tree_container?: HTMLElement
    name?: string
    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    +
    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
    ogs_import?: boolean

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

    +
    onError?: ((err) => void)

    Type declaration

      • (err): void
      • Parameters

        • err: Error

        Returns void

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

    Type declaration

      • (winning_color, points): void
      • Parameters

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

        Returns 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
    player_id?: number
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    }

    Type declaration

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

    Type declaration

    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[]

    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

    -
    rengo?: boolean
    rengo_casual_mode?: boolean
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    }

    Type declaration

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

    Type declaration

    score?: Score
    score_handicap?: boolean
    score_passes?: boolean
    score_prisoners?: boolean
    score_stones?: boolean
    score_territory?: boolean
    score_territory_in_seki?: boolean
    spectator_log?: GobanChatLog
    square_size?: number | "auto" | ((goban) => number)

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    stalling_score_estimate?: StallingScoreEstimate
    start_time?: number
    strict_seki_mode?: boolean
    superko_algorithm?: GobanEngineSuperKoAlgorithm
    throw_all_errors?: boolean

    When loading initial state or moves, by default GobanEngine will try and +

    rengo?: boolean
    rengo_casual_mode?: boolean
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    }

    Type declaration

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

    Type declaration

    score?: Score
    score_handicap?: boolean
    score_passes?: boolean
    score_prisoners?: boolean
    score_stones?: boolean
    score_territory?: boolean
    score_territory_in_seki?: boolean
    spectator_log?: GobanChatLog
    square_size?: number | "auto" | ((goban) => number)

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    stalling_score_estimate?: StallingScoreEstimate
    start_time?: number
    strict_seki_mode?: boolean
    superko_algorithm?: GobanEngineSuperKoAlgorithm
    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.

    -
    time_control?: JGOFTimeControl
    time_per_move?: number
    title_div?: HTMLElement
    tournament_id?: number
    username?: string
    variation_stone_opacity?: number
    visual_undo_request_indicator?: boolean
    white_must_pass_last?: boolean
    white_player_id?: number
    white_prisoners?: number
    width?: number
    winner?: number | "black" | "white"
    \ No newline at end of file +
    time_control?: JGOFTimeControl
    time_per_move?: number
    title_div?: HTMLElement
    tournament_id?: number
    username?: string
    variation_stone_opacity?: number
    visual_undo_request_indicator?: boolean
    white_must_pass_last?: boolean
    white_player_id?: number
    white_prisoners?: number
    width?: number
    winner?: number | "black" | "white"
    \ No newline at end of file diff --git a/docs/interfaces/ColoredCircle.html b/docs/interfaces/ColoredCircle.html index 4e5f585c..86c1a0c2 100644 --- a/docs/interfaces/ColoredCircle.html +++ b/docs/interfaces/ColoredCircle.html @@ -1,5 +1,5 @@ -ColoredCircle | goban

    Interface ColoredCircle

    interface ColoredCircle {
        border_color?: string;
        border_width?: number;
        color: string;
        move: JGOFIntersection;
    }

    Properties

    border_color? +ColoredCircle | goban

    Interface ColoredCircle

    interface ColoredCircle {
        border_color?: string;
        border_width?: number;
        color: string;
        move: JGOFIntersection;
    }

    Properties

    border_color?: string
    border_width?: number
    color: string
    \ No newline at end of file +

    Properties

    border_color?: string
    border_width?: number
    color: string
    \ No newline at end of file diff --git a/docs/interfaces/ConditionalMoveResponseTree.html b/docs/interfaces/ConditionalMoveResponseTree.html index 56f05ec6..d234cf44 100644 --- a/docs/interfaces/ConditionalMoveResponseTree.html +++ b/docs/interfaces/ConditionalMoveResponseTree.html @@ -1 +1 @@ -ConditionalMoveResponseTree | goban

    Interface ConditionalMoveResponseTree

    interface ConditionalMoveResponseTree {
        [move: string]: ConditionalMoveResponse;
    }

    Indexable

    [move: string]: ConditionalMoveResponse
    \ No newline at end of file +ConditionalMoveResponseTree | goban

    Interface ConditionalMoveResponseTree

    interface ConditionalMoveResponseTree {
        [move: string]: ConditionalMoveResponse;
    }

    Indexable

    [move: string]: ConditionalMoveResponse
    \ No newline at end of file diff --git a/docs/interfaces/GobanBounds.html b/docs/interfaces/GobanBounds.html index 95b10b4f..7d9eba9a 100644 --- a/docs/interfaces/GobanBounds.html +++ b/docs/interfaces/GobanBounds.html @@ -1,5 +1,5 @@ -GobanBounds | goban

    Interface GobanBounds

    interface GobanBounds {
        bottom: number;
        left: number;
        right: number;
        top: number;
    }

    Properties

    bottom +GobanBounds | goban

    Interface GobanBounds

    interface GobanBounds {
        bottom: number;
        left: number;
        right: number;
        top: number;
    }

    Properties

    Properties

    bottom: number
    left: number
    right: number
    top: number
    \ No newline at end of file +

    Properties

    bottom: number
    left: number
    right: number
    top: number
    \ No newline at end of file diff --git a/docs/interfaces/GobanCallbacks.html b/docs/interfaces/GobanCallbacks.html index 6405b746..e7eeedd6 100644 --- a/docs/interfaces/GobanCallbacks.html +++ b/docs/interfaces/GobanCallbacks.html @@ -1,4 +1,4 @@ -GobanCallbacks | goban

    Interface GobanCallbacks

    interface GobanCallbacks {
        addCoordinatesToChatInput?: ((coordinates) => void);
        canvasAllocationErrorHandler?: ((note, error, extra) => void);
        customBlackStoneColor?: (() => string);
        customBlackStoneUrl?: (() => string);
        customBlackTextColor?: (() => string);
        customBoardColor?: (() => string);
        customBoardLineColor?: (() => string);
        customBoardUrl?: (() => string);
        customWhiteStoneColor?: (() => string);
        customWhiteStoneUrl?: (() => string);
        customWhiteTextColor?: (() => string);
        defaultConfig?: (() => any);
        getCDNReleaseBase?: (() => string);
        getClockDrift?: (() => number);
        getCoordinateDisplaySystem?: (() => "A1" | "1-1");
        getLocation?: (() => string);
        getMoveTreeNumbering?: (() => "none" | "move-coordinates" | "move-number");
        getNetworkLatency?: (() => number);
        getSelectedThemes?: (() => GobanSelectedThemes);
        getShowMoveNumbers?: (() => boolean);
        getShowVariationMoveNumbers?: (() => boolean);
        getSoundEnabled?: (() => boolean);
        getSoundVolume?: (() => number);
        isAnalysisDisabled?: ((goban, perGameSettingAppliesToNonPlayers) => boolean);
        toast?: ((message_id, duration) => void);
        updateScoreEstimation?: ((est_winning_color, number_of_points) => void);
        watchSelectedThemes?: ((cb) => {
            remove: (() => any);
        });
    }

    Properties

    addCoordinatesToChatInput? +GobanCallbacks | goban

    Interface GobanCallbacks

    interface GobanCallbacks {
        addCoordinatesToChatInput?: ((coordinates) => void);
        canvasAllocationErrorHandler?: ((note, error, extra) => void);
        customBlackStoneColor?: (() => string);
        customBlackStoneUrl?: (() => string);
        customBlackTextColor?: (() => string);
        customBoardColor?: (() => string);
        customBoardLineColor?: (() => string);
        customBoardUrl?: (() => string);
        customWhiteStoneColor?: (() => string);
        customWhiteStoneUrl?: (() => string);
        customWhiteTextColor?: (() => string);
        defaultConfig?: (() => any);
        getCDNReleaseBase?: (() => string);
        getClockDrift?: (() => number);
        getCoordinateDisplaySystem?: (() => "A1" | "1-1");
        getLocation?: (() => string);
        getMoveTreeNumbering?: (() => "none" | "move-coordinates" | "move-number");
        getNetworkLatency?: (() => number);
        getSelectedThemes?: (() => GobanSelectedThemes);
        getShowMoveNumbers?: (() => boolean);
        getShowVariationMoveNumbers?: (() => boolean);
        getSoundEnabled?: (() => boolean);
        getSoundVolume?: (() => number);
        isAnalysisDisabled?: ((goban, perGameSettingAppliesToNonPlayers) => boolean);
        toast?: ((message_id, duration) => void);
        updateScoreEstimation?: ((est_winning_color, number_of_points) => void);
        watchSelectedThemes?: ((cb) => {
            remove: (() => any);
        });
    }

    Properties

    addCoordinatesToChatInput?: ((coordinates) => void)

    Type declaration

      • (coordinates): void
      • Parameters

        • coordinates: string

        Returns void

    canvasAllocationErrorHandler?: ((note, error, extra) => void)

    Type declaration

      • (note, error, extra): void
      • Parameters

        • note: null | string
        • error: Error
        • extra: {
              height?: string | number;
              total_allocations_made: number;
              total_pixels_allocated: number;
              width?: string | number;
          }
          • Optional height?: string | number
          • total_allocations_made: number
          • total_pixels_allocated: number
          • Optional width?: string | number

        Returns void

    customBlackStoneColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBlackStoneUrl?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBlackTextColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBoardColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBoardLineColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBoardUrl?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customWhiteStoneColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customWhiteStoneUrl?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customWhiteTextColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    defaultConfig?: (() => any)

    Type declaration

      • (): any
      • Returns any

    getCDNReleaseBase?: (() => string)

    Type declaration

      • (): string
      • Returns string

    getClockDrift?: (() => number)

    Type declaration

      • (): number
      • Returns number

    getCoordinateDisplaySystem?: (() => "A1" | "1-1")

    Type declaration

      • (): "A1" | "1-1"
      • Returns "A1" | "1-1"

    getLocation?: (() => string)

    Type declaration

      • (): string
      • Returns string

    getMoveTreeNumbering?: (() => "none" | "move-coordinates" | "move-number")

    Type declaration

      • (): "none" | "move-coordinates" | "move-number"
      • Returns "none" | "move-coordinates" | "move-number"

    getNetworkLatency?: (() => number)

    Type declaration

      • (): number
      • Returns number

    getSelectedThemes?: (() => GobanSelectedThemes)

    Type declaration

    getShowMoveNumbers?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    getShowVariationMoveNumbers?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    getSoundEnabled?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    getSoundVolume?: (() => number)

    Type declaration

      • (): number
      • Returns number

    isAnalysisDisabled?: ((goban, perGameSettingAppliesToNonPlayers) => boolean)

    Type declaration

      • (goban, perGameSettingAppliesToNonPlayers): boolean
      • Parameters

        • goban: GobanBase
        • perGameSettingAppliesToNonPlayers: boolean

        Returns boolean

    toast?: ((message_id, duration) => void)

    Type declaration

      • (message_id, duration): void
      • Parameters

        • message_id: string
        • duration: number

        Returns void

    updateScoreEstimation?: ((est_winning_color, number_of_points) => void)

    Type declaration

      • (est_winning_color, number_of_points): void
      • Parameters

        • est_winning_color: "black" | "white"
        • number_of_points: number

        Returns void

    watchSelectedThemes?: ((cb) => {
        remove: (() => any);
    })

    Type declaration

      • (cb): {
            remove: (() => any);
        }
      • Parameters

        Returns {
            remove: (() => any);
        }

        • remove: (() => any)
            • (): any
            • Returns any

    \ No newline at end of file +

    Properties

    addCoordinatesToChatInput?: ((coordinates) => void)

    Type declaration

      • (coordinates): void
      • Parameters

        • coordinates: string

        Returns void

    canvasAllocationErrorHandler?: ((note, error, extra) => void)

    Type declaration

      • (note, error, extra): void
      • Parameters

        • note: null | string
        • error: Error
        • extra: {
              height?: string | number;
              total_allocations_made: number;
              total_pixels_allocated: number;
              width?: string | number;
          }
          • Optional height?: string | number
          • total_allocations_made: number
          • total_pixels_allocated: number
          • Optional width?: string | number

        Returns void

    customBlackStoneColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBlackStoneUrl?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBlackTextColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBoardColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBoardLineColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customBoardUrl?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customWhiteStoneColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customWhiteStoneUrl?: (() => string)

    Type declaration

      • (): string
      • Returns string

    customWhiteTextColor?: (() => string)

    Type declaration

      • (): string
      • Returns string

    defaultConfig?: (() => any)

    Type declaration

      • (): any
      • Returns any

    getCDNReleaseBase?: (() => string)

    Type declaration

      • (): string
      • Returns string

    getClockDrift?: (() => number)

    Type declaration

      • (): number
      • Returns number

    getCoordinateDisplaySystem?: (() => "A1" | "1-1")

    Type declaration

      • (): "A1" | "1-1"
      • Returns "A1" | "1-1"

    getLocation?: (() => string)

    Type declaration

      • (): string
      • Returns string

    getMoveTreeNumbering?: (() => "none" | "move-coordinates" | "move-number")

    Type declaration

      • (): "none" | "move-coordinates" | "move-number"
      • Returns "none" | "move-coordinates" | "move-number"

    getNetworkLatency?: (() => number)

    Type declaration

      • (): number
      • Returns number

    getSelectedThemes?: (() => GobanSelectedThemes)

    Type declaration

    getShowMoveNumbers?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    getShowVariationMoveNumbers?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    getSoundEnabled?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    getSoundVolume?: (() => number)

    Type declaration

      • (): number
      • Returns number

    isAnalysisDisabled?: ((goban, perGameSettingAppliesToNonPlayers) => boolean)

    Type declaration

      • (goban, perGameSettingAppliesToNonPlayers): boolean
      • Parameters

        • goban: GobanBase
        • perGameSettingAppliesToNonPlayers: boolean

        Returns boolean

    toast?: ((message_id, duration) => void)

    Type declaration

      • (message_id, duration): void
      • Parameters

        • message_id: string
        • duration: number

        Returns void

    updateScoreEstimation?: ((est_winning_color, number_of_points) => void)

    Type declaration

      • (est_winning_color, number_of_points): void
      • Parameters

        • est_winning_color: "black" | "white"
        • number_of_points: number

        Returns void

    watchSelectedThemes?: ((cb) => {
        remove: (() => any);
    })

    Type declaration

      • (cb): {
            remove: (() => any);
        }
      • Parameters

        Returns {
            remove: (() => any);
        }

        • remove: (() => any)
            • (): any
            • Returns any

    \ No newline at end of file diff --git a/docs/interfaces/GobanCanvasInterface.html b/docs/interfaces/GobanCanvasInterface.html index 95490e1a..08cef288 100644 --- a/docs/interfaces/GobanCanvasInterface.html +++ b/docs/interfaces/GobanCanvasInterface.html @@ -1,4 +1,4 @@ -GobanCanvasInterface | goban

    Interface GobanCanvasInterface

    interface GobanCanvasInterface {
        engine: GobanEngine;
        move_tree_container?: HTMLElement;
        clearAnalysisDrawing(): void;
        clearMessage(): void;
        destroy(): void;
        disablePen(): void;
        drawPenMarks(pen_marks): void;
        drawSquare(i, j): void;
        enablePen(): void;
        move_tree_bindCanvasEvents(canvas): void;
        move_tree_redraw(no_warp?): void;
        setByoYomiLabel(label): void;
        setLastMoveOpacity(opacity): void;
        setMoveTreeContainer(container): void;
        showMessage(message_id_or_error, parameters?, timeout?): void;
    }

    Implemented by

    Properties

    engine +GobanCanvasInterface | goban

    Interface GobanCanvasInterface

    interface GobanCanvasInterface {
        engine: GobanEngine;
        move_tree_container?: HTMLElement;
        clearAnalysisDrawing(): void;
        clearMessage(): void;
        destroy(): void;
        disablePen(): void;
        drawPenMarks(pen_marks): void;
        drawSquare(i, j): void;
        enablePen(): void;
        move_tree_bindCanvasEvents(canvas): void;
        move_tree_redraw(no_warp?): void;
        setByoYomiLabel(label): void;
        setLastMoveOpacity(opacity): void;
        setMoveTreeContainer(container): void;
        showMessage(message_id_or_error, parameters?, timeout?): void;
    }

    Implemented by

    Properties

    engine: GobanEngine
    move_tree_container?: HTMLElement

    Methods

    • Parameters

      • message_id_or_error: MessageID
      • Optional parameters: {
            [key: string]: any;
        }
        • [key: string]: any
      • Optional timeout: number

      Returns void

    \ No newline at end of file +

    Properties

    engine: GobanEngine
    move_tree_container?: HTMLElement

    Methods

    • Parameters

      • message_id_or_error: MessageID
      • Optional parameters: {
            [key: string]: any;
        }
        • [key: string]: any
      • Optional timeout: number

      Returns void

    \ No newline at end of file diff --git a/docs/interfaces/GobanConfig.html b/docs/interfaces/GobanConfig.html index 97726089..98fde655 100644 --- a/docs/interfaces/GobanConfig.html +++ b/docs/interfaces/GobanConfig.html @@ -1,4 +1,4 @@ -GobanConfig | goban

    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);
        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;
        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;
        visual_undo_request_indicator?: boolean;
        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? +GobanConfig | goban

    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);
        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;
        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;
        visual_undo_request_indicator?: boolean;
        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?: 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_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;
    }[]

    Type declaration

    • 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)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isobranch_hash?: string
    komi?: number
    ladder?: number
    ladder_id?: number
    last_move_radius?: number
    latencies?: {
        [player_id: string]: number;
    }

    Type declaration

    • [player_id: string]: number
    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void
      • Returns void

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

    Type declaration

    • [mark: string]: string
    mode?: GobanModes
    move_tree?: MoveTreeJson
    name?: string
    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    -
    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
    ogs_import?: boolean

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

    -
    onError?: ((err) => void)

    Type declaration

      • (err): void
      • Parameters

        • err: Error

        Returns void

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

    Type declaration

      • (winning_color, points): void
      • Parameters

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

        Returns 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
    player_id?: number
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    }

    Type declaration

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

    Type declaration

    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[]

    Removed stones in stone removal phase +

    Properties

    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_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;
    }[]

    Type declaration

    • 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)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isobranch_hash?: string
    komi?: number
    ladder?: number
    ladder_id?: number
    last_move_radius?: number
    latencies?: {
        [player_id: string]: number;
    }

    Type declaration

    • [player_id: string]: number
    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void
      • Returns void

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

    Type declaration

    • [mark: string]: string
    mode?: GobanModes
    move_tree?: MoveTreeJson
    name?: string
    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    +
    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
    ogs_import?: boolean

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

    +
    onError?: ((err) => void)

    Type declaration

      • (err): void
      • Parameters

        • err: Error

        Returns void

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

    Type declaration

      • (winning_color, points): void
      • Parameters

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

        Returns 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
    player_id?: number
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    }

    Type declaration

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

    Type declaration

    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[]

    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

    -
    rengo?: boolean
    rengo_casual_mode?: boolean
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    }

    Type declaration

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

    Type declaration

    score?: Score
    score_handicap?: boolean
    score_passes?: boolean
    score_prisoners?: boolean
    score_stones?: boolean
    score_territory?: boolean
    score_territory_in_seki?: boolean
    spectator_log?: GobanChatLog
    square_size?: number | "auto" | ((goban) => number)

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    stalling_score_estimate?: StallingScoreEstimate
    start_time?: number
    strict_seki_mode?: boolean
    superko_algorithm?: GobanEngineSuperKoAlgorithm
    throw_all_errors?: boolean

    When loading initial state or moves, by default GobanEngine will try and +

    rengo?: boolean
    rengo_casual_mode?: boolean
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    }

    Type declaration

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

    Type declaration

    score?: Score
    score_handicap?: boolean
    score_passes?: boolean
    score_prisoners?: boolean
    score_stones?: boolean
    score_territory?: boolean
    score_territory_in_seki?: boolean
    spectator_log?: GobanChatLog
    square_size?: number | "auto" | ((goban) => number)

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    stalling_score_estimate?: StallingScoreEstimate
    start_time?: number
    strict_seki_mode?: boolean
    superko_algorithm?: GobanEngineSuperKoAlgorithm
    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.

    -
    time_control?: JGOFTimeControl
    time_per_move?: number
    tournament_id?: number
    username?: string
    variation_stone_opacity?: number
    visual_undo_request_indicator?: boolean
    white_must_pass_last?: boolean
    white_player_id?: number
    white_prisoners?: number
    width?: number
    winner?: number | "black" | "white"
    \ No newline at end of file +
    time_control?: JGOFTimeControl
    time_per_move?: number
    tournament_id?: number
    username?: string
    variation_stone_opacity?: number
    visual_undo_request_indicator?: boolean
    white_must_pass_last?: boolean
    white_player_id?: number
    white_prisoners?: number
    width?: number
    winner?: number | "black" | "white"
    \ No newline at end of file diff --git a/docs/interfaces/GobanEngineConfig.html b/docs/interfaces/GobanEngineConfig.html index 10d0c35b..08b93aed 100644 --- a/docs/interfaces/GobanEngineConfig.html +++ b/docs/interfaces/GobanEngineConfig.html @@ -1,4 +1,4 @@ -GobanEngineConfig | goban

    Interface GobanEngineConfig

    interface GobanEngineConfig {
        aga_handicap_scoring?: boolean;
        allow_ko?: boolean;
        allow_self_capture?: boolean;
        allow_superko?: boolean;
        automatic_stone_removal?: boolean;
        black_player_id?: number;
        black_prisoners?: number;
        board?: JGOFNumericPlayerColor[][];
        board_is_repeating?: boolean;
        clock?: GameClock;
        disable_analysis?: boolean;
        end_time?: number;
        errors?: {
            error: string;
            stack: any;
        }[];
        free_handicap_placement?: boolean;
        game_date?: string;
        game_id?: string | number;
        game_name?: string;
        group_ids?: number[];
        handicap?: number;
        handicap_rank_difference?: number;
        height?: number;
        initial_player?: PlayerColor;
        initial_state?: GobanEngineInitialState;
        isobranch_hash?: string;
        komi?: number;
        ladder?: number;
        ladder_id?: number;
        latencies?: {
            [player_id: string]: number;
        };
        marks?: {
            [mark: string]: string;
        };
        move_tree?: MoveTreeJson;
        moves?: GobanMovesArray;
        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;
        opponent_plays_first_after_resume?: boolean;
        original_disable_analysis?: boolean;
        original_sgf?: string;
        outcome?: string;
        phase?: GobanEnginePhase;
        player?: JGOFNumericPlayerColor;
        player_id?: number;
        player_pool?: {
            [id: number]: GobanEnginePlayerEntry;
        };
        players?: {
            black: GobanEnginePlayerEntry;
            white: GobanEnginePlayerEntry;
        };
        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;
        stalling_score_estimate?: StallingScoreEstimate;
        start_time?: number;
        strict_seki_mode?: boolean;
        superko_algorithm?: GobanEngineSuperKoAlgorithm;
        throw_all_errors?: boolean;
        time_control?: JGOFTimeControl;
        time_per_move?: number;
        tournament_id?: 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? +GobanEngineConfig | goban

    Interface GobanEngineConfig

    interface GobanEngineConfig {
        aga_handicap_scoring?: boolean;
        allow_ko?: boolean;
        allow_self_capture?: boolean;
        allow_superko?: boolean;
        automatic_stone_removal?: boolean;
        black_player_id?: number;
        black_prisoners?: number;
        board?: JGOFNumericPlayerColor[][];
        board_is_repeating?: boolean;
        clock?: GameClock;
        disable_analysis?: boolean;
        end_time?: number;
        errors?: {
            error: string;
            stack: any;
        }[];
        free_handicap_placement?: boolean;
        game_date?: string;
        game_id?: string | number;
        game_name?: string;
        group_ids?: number[];
        handicap?: number;
        handicap_rank_difference?: number;
        height?: number;
        initial_player?: PlayerColor;
        initial_state?: GobanEngineInitialState;
        isobranch_hash?: string;
        komi?: number;
        ladder?: number;
        ladder_id?: number;
        latencies?: {
            [player_id: string]: number;
        };
        marks?: {
            [mark: string]: string;
        };
        move_tree?: MoveTreeJson;
        moves?: GobanMovesArray;
        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;
        opponent_plays_first_after_resume?: boolean;
        original_disable_analysis?: boolean;
        original_sgf?: string;
        outcome?: string;
        phase?: GobanEnginePhase;
        player?: JGOFNumericPlayerColor;
        player_id?: number;
        player_pool?: {
            [id: number]: GobanEnginePlayerEntry;
        };
        players?: {
            black: GobanEnginePlayerEntry;
            white: GobanEnginePlayerEntry;
        };
        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;
        stalling_score_estimate?: StallingScoreEstimate;
        start_time?: number;
        strict_seki_mode?: boolean;
        superko_algorithm?: GobanEngineSuperKoAlgorithm;
        throw_all_errors?: boolean;
        time_control?: JGOFTimeControl;
        time_per_move?: number;
        tournament_id?: 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?: boolean
    allow_ko?: boolean
    allow_self_capture?: boolean
    allow_superko?: boolean
    automatic_stone_removal?: boolean
    black_player_id?: number
    black_prisoners?: number
    board_is_repeating?: boolean
    clock?: GameClock
    disable_analysis?: boolean
    end_time?: number
    errors?: {
        error: string;
        stack: any;
    }[]

    Type declaration

    • error: string
    • stack: any
    free_handicap_placement?: boolean
    game_date?: string
    game_id?: string | number
    game_name?: string
    group_ids?: number[]
    handicap?: number
    handicap_rank_difference?: number
    height?: number
    initial_player?: PlayerColor
    initial_state?: GobanEngineInitialState
    isobranch_hash?: string
    komi?: number
    ladder?: number
    ladder_id?: number
    latencies?: {
        [player_id: string]: number;
    }

    Type declaration

    • [player_id: string]: number
    marks?: {
        [mark: string]: string;
    }

    Type declaration

    • [mark: string]: string
    move_tree?: MoveTreeJson
    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    -
    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
    ogs_import?: boolean

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

    -
    opponent_plays_first_after_resume?: boolean
    original_disable_analysis?: boolean
    original_sgf?: string
    outcome?: string
    player_id?: number
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    }

    Type declaration

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

    Type declaration

    ranked?: boolean
    removal?: boolean[][]
    removed?: string | JGOFMove[]

    Removed stones in stone removal phase +

    Properties

    aga_handicap_scoring?: boolean
    allow_ko?: boolean
    allow_self_capture?: boolean
    allow_superko?: boolean
    automatic_stone_removal?: boolean
    black_player_id?: number
    black_prisoners?: number
    board_is_repeating?: boolean
    clock?: GameClock
    disable_analysis?: boolean
    end_time?: number
    errors?: {
        error: string;
        stack: any;
    }[]

    Type declaration

    • error: string
    • stack: any
    free_handicap_placement?: boolean
    game_date?: string
    game_id?: string | number
    game_name?: string
    group_ids?: number[]
    handicap?: number
    handicap_rank_difference?: number
    height?: number
    initial_player?: PlayerColor
    initial_state?: GobanEngineInitialState
    isobranch_hash?: string
    komi?: number
    ladder?: number
    ladder_id?: number
    latencies?: {
        [player_id: string]: number;
    }

    Type declaration

    • [player_id: string]: number
    marks?: {
        [mark: string]: string;
    }

    Type declaration

    • [mark: string]: string
    move_tree?: MoveTreeJson
    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    +
    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
    ogs_import?: boolean

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

    +
    opponent_plays_first_after_resume?: boolean
    original_disable_analysis?: boolean
    original_sgf?: string
    outcome?: string
    player_id?: number
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    }

    Type declaration

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

    Type declaration

    ranked?: boolean
    removal?: boolean[][]
    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

    -
    rengo?: boolean
    rengo_casual_mode?: boolean
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    }

    Type declaration

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

    Type declaration

    score?: Score
    score_handicap?: boolean
    score_passes?: boolean
    score_prisoners?: boolean
    score_stones?: boolean
    score_territory?: boolean
    score_territory_in_seki?: boolean
    stalling_score_estimate?: StallingScoreEstimate
    start_time?: number
    strict_seki_mode?: boolean
    superko_algorithm?: GobanEngineSuperKoAlgorithm
    throw_all_errors?: boolean

    When loading initial state or moves, by default GobanEngine will try and +

    rengo?: boolean
    rengo_casual_mode?: boolean
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    }

    Type declaration

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

    Type declaration

    score?: Score
    score_handicap?: boolean
    score_passes?: boolean
    score_prisoners?: boolean
    score_stones?: boolean
    score_territory?: boolean
    score_territory_in_seki?: boolean
    stalling_score_estimate?: StallingScoreEstimate
    start_time?: number
    strict_seki_mode?: boolean
    superko_algorithm?: GobanEngineSuperKoAlgorithm
    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.

    -
    time_control?: JGOFTimeControl
    time_per_move?: number
    tournament_id?: number
    white_must_pass_last?: boolean
    white_player_id?: number
    white_prisoners?: number
    width?: number
    winner?: number | "black" | "white"
    \ No newline at end of file +
    time_control?: JGOFTimeControl
    time_per_move?: number
    tournament_id?: number
    white_must_pass_last?: boolean
    white_player_id?: number
    white_prisoners?: number
    width?: number
    winner?: number | "black" | "white"
    \ No newline at end of file diff --git a/docs/interfaces/GobanEngineInitialState.html b/docs/interfaces/GobanEngineInitialState.html index dcfdaa97..f5bb6315 100644 --- a/docs/interfaces/GobanEngineInitialState.html +++ b/docs/interfaces/GobanEngineInitialState.html @@ -1,3 +1,3 @@ -GobanEngineInitialState | goban

    Interface GobanEngineInitialState

    interface GobanEngineInitialState {
        black?: string;
        white?: string;
    }

    Properties

    black? +GobanEngineInitialState | goban

    Interface GobanEngineInitialState

    interface GobanEngineInitialState {
        black?: string;
        white?: string;
    }

    Properties

    Properties

    black?: string
    white?: string
    \ No newline at end of file +

    Properties

    black?: string
    white?: string
    \ No newline at end of file diff --git a/docs/interfaces/GobanEnginePlayerEntry.html b/docs/interfaces/GobanEnginePlayerEntry.html index dca4651d..9af5c46e 100644 --- a/docs/interfaces/GobanEnginePlayerEntry.html +++ b/docs/interfaces/GobanEnginePlayerEntry.html @@ -1,4 +1,4 @@ -GobanEnginePlayerEntry | goban

    Interface GobanEnginePlayerEntry

    interface GobanEnginePlayerEntry {
        accepted_stones?: string;
        accepted_strict_seki_mode?: boolean;
        country?: string;
        id: number;
        name?: string;
        pro?: boolean;
        rank?: number;
        username: string;
    }

    Properties

    accepted_stones? +GobanEnginePlayerEntry | goban

    Interface GobanEnginePlayerEntry

    interface GobanEnginePlayerEntry {
        accepted_stones?: string;
        accepted_strict_seki_mode?: boolean;
        country?: string;
        id: number;
        name?: string;
        pro?: boolean;
        rank?: number;
        username: string;
    }

    Properties

    accepted_stones?: string

    The accepted stones for the stone removal phase that the player has accepted

    -
    accepted_strict_seki_mode?: boolean

    Whether or not the player has accepted scoring with strict seki mode on or not

    -
    country?: string
    id: number
    name?: string

    XXX: The server is using these, the client may or may not be, we need to normalize this

    -
    pro?: boolean
    rank?: number
    username: string
    \ No newline at end of file +
    accepted_strict_seki_mode?: boolean

    Whether or not the player has accepted scoring with strict seki mode on or not

    +
    country?: string
    id: number
    name?: string

    XXX: The server is using these, the client may or may not be, we need to normalize this

    +
    pro?: boolean
    rank?: number
    username: string
    \ No newline at end of file diff --git a/docs/interfaces/GobanEvents.html b/docs/interfaces/GobanEvents.html index 9783f25e..817f7898 100644 --- a/docs/interfaces/GobanEvents.html +++ b/docs/interfaces/GobanEvents.html @@ -1,4 +1,4 @@ -GobanEvents | goban

    Interface GobanEvents

    interface GobanEvents {
        advance-to-next-board: (() => void);
        analyze_subtool: ((d) => void);
        analyze_tool: ((d) => void);
        audio-capture-stones: ((obj) => void);
        audio-clock: ((event) => void);
        audio-disconnected: (() => void);
        audio-enter-stone-removal: (() => void);
        audio-game-ended: ((winner) => void);
        audio-game-paused: (() => void);
        audio-game-resumed: (() => void);
        audio-game-started: ((obj) => void);
        audio-other-player-disconnected: ((obj) => void);
        audio-other-player-reconnected: ((obj) => void);
        audio-pass: (() => void);
        audio-reconnected: (() => void);
        audio-resume-game-from-stone-removal: (() => void);
        audio-stone: ((obj) => void);
        audio-undo-granted: (() => void);
        audio-undo-requested: (() => void);
        auto-resign: ((obj) => void);
        captured-stones: ((obj) => void);
        chat: ((d) => void);
        chat-remove: ((ids) => void);
        chat-reset: (() => void);
        clear-auto-resign: ((obj) => void);
        clear-message: (() => void);
        clock: ((clock) => void);
        conditional-moves.updated: (() => void);
        cur_move: ((d) => void);
        cur_review_move: ((d) => void);
        destroy: (() => void);
        engine.updated: ((engine) => void);
        error: ((d) => void);
        gamedata: ((d) => void);
        last_official_move: ((d) => void);
        load: ((config) => void);
        mode: ((d) => void);
        move-made: (() => void);
        outcome: ((d) => void);
        paused: ((d) => void);
        phase: ((d) => void);
        played-by-click: ((player) => void);
        player-update: ((player) => void);
        puzzle-correct-answer: (() => void);
        puzzle-place: ((obj) => void);
        puzzle-wrong-answer: (() => void);
        review.load-end: (() => void);
        review.load-start: (() => void);
        review.sync-to-current-move: (() => void);
        review.updated: (() => void);
        review_controller_id: ((d) => void);
        review_owner_id: ((d) => void);
        rules: ((d) => void);
        score_estimate: ((d) => void);
        set-for-removal: {
            removed: boolean;
            x: number;
            y: number;
        };
        show-message: ((message) => void);
        stalling_score_estimate: ((data?) => void);
        state_text: ((state) => void);
        stone-removal.accepted: (() => void);
        stone-removal.needs-sealing: ((positions) => void);
        stone-removal.updated: (() => void);
        strict_seki_mode: ((d) => void);
        submit_move: ((d) => void);
        submitting-move: ((tf) => void);
        title: ((d) => void);
        undo_canceled: (() => void);
        undo_requested: ((d) => void);
        update: (() => void);
        winner: ((d) => void);
    }

    Hierarchy (view full)

    Properties

    advance-to-next-board +GobanEvents | goban

    Interface GobanEvents

    interface GobanEvents {
        advance-to-next-board: (() => void);
        analyze_subtool: ((d) => void);
        analyze_tool: ((d) => void);
        audio-capture-stones: ((obj) => void);
        audio-clock: ((event) => void);
        audio-disconnected: (() => void);
        audio-enter-stone-removal: (() => void);
        audio-game-ended: ((winner) => void);
        audio-game-paused: (() => void);
        audio-game-resumed: (() => void);
        audio-game-started: ((obj) => void);
        audio-other-player-disconnected: ((obj) => void);
        audio-other-player-reconnected: ((obj) => void);
        audio-pass: (() => void);
        audio-reconnected: (() => void);
        audio-resume-game-from-stone-removal: (() => void);
        audio-stone: ((obj) => void);
        audio-undo-granted: (() => void);
        audio-undo-requested: (() => void);
        auto-resign: ((obj) => void);
        captured-stones: ((obj) => void);
        chat: ((d) => void);
        chat-remove: ((ids) => void);
        chat-reset: (() => void);
        clear-auto-resign: ((obj) => void);
        clear-message: (() => void);
        clock: ((clock) => void);
        conditional-moves.updated: (() => void);
        cur_move: ((d) => void);
        cur_review_move: ((d) => void);
        destroy: (() => void);
        engine.updated: ((engine) => void);
        error: ((d) => void);
        gamedata: ((d) => void);
        last_official_move: ((d) => void);
        load: ((config) => void);
        mode: ((d) => void);
        move-made: (() => void);
        outcome: ((d) => void);
        paused: ((d) => void);
        phase: ((d) => void);
        played-by-click: ((player) => void);
        player-update: ((player) => void);
        puzzle-correct-answer: (() => void);
        puzzle-place: ((obj) => void);
        puzzle-wrong-answer: (() => void);
        review.load-end: (() => void);
        review.load-start: (() => void);
        review.sync-to-current-move: (() => void);
        review.updated: (() => void);
        review_controller_id: ((d) => void);
        review_owner_id: ((d) => void);
        rules: ((d) => void);
        score_estimate: ((d) => void);
        set-for-removal: {
            removed: boolean;
            x: number;
            y: number;
        };
        show-message: ((message) => void);
        stalling_score_estimate: ((data?) => void);
        state_text: ((state) => void);
        stone-removal.accepted: (() => void);
        stone-removal.needs-sealing: ((positions) => void);
        stone-removal.updated: (() => void);
        strict_seki_mode: ((d) => void);
        submit_move: ((d) => void);
        submitting-move: ((tf) => void);
        title: ((d) => void);
        undo_canceled: (() => void);
        undo_requested: ((d) => void);
        update: (() => void);
        winner: ((d) => void);
    }

    Hierarchy (view full)

    Properties

    advance-to-next-board: (() => void)

    Type declaration

      • (): void
      • Returns void

    analyze_subtool: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    analyze_tool: ((d) => void)

    Type declaration

    audio-capture-stones: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              already_captured: number;
              count: number;
          }
          • already_captured: number
          • count: number

        Returns void

    audio-clock: ((event) => void)

    Type declaration

    audio-disconnected: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-enter-stone-removal: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-game-ended: ((winner) => void)

    Type declaration

      • (winner): void
      • Parameters

        • winner: "black" | "white" | "tie"

        Returns void

    audio-game-paused: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-game-resumed: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-game-started: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              player_id: number;
          }
          • player_id: number

            Player to move

            -

        Returns void

    audio-other-player-disconnected: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              player_id: number;
          }
          • player_id: number

        Returns void

    audio-other-player-reconnected: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              player_id: number;
          }
          • player_id: number

        Returns void

    audio-pass: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-reconnected: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-resume-game-from-stone-removal: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-stone: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              color: "black" | "white";
              height: number;
              width: number;
              x: number;
              y: number;
          }
          • color: "black" | "white"
          • height: number
          • width: number
          • x: number
          • y: number

        Returns void

    audio-undo-granted: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-undo-requested: (() => void)

    Type declaration

      • (): void
      • Returns void

    auto-resign: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              expiration: number;
              game_id: number;
              player_id: number;
          }
          • expiration: number
          • game_id: number
          • player_id: number

        Returns void

    captured-stones: ((obj) => void)

    Type declaration

    chat: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: any

        Returns void

    chat-remove: ((ids) => void)

    Type declaration

      • (ids): void
      • Parameters

        • ids: {
              chat_ids: string[];
          }
          • chat_ids: string[]

        Returns void

    chat-reset: (() => void)

    Type declaration

      • (): void
      • Returns void

    clear-auto-resign: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              game_id: number;
              player_id: number;
          }
          • game_id: number
          • player_id: number

        Returns void

    clear-message: (() => void)

    Type declaration

      • (): void
      • Returns void

    clock: ((clock) => void)

    Type declaration

    conditional-moves.updated: (() => void)

    Type declaration

      • (): void
      • Returns void

    cur_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    cur_review_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    destroy: (() => void)

    Type declaration

      • (): void
      • Returns void

    engine.updated: ((engine) => void)

    Type declaration

      • (engine): void
      • Parameters

        Returns void

    error: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: any

        Returns void

    gamedata: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: any

        Returns void

    last_official_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    load: ((config) => void)

    Type declaration

      • (config): void
      • Parameters

        Returns void

    mode: ((d) => void)

    Type declaration

    move-made: (() => void)

    Type declaration

      • (): void
      • Returns void

    outcome: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    paused: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: boolean

        Returns void

    phase: ((d) => void)

    Type declaration

    played-by-click: ((player) => void)

    Type declaration

      • (player): void
      • Parameters

        • player: {
              player_id: number;
              x: number;
              y: number;
          }
          • player_id: number
          • x: number
          • y: number

        Returns void

    player-update: ((player) => void)

    Type declaration

    puzzle-correct-answer: (() => void)

    Type declaration

      • (): void
      • Returns void

    puzzle-place: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              color: "black" | "white";
              height: number;
              width: number;
              x: number;
              y: number;
          }
          • color: "black" | "white"
          • height: number
          • width: number
          • x: number
          • y: number

        Returns void

    puzzle-wrong-answer: (() => void)

    Type declaration

      • (): void
      • Returns void

    review.load-end: (() => void)

    Type declaration

      • (): void
      • Returns void

    review.load-start: (() => void)

    Type declaration

      • (): void
      • Returns void

    review.sync-to-current-move: (() => void)

    Type declaration

      • (): void
      • Returns void

    review.updated: (() => void)

    Type declaration

      • (): void
      • Returns void

    review_controller_id: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    review_owner_id: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    rules: ((d) => void)

    Type declaration

    score_estimate: ((d) => void)

    Type declaration

    set-for-removal: {
        removed: boolean;
        x: number;
        y: number;
    }

    Type declaration

    • removed: boolean
    • x: number
    • y: number
    show-message: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: {
              formatted: string;
              message_id: string;
              parameters?: {
                  [key: string]: any;
              };
          }
          • formatted: string
          • message_id: string
          • Optional parameters?: {
                [key: string]: any;
            }
            • [key: string]: any

        Returns void

    stalling_score_estimate: ((data?) => void)

    Type declaration

    state_text: ((state) => void)

    Type declaration

      • (state): void
      • Parameters

        • state: {
              show_moves_made_count?: boolean;
              title: string;
          }
          • Optional show_moves_made_count?: boolean
          • title: string

        Returns void

    stone-removal.accepted: (() => void)

    Type declaration

      • (): void
      • Returns void

    stone-removal.needs-sealing: ((positions) => void)

    Type declaration

    stone-removal.updated: (() => void)

    Type declaration

      • (): void
      • Returns void

    strict_seki_mode: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: boolean

        Returns void

    submit_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | (() => void)

        Returns void

    submitting-move: ((tf) => void)

    Type declaration

      • (tf): void
      • Parameters

        • tf: boolean

        Returns void

    title: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    undo_canceled: (() => void)

    Type declaration

      • (): void
      • Returns void

    undo_requested: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    update: (() => void)

    Type declaration

      • (): void
      • Returns void

    winner: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    \ No newline at end of file +

    Properties

    advance-to-next-board: (() => void)

    Type declaration

      • (): void
      • Returns void

    analyze_subtool: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    analyze_tool: ((d) => void)

    Type declaration

    audio-capture-stones: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              already_captured: number;
              count: number;
          }
          • already_captured: number
          • count: number

        Returns void

    audio-clock: ((event) => void)

    Type declaration

    audio-disconnected: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-enter-stone-removal: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-game-ended: ((winner) => void)

    Type declaration

      • (winner): void
      • Parameters

        • winner: "black" | "white" | "tie"

        Returns void

    audio-game-paused: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-game-resumed: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-game-started: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              player_id: number;
          }
          • player_id: number

            Player to move

            +

        Returns void

    audio-other-player-disconnected: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              player_id: number;
          }
          • player_id: number

        Returns void

    audio-other-player-reconnected: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              player_id: number;
          }
          • player_id: number

        Returns void

    audio-pass: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-reconnected: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-resume-game-from-stone-removal: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-stone: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              color: "black" | "white";
              height: number;
              width: number;
              x: number;
              y: number;
          }
          • color: "black" | "white"
          • height: number
          • width: number
          • x: number
          • y: number

        Returns void

    audio-undo-granted: (() => void)

    Type declaration

      • (): void
      • Returns void

    audio-undo-requested: (() => void)

    Type declaration

      • (): void
      • Returns void

    auto-resign: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              expiration: number;
              game_id: number;
              player_id: number;
          }
          • expiration: number
          • game_id: number
          • player_id: number

        Returns void

    captured-stones: ((obj) => void)

    Type declaration

    chat: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: any

        Returns void

    chat-remove: ((ids) => void)

    Type declaration

      • (ids): void
      • Parameters

        • ids: {
              chat_ids: string[];
          }
          • chat_ids: string[]

        Returns void

    chat-reset: (() => void)

    Type declaration

      • (): void
      • Returns void

    clear-auto-resign: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              game_id: number;
              player_id: number;
          }
          • game_id: number
          • player_id: number

        Returns void

    clear-message: (() => void)

    Type declaration

      • (): void
      • Returns void

    clock: ((clock) => void)

    Type declaration

    conditional-moves.updated: (() => void)

    Type declaration

      • (): void
      • Returns void

    cur_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    cur_review_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    destroy: (() => void)

    Type declaration

      • (): void
      • Returns void

    engine.updated: ((engine) => void)

    Type declaration

      • (engine): void
      • Parameters

        Returns void

    error: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: any

        Returns void

    gamedata: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: any

        Returns void

    last_official_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    load: ((config) => void)

    Type declaration

      • (config): void
      • Parameters

        Returns void

    mode: ((d) => void)

    Type declaration

    move-made: (() => void)

    Type declaration

      • (): void
      • Returns void

    outcome: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    paused: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: boolean

        Returns void

    phase: ((d) => void)

    Type declaration

    played-by-click: ((player) => void)

    Type declaration

      • (player): void
      • Parameters

        • player: {
              player_id: number;
              x: number;
              y: number;
          }
          • player_id: number
          • x: number
          • y: number

        Returns void

    player-update: ((player) => void)

    Type declaration

    puzzle-correct-answer: (() => void)

    Type declaration

      • (): void
      • Returns void

    puzzle-place: ((obj) => void)

    Type declaration

      • (obj): void
      • Parameters

        • obj: {
              color: "black" | "white";
              height: number;
              width: number;
              x: number;
              y: number;
          }
          • color: "black" | "white"
          • height: number
          • width: number
          • x: number
          • y: number

        Returns void

    puzzle-wrong-answer: (() => void)

    Type declaration

      • (): void
      • Returns void

    review.load-end: (() => void)

    Type declaration

      • (): void
      • Returns void

    review.load-start: (() => void)

    Type declaration

      • (): void
      • Returns void

    review.sync-to-current-move: (() => void)

    Type declaration

      • (): void
      • Returns void

    review.updated: (() => void)

    Type declaration

      • (): void
      • Returns void

    review_controller_id: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    review_owner_id: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    rules: ((d) => void)

    Type declaration

    score_estimate: ((d) => void)

    Type declaration

    set-for-removal: {
        removed: boolean;
        x: number;
        y: number;
    }

    Type declaration

    • removed: boolean
    • x: number
    • y: number
    show-message: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: {
              formatted: string;
              message_id: string;
              parameters?: {
                  [key: string]: any;
              };
          }
          • formatted: string
          • message_id: string
          • Optional parameters?: {
                [key: string]: any;
            }
            • [key: string]: any

        Returns void

    stalling_score_estimate: ((data?) => void)

    Type declaration

    state_text: ((state) => void)

    Type declaration

      • (state): void
      • Parameters

        • state: {
              show_moves_made_count?: boolean;
              title: string;
          }
          • Optional show_moves_made_count?: boolean
          • title: string

        Returns void

    stone-removal.accepted: (() => void)

    Type declaration

      • (): void
      • Returns void

    stone-removal.needs-sealing: ((positions) => void)

    Type declaration

    stone-removal.updated: (() => void)

    Type declaration

      • (): void
      • Returns void

    strict_seki_mode: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: boolean

        Returns void

    submit_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | (() => void)

        Returns void

    submitting-move: ((tf) => void)

    Type declaration

      • (tf): void
      • Parameters

        • tf: boolean

        Returns void

    title: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    undo_canceled: (() => void)

    Type declaration

      • (): void
      • Returns void

    undo_requested: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    update: (() => void)

    Type declaration

      • (): void
      • Returns void

    winner: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    \ No newline at end of file diff --git a/docs/interfaces/GobanIOErrorMessageObject.html b/docs/interfaces/GobanIOErrorMessageObject.html index b38ec25b..706f58c8 100644 --- a/docs/interfaces/GobanIOErrorMessageObject.html +++ b/docs/interfaces/GobanIOErrorMessageObject.html @@ -1,3 +1,3 @@ -GobanIOErrorMessageObject | goban

    Interface GobanIOErrorMessageObject

    interface GobanIOErrorMessageObject {
        message_id: "failed_to_load_sgf";
        url: string;
    }

    Properties

    message_id +GobanIOErrorMessageObject | goban

    Interface GobanIOErrorMessageObject

    interface GobanIOErrorMessageObject {
        message_id: "failed_to_load_sgf";
        url: string;
    }

    Properties

    Properties

    message_id: "failed_to_load_sgf"
    url: string
    \ No newline at end of file +

    Properties

    message_id: "failed_to_load_sgf"
    url: string
    \ No newline at end of file diff --git a/docs/interfaces/GobanMetrics.html b/docs/interfaces/GobanMetrics.html index 9b23b98a..d686963d 100644 --- a/docs/interfaces/GobanMetrics.html +++ b/docs/interfaces/GobanMetrics.html @@ -1,5 +1,5 @@ -GobanMetrics | goban

    Interface GobanMetrics

    interface GobanMetrics {
        height: number;
        mid: number;
        offset: number;
        width: number;
    }

    Properties

    height +GobanMetrics | goban

    Interface GobanMetrics

    interface GobanMetrics {
        height: number;
        mid: number;
        offset: number;
        width: number;
    }

    Properties

    Properties

    height: number
    mid: number
    offset: number
    width: number
    \ No newline at end of file +

    Properties

    height: number
    mid: number
    offset: number
    width: number
    \ No newline at end of file diff --git a/docs/interfaces/GobanMoveErrorMessageObject.html b/docs/interfaces/GobanMoveErrorMessageObject.html index f32d211f..78aebc8e 100644 --- a/docs/interfaces/GobanMoveErrorMessageObject.html +++ b/docs/interfaces/GobanMoveErrorMessageObject.html @@ -1,4 +1,4 @@ -GobanMoveErrorMessageObject | goban

    Interface GobanMoveErrorMessageObject

    interface GobanMoveErrorMessageObject {
        coords: string;
        message_id: GobanMoveErrorMessageId;
        move_number: number;
    }

    Properties

    coords +GobanMoveErrorMessageObject | goban

    Interface GobanMoveErrorMessageObject

    interface GobanMoveErrorMessageObject {
        coords: string;
        message_id: GobanMoveErrorMessageId;
        move_number: number;
    }

    Properties

    coords: string
    move_number: number
    \ No newline at end of file +

    Properties

    coords: string
    move_number: number
    \ No newline at end of file diff --git a/docs/interfaces/GobanSelectedThemes.html b/docs/interfaces/GobanSelectedThemes.html index 1c67e6fb..b5674e89 100644 --- a/docs/interfaces/GobanSelectedThemes.html +++ b/docs/interfaces/GobanSelectedThemes.html @@ -1,4 +1,4 @@ -GobanSelectedThemes | goban

    Interface GobanSelectedThemes

    interface GobanSelectedThemes {
        black: string;
        board: string;
        white: string;
    }

    Properties

    black +GobanSelectedThemes | goban

    Interface GobanSelectedThemes

    interface GobanSelectedThemes {
        black: string;
        board: string;
        white: string;
    }

    Properties

    Properties

    black: string
    board: string
    white: string
    \ No newline at end of file +

    Properties

    black: string
    board: string
    white: string
    \ No newline at end of file diff --git a/docs/interfaces/GobanSocketEvents.html b/docs/interfaces/GobanSocketEvents.html index fefb1d40..1b0e3a18 100644 --- a/docs/interfaces/GobanSocketEvents.html +++ b/docs/interfaces/GobanSocketEvents.html @@ -1,4 +1,4 @@ -GobanSocketEvents | goban

    Interface GobanSocketEvents

    interface GobanSocketEvents {
        ERROR: ((data) => void);
        HUP: (() => void);
        active-bots: ((data) => void);
        active_game: ((data) => void);
        automatch/cancel: ((data) => void);
        automatch/entry: ((data) => void);
        automatch/start: ((data) => void);
        chat-join: ((data) => void);
        chat-message: ((data) => void);
        chat-message-removed: ((data) => void);
        chat-part: ((data) => void);
        chat-topic: ((data) => void);
        chat-update-user: ((data) => void);
        connect: (() => void);
        disconnect: ((code) => void);
        game/:id/auto_resign: ((data) => void);
        game/:id/chat: ((data) => void);
        game/:id/chat/remove: ((data) => void);
        game/:id/clear_auto_resign: ((data) => void);
        game/:id/clock: ((data) => void);
        game/:id/conditional_moves: ((data) => void);
        game/:id/error: ((data) => void);
        game/:id/gamedata: ((data) => void);
        game/:id/latency: ((data) => void);
        game/:id/phase: ((data) => void);
        game/:id/removed_stones: ((data) => void);
        game/:id/removed_stones_accepted: ((data) => void);
        game/:id/reset-chats: (() => void);
        game/:id/stalling_score_estimate: ((data?) => void);
        game/:id/undo_accepted: ((data) => void);
        game/:id/undo_canceled: ((data) => void);
        game/:id/undo_requested: ((data) => void);
        gamelist-count: ((data) => void);
        gamelist-count-:channel: ((data) => void);
        hostinfo: ((data) => void);
        incident-report: ((data) => void);
        itc: ((data) => void);
        latency: ((latency, clock_drift) => void);
        net/pong: ((data) => void);
        notification: ((data) => void);
        private-message: ((data) => void);
        private-superchat: ((data) => void);
        reconnect: (() => void);
        remote_storage/sync_complete: (() => void);
        remote_storage/update: ((data) => void);
        review/:id/full_state: ((data) => void);
        review/:id/r: ((data) => void);
        score-estimator-enabled-state: ((data) => void);
        seekgraph/global: ((messages) => void);
        timeout: (() => void);
        ui-push: ((data) => void);
        unrecoverable_error: ((code, tag, message) => void);
        user/jwt: ((jwt) => void);
        user/state: ((data) => void);
        user/update: ((user) => void);
    }

    Hierarchy (view full)

    Properties

    ERROR +GobanSocketEvents | goban

    Interface GobanSocketEvents

    interface GobanSocketEvents {
        ERROR: ((data) => void);
        HUP: (() => void);
        active-bots: ((data) => void);
        active_game: ((data) => void);
        automatch/cancel: ((data) => void);
        automatch/entry: ((data) => void);
        automatch/start: ((data) => void);
        chat-join: ((data) => void);
        chat-message: ((data) => void);
        chat-message-removed: ((data) => void);
        chat-part: ((data) => void);
        chat-topic: ((data) => void);
        chat-update-user: ((data) => void);
        connect: (() => void);
        disconnect: ((code) => void);
        game/:id/auto_resign: ((data) => void);
        game/:id/chat: ((data) => void);
        game/:id/chat/remove: ((data) => void);
        game/:id/clear_auto_resign: ((data) => void);
        game/:id/clock: ((data) => void);
        game/:id/conditional_moves: ((data) => void);
        game/:id/error: ((data) => void);
        game/:id/gamedata: ((data) => void);
        game/:id/latency: ((data) => void);
        game/:id/phase: ((data) => void);
        game/:id/removed_stones: ((data) => void);
        game/:id/removed_stones_accepted: ((data) => void);
        game/:id/reset-chats: (() => void);
        game/:id/stalling_score_estimate: ((data?) => void);
        game/:id/undo_accepted: ((data) => void);
        game/:id/undo_canceled: ((data) => void);
        game/:id/undo_requested: ((data) => void);
        gamelist-count: ((data) => void);
        gamelist-count-:channel: ((data) => void);
        hostinfo: ((data) => void);
        incident-report: ((data) => void);
        itc: ((data) => void);
        latency: ((latency, clock_drift) => void);
        net/pong: ((data) => void);
        notification: ((data) => void);
        private-message: ((data) => void);
        private-superchat: ((data) => void);
        reconnect: (() => void);
        remote_storage/sync_complete: (() => void);
        remote_storage/update: ((data) => void);
        review/:id/full_state: ((data) => void);
        review/:id/r: ((data) => void);
        score-estimator-enabled-state: ((data) => void);
        seekgraph/global: ((messages) => void);
        timeout: (() => void);
        ui-push: ((data) => void);
        unrecoverable_error: ((code, tag, message) => void);
        user/jwt: ((jwt) => void);
        user/state: ((data) => void);
        user/update: ((user) => void);
    }

    Hierarchy (view full)

    Properties

    ERROR HUP active-bots active_game @@ -56,16 +56,16 @@

    Properties

    ERROR: ((data) => void)

    An error occurred, the message string should be displayed to the user. For a list of errcode's used, see https://github.com/online-go/online-go.com/blob/devel/src/components/Errcode/Errcode.tsx

    -

    Type declaration

      • (data): void
      • Parameters

        • data: string | {
              errcode: string;
          }

        Returns void

    HUP: (() => void)

    The client should reload

    -

    Type declaration

      • (): void
      • Returns void

    active-bots: ((data) => void)

    Updates the list of bots that are connected and ready to the server

    -

    Type declaration

      • (data): void
      • Parameters

        • data: {
              [id: number]: User;
          }

        Returns void

    active_game: ((data) => void)

    Message to inform the client of an active game, or a change to an existing game

    -

    Type declaration

    automatch/cancel: ((data) => void)

    An automatch request was canceled

    -

    Type declaration

      • (data): void
      • Parameters

        • data: {
              uuid: string;
          }
          • uuid: string

        Returns void

    automatch/entry: ((data) => void)

    An automatch request is active

    -

    Type declaration

    automatch/start: ((data) => void)

    An automatch request was started

    -

    Type declaration

      • (data): void
      • Parameters

        • data: {
              game_id: number;
              uuid: string;
          }
          • game_id: number
          • uuid: string

        Returns void

    chat-join: ((data) => void)

    User(s) joined a chat channel

    +

    Type declaration

      • (data): void
      • Parameters

        • data: string | {
              errcode: string;
          }

        Returns void

    HUP: (() => void)

    The client should reload

    +

    Type declaration

      • (): void
      • Returns void

    active-bots: ((data) => void)

    Updates the list of bots that are connected and ready to the server

    +

    Type declaration

      • (data): void
      • Parameters

        • data: {
              [id: number]: User;
          }

        Returns void

    active_game: ((data) => void)

    Message to inform the client of an active game, or a change to an existing game

    +

    Type declaration

    automatch/cancel: ((data) => void)

    An automatch request was canceled

    +

    Type declaration

      • (data): void
      • Parameters

        • data: {
              uuid: string;
          }
          • uuid: string

        Returns void

    automatch/entry: ((data) => void)

    An automatch request is active

    +

    Type declaration

    automatch/start: ((data) => void)

    An automatch request was started

    +

    Type declaration

      • (data): void
      • Parameters

        • data: {
              game_id: number;
              uuid: string;
          }
          • game_id: number
          • uuid: string

        Returns void

    chat-join: ((data) => void)

    User(s) joined a chat channel

    Type declaration

      • (data): void
      • Parameters

        • data: {
              channel: string;
              users: User[];
          }
          • channel: string

            The channel

          • users: User[]

            List of users that joined

            -

        Returns void

    chat-message: ((data) => void)

    Chat message was received

    +

    Returns void

    chat-message: ((data) => void)

    Chat message was received

    Type declaration

      • (data): void
      • Parameters

        • data: {
              channel: string;
              country?: string;
              id: number;
              message: {
                  i?: string;
                  m: string;
                  t: number;
              };
              professional: boolean;
              ranking: number;
              system?: true;
              system_message_type?: "flood";
              ui_class: string;
              username: string;
          }
          • channel: string

            The channel

          • Optional country?: string

            Country the user is from

          • id: number

            User id of the sender

            @@ -78,14 +78,14 @@
          • Optional system?: true

            Whether it's a system message or not

          • Optional system_message_type?: "flood"
          • ui_class: string

            UI class of the sender

          • username: string

            Username of the sender

            -

        Returns void

    chat-message-removed: ((data) => void)

    A chat message should be removed from the display

    +

    Returns void

    chat-message-removed: ((data) => void)

    A chat message should be removed from the display

    Type declaration

      • (data): void
      • Parameters

        • data: {
              channel: string;
              uuid: string;
          }
          • channel: string

            The channel

          • uuid: string

            Message id. Note, despite the name, I don't think this is always a uuid in uuid format, just treat it as a string.

            -

        Returns void

    chat-part: ((data) => void)

    User left a chat channel

    +

    Returns void

    chat-part: ((data) => void)

    User left a chat channel

    Type declaration

    chat-topic: ((data) => void)

    Channel topic was updated

    +

    Returns void

    chat-topic: ((data) => void)

    Channel topic was updated

    Type declaration

    chat-update-user: ((data) => void)

    A user's profile was updated

    +

    Returns void

    chat-update-user: ((data) => void)

    A user's profile was updated

    Type declaration

    connect: (() => void)

    Type declaration

    disconnect: ((code) => void)

    Type declaration

    game/:id/auto_resign: ((data) => void)

    Informs the client the player is scheduled to resign if not cleared

    +

    Returns void

    connect: (() => void)

    Type declaration

    disconnect: ((code) => void)

    Type declaration

    game/:id/auto_resign: ((data) => void)

    Informs the client the player is scheduled to resign if not cleared

    Type declaration

    game/:id/chat: ((data) => void)

    A game chat message

    -

    Type declaration

    game/:id/chat/remove: ((data) => void)

    Game chat lines should be removed

    +

    Returns void

    game/:id/chat: ((data) => void)

    A game chat message

    +

    Type declaration

    game/:id/chat/remove: ((data) => void)

    Game chat lines should be removed

    Type declaration

    game/:id/clear_auto_resign: ((data) => void)

    The auto resign for the given player has been cleared

    +

    Returns void

    game/:id/clear_auto_resign: ((data) => void)

    The auto resign for the given player has been cleared

    Type declaration

    game/:id/clock: ((data) => void)

    Game clock update

    -

    Type declaration

    game/:id/conditional_moves: ((data) => void)

    Update the conditional moves currently active

    +

    Returns void

    game/:id/clock: ((data) => void)

    Game clock update

    +

    Type declaration

    game/:id/conditional_moves: ((data) => void)

    Update the conditional moves currently active

    Type declaration

    game/:id/error: ((data) => void)

    Error that should be displayed to the user

    -

    Type declaration

    game/:id/gamedata: ((data) => void)

    Update the entire game state

    -

    Type declaration

    game/:id/latency: ((data) => void)

    Update latency information for a player

    +

    Returns void

    game/:id/error: ((data) => void)

    Error that should be displayed to the user

    +

    Type declaration

    game/:id/gamedata: ((data) => void)

    Update the entire game state

    +

    Type declaration

    game/:id/latency: ((data) => void)

    Update latency information for a player

    Type declaration

    game/:id/phase: ((data) => void)

    The phase has changed for the game

    -

    Type declaration

    game/:id/removed_stones: ((data) => void)

    Update the state of the stone removal phase

    -

    Type declaration

    game/:id/removed_stones_accepted: ((data) => void)

    The stone removal phase has been completed, this is the final state and +

    Returns void

    game/:id/phase: ((data) => void)

    The phase has changed for the game

    +

    Type declaration

    game/:id/removed_stones: ((data) => void)

    Update the state of the stone removal phase

    +

    Type declaration

    game/:id/removed_stones_accepted: ((data) => void)

    The stone removal phase has been completed, this is the final state and indicates a phase change to the given phase (should always be "finished")

    Type declaration

    game/:id/reset-chats: (() => void)

    The chat log should be reset.

    -

    Type declaration

    game/:id/stalling_score_estimate: ((data?) => void)

    A score estimation result has been broadcast, this is used for avoiding game stalling

    -

    Type declaration

    game/:id/undo_accepted: ((data) => void)

    Undo move has been accepted, the parameter is the new move number

    -

    Type declaration

    game/:id/undo_canceled: ((data) => void)

    Undo request has been canceled, the parameter is the move number of the original request

    -

    Type declaration

    game/:id/undo_requested: ((data) => void)

    Undo request has been requested, the parameter is the move number that we want to go back to

    -

    Type declaration

    gamelist-count: ((data) => void)

    Update number of live and correspondence games are currently being +

    Returns void

    game/:id/reset-chats: (() => void)

    The chat log should be reset.

    +

    Type declaration

    game/:id/stalling_score_estimate: ((data?) => void)

    A score estimation result has been broadcast, this is used for avoiding game stalling

    +

    Type declaration

    game/:id/undo_accepted: ((data) => void)

    Undo move has been accepted, the parameter is the new move number

    +

    Type declaration

    game/:id/undo_canceled: ((data) => void)

    Undo request has been canceled, the parameter is the move number of the original request

    +

    Type declaration

    game/:id/undo_requested: ((data) => void)

    Undo request has been requested, the parameter is the move number that we want to go back to

    +

    Type declaration

    gamelist-count: ((data) => void)

    Update number of live and correspondence games are currently being played

    Type declaration

    gamelist-count-:channel: ((data) => void)

    Update number of live and correspondence games are currently being +

    Returns void

    gamelist-count-:channel: ((data) => void)

    Update number of live and correspondence games are currently being played in a particular channel

    Type declaration

    hostinfo: ((data) => void)

    General host information for the termination server you +

    Returns void

    hostinfo: ((data) => void)

    General host information for the termination server you are connected to. This is a response to the hostinfo client message.

    Type declaration

    incident-report: ((data) => void)

    Incident report update

    -

    Type declaration

    itc: ((data) => void)

    "Inter Tab Communication" message. This is a client utility to enable +

    Returns void

    incident-report: ((data) => void)

    Incident report update

    +

    Type declaration

    itc: ((data) => void)

    "Inter Tab Communication" message. This is a client utility to enable relaying of messages between devices - the event and data are application defined, the server blindly relays to all connected devices for the sending user. Note this is relayed to all devices regardless @@ -168,17 +168,17 @@ the web client sending this will arrive on an android and ios instance)

    Type declaration

    latency: ((latency, clock_drift) => void)

    Type declaration

    net/pong: ((data) => void)

    Pong response from a ping

    +

    Returns void

    latency: ((latency, clock_drift) => void)

    Type declaration

    net/pong: ((data) => void)

    Pong response from a ping

    Type declaration

    notification: ((data) => void)

    A notification that should be displayed to the user +

    Returns void

    notification: ((data) => void)

    A notification that should be displayed to the user These are not strongly modeled, see https://github.com/online-go/online-go.com/blob/devel/src/components/Notifications/Notifications.tsx as a reference for what types there are and what data they contain

    Type declaration

    private-message: ((data) => void)

    A private message was received

    +

    Returns void

    private-message: ((data) => void)

    A private message was received

    Type declaration

    private-superchat: ((data) => void)

    Notify the client that a private message "super chat" has started. A +

    Returns void

    private-superchat: ((data) => void)

    Notify the client that a private message "super chat" has started. A super chat is an undismissable chat sent by a moderator. It should take all focus and not let the client do anything until the conversation is resolved (the enable flag is set to false)

    @@ -199,30 +199,30 @@
  • moderator_username: string

    The moderator username contacting the player

  • player_id: number

    Your id

  • player_username: string

    Your username

    -
  • Returns void

    reconnect: (() => void)

    Type declaration

    remote_storage/sync_complete: (() => void)

    Notification that the server has completed sending all remote storage +

    Returns void

    reconnect: (() => void)

    Type declaration

    remote_storage/sync_complete: (() => void)

    Notification that the server has completed sending all remote storage data and the client should now be up to date.

    -

    Type declaration

    remote_storage/update: ((data) => void)

    Updates a key value pair

    +

    Type declaration

    remote_storage/update: ((data) => void)

    Updates a key value pair

    Type declaration

    review/:id/full_state: ((data) => void)

    Replay of the entire full state of the review

    -

    Type declaration

    review/:id/r: ((data) => void)

    An incremental modification to the review stream

    -

    Type declaration

    score-estimator-enabled-state: ((data) => void)

    Notifies the client whether the the client shares an IP with one of the +

    Returns void

    review/:id/full_state: ((data) => void)

    Replay of the entire full state of the review

    +

    Type declaration

    review/:id/r: ((data) => void)

    An incremental modification to the review stream

    +

    Type declaration

    score-estimator-enabled-state: ((data) => void)

    Notifies the client whether the the client shares an IP with one of the players of the game. This is used to disable the score estimator in anonymous browsing windows for players of a game when the score estimator is disabled for the game.

    Type declaration

    seekgraph/global: ((messages) => void)

    Type declaration

    timeout: (() => void)

    Type declaration

    ui-push: ((data) => void)

    A UI Push notification. The event and data are not well defined here, +

    Returns void

    seekgraph/global: ((messages) => void)

    Type declaration

    timeout: (() => void)

    Type declaration

    ui-push: ((data) => void)

    A UI Push notification. The event and data are not well defined here, they come as a result to subscribing to ui push channels with ui-pushes/subscribe.

    Type declaration

    unrecoverable_error: ((code, tag, message) => void)

    Type declaration

    user/jwt: ((jwt) => void)

    Update the user's JWT token

    -

    Type declaration

    user/state: ((data) => void)

    Updates whether a user is online or not. Subscribe to these updates for +

    Returns void

    unrecoverable_error: ((code, tag, message) => void)

    Type declaration

    user/jwt: ((jwt) => void)

    Update the user's JWT token

    +

    Type declaration

    user/state: ((data) => void)

    Updates whether a user is online or not. Subscribe to these updates for particular users using the user/monitor command.

    -

    Type declaration

    user/update: ((user) => void)

    Update user information. For other players, this has the standard User +

    Type declaration

    user/update: ((user) => void)

    Update user information. For other players, this has the standard User fields, when this is the current user, it can have additional fields that are found in the ui/config

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/docs/interfaces/GobanThemeBackgroundCSS.html b/docs/interfaces/GobanThemeBackgroundCSS.html index 8ca582d2..32e6843d 100644 --- a/docs/interfaces/GobanThemeBackgroundCSS.html +++ b/docs/interfaces/GobanThemeBackgroundCSS.html @@ -1,4 +1,4 @@ -GobanThemeBackgroundCSS | goban

    Interface GobanThemeBackgroundCSS

    interface GobanThemeBackgroundCSS {
        background-color?: string;
        background-image?: string;
        background-size?: string;
    }

    Properties

    background-color? +GobanThemeBackgroundCSS | goban

    Interface GobanThemeBackgroundCSS

    interface GobanThemeBackgroundCSS {
        background-color?: string;
        background-image?: string;
        background-size?: string;
    }

    Properties

    background-color?: string
    background-image?: string
    background-size?: string
    \ No newline at end of file +

    Properties

    background-color?: string
    background-image?: string
    background-size?: string
    \ No newline at end of file diff --git a/docs/interfaces/GobanThemeBackgroundReactStyles.html b/docs/interfaces/GobanThemeBackgroundReactStyles.html index d6388c2d..e63c6370 100644 --- a/docs/interfaces/GobanThemeBackgroundReactStyles.html +++ b/docs/interfaces/GobanThemeBackgroundReactStyles.html @@ -1,4 +1,4 @@ -GobanThemeBackgroundReactStyles | goban

    Interface GobanThemeBackgroundReactStyles

    interface GobanThemeBackgroundReactStyles {
        backgroundColor?: string;
        backgroundImage?: string;
        backgroundSize?: string;
    }

    Properties

    backgroundColor? +GobanThemeBackgroundReactStyles | goban

    Interface GobanThemeBackgroundReactStyles

    interface GobanThemeBackgroundReactStyles {
        backgroundColor?: string;
        backgroundImage?: string;
        backgroundSize?: string;
    }

    Properties

    backgroundColor?: string
    backgroundImage?: string
    backgroundSize?: string
    \ No newline at end of file +

    Properties

    backgroundColor?: string
    backgroundImage?: string
    backgroundSize?: string
    \ No newline at end of file diff --git a/docs/interfaces/JGOF.html b/docs/interfaces/JGOF.html index 4b375a0b..d35c5a42 100644 --- a/docs/interfaces/JGOF.html +++ b/docs/interfaces/JGOF.html @@ -1,14 +1,14 @@ JGOF | goban

    Interface JGOF

    JGOF (JSON Go Format) is an attempt at normalizing the AdHocFormat.

    -
    interface JGOF {
        ai_reviews?: {
            [id: string]: JGOFAIReview;
        };
        black?: JGOFPlayer | JGOFPlayer[];
        clock?: JGOFClock;
        jgof: 1;
        time_control?: JGOFTimeControl;
        white?: JGOFPlayer | JGOFPlayer[];
    }

    Properties

    interface JGOF {
        ai_reviews?: {
            [id: string]: JGOFAIReview;
        };
        black?: JGOFPlayer | JGOFPlayer[];
        clock?: JGOFClock;
        jgof: 1;
        time_control?: JGOFTimeControl;
        white?: JGOFPlayer | JGOFPlayer[];
    }

    Properties

    ai_reviews?: {
        [id: string]: JGOFAIReview;
    }

    AI Review information computed for this game

    -

    Type declaration

    Player information for those playing Black

    -
    clock?: JGOFClock

    Current clock information, this is used for ongoing games

    -
    jgof: 1

    JGOF version number

    -
    time_control?: JGOFTimeControl

    Time control settings for the game

    -

    Player information for those playing White

    -
    \ No newline at end of file +

    Type declaration

    black?: JGOFPlayer | JGOFPlayer[]

    Player information for those playing Black

    +
    clock?: JGOFClock

    Current clock information, this is used for ongoing games

    +
    jgof: 1

    JGOF version number

    +
    time_control?: JGOFTimeControl

    Time control settings for the game

    +
    white?: JGOFPlayer | JGOFPlayer[]

    Player information for those playing White

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFAIReview.html b/docs/interfaces/JGOFAIReview.html index f6bf07d0..d5eabf8d 100644 --- a/docs/interfaces/JGOFAIReview.html +++ b/docs/interfaces/JGOFAIReview.html @@ -1,5 +1,5 @@ JGOFAIReview | goban

    Interface JGOFAIReview


    -
    interface JGOFAIReview {
        analyzed_variations?: {
            [var_key: string]: JGOFAIReviewMove;
        };
        date: number;
        engine: string;
        engine_version: string;
        error?: {
            coords: string;
            message_id: GobanMoveErrorMessageId;
            move_number: number;
        };
        id: string;
        moves: {
            [move_number: string]: JGOFAIReviewMove;
        };
        network: string;
        network_size: string;
        scores?: number[];
        strength: number;
        type: "fast" | "full";
        uuid: string;
        win_rate: number;
        win_rates?: number[];
    }

    Properties

    interface JGOFAIReview {
        analyzed_variations?: {
            [var_key: string]: JGOFAIReviewMove;
        };
        date: number;
        engine: string;
        engine_version: string;
        error?: {
            coords: string;
            message_id: GobanMoveErrorMessageId;
            move_number: number;
        };
        id: string;
        moves: {
            [move_number: string]: JGOFAIReviewMove;
        };
        network: string;
        network_size: string;
        scores?: number[];
        strength: number;
        type: "fast" | "full";
        uuid: string;
        win_rate: number;
        win_rates?: number[];
    }

    Properties

    analyzed_variations?: {
        [var_key: string]: JGOFAIReviewMove;
    }

    Analysis of variations in the game.

    -

    Type declaration

    date: number

    millisecond epoch time (ms from 1970 UTC)

    -
    engine: string
    engine_version: string
    error?: {
        coords: string;
        message_id: GobanMoveErrorMessageId;
        move_number: number;
    }

    If there was an error processing the review, it can be stored here

    -

    Type declaration

    id: string
    moves: {
        [move_number: string]: JGOFAIReviewMove;
    }

    Analysis of moves in the game.

    -

    Type declaration

    network: string
    network_size: string
    scores?: number[]

    predicted scores that black will win or lose by (negative for loss) for all moves

    -
    strength: number
    type: "fast" | "full"

    A fast review typically only has a few moves reviewed, whereas a full +

    Type declaration

    date: number

    millisecond epoch time (ms from 1970 UTC)

    +
    engine: string
    engine_version: string
    error?: {
        coords: string;
        message_id: GobanMoveErrorMessageId;
        move_number: number;
    }

    If there was an error processing the review, it can be stored here

    +

    Type declaration

    id: string
    moves: {
        [move_number: string]: JGOFAIReviewMove;
    }

    Analysis of moves in the game.

    +

    Type declaration

    network: string
    network_size: string
    scores?: number[]

    predicted scores that black will win or lose by (negative for loss) for all moves

    +
    strength: number
    type: "fast" | "full"

    A fast review typically only has a few moves reviewed, whereas a full review is expected to have every move reviewed. Note that this sets an expectation but not a requirement on what values are stored in moves, and while games are being reviewed these objects will have zero or more entries in moves regardless of the type.

    -
    uuid: string
    win_rate: number

    predicted probability that black will win the last move

    -
    win_rates?: number[]

    predicted probability that black will win for all moves

    -
    \ No newline at end of file +
    uuid: string
    win_rate: number

    predicted probability that black will win the last move

    +
    win_rates?: number[]

    predicted probability that black will win for all moves

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFAIReviewMove.html b/docs/interfaces/JGOFAIReviewMove.html index dc0efd5c..77c49c6c 100644 --- a/docs/interfaces/JGOFAIReviewMove.html +++ b/docs/interfaces/JGOFAIReviewMove.html @@ -1,13 +1,13 @@ -JGOFAIReviewMove | goban

    Interface JGOFAIReviewMove

    interface JGOFAIReviewMove {
        branches: JGOFAIReviewMoveVariation[];
        move: JGOFIntersection;
        move_number: number;
        ownership?: number[][];
        score?: number;
        win_rate: number;
    }

    Properties

    branches +JGOFAIReviewMove | goban

    Interface JGOFAIReviewMove

    interface JGOFAIReviewMove {
        branches: JGOFAIReviewMoveVariation[];
        move: JGOFIntersection;
        move_number: number;
        ownership?: number[][];
        score?: number;
        win_rate: number;
    }

    Properties

    Followup move branches explored

    -

    The move that was played.

    -
    move_number: number

    The move number. This is 1 indexed.

    -
    ownership?: number[][]

    A width*height array of ownership values

    -
    score?: number

    How many points black is predicted to win by (if positive, lose by if negative)

    -
    win_rate: number

    Probability of black winning after this move was made

    -
    \ No newline at end of file +

    The move that was played.

    +
    move_number: number

    The move number. This is 1 indexed.

    +
    ownership?: number[][]

    A width*height array of ownership values

    +
    score?: number

    How many points black is predicted to win by (if positive, lose by if negative)

    +
    win_rate: number

    Probability of black winning after this move was made

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFAIReviewMoveVariation.html b/docs/interfaces/JGOFAIReviewMoveVariation.html index 10eb6209..9609452f 100644 --- a/docs/interfaces/JGOFAIReviewMoveVariation.html +++ b/docs/interfaces/JGOFAIReviewMoveVariation.html @@ -1,4 +1,4 @@ -JGOFAIReviewMoveVariation | goban

    Interface JGOFAIReviewMoveVariation

    interface JGOFAIReviewMoveVariation {
        lcb?: number;
        moves: JGOFIntersection[];
        policy?: number;
        score?: number;
        score_mean?: number;
        score_stdev?: number;
        utility?: number;
        utility_lcb?: number;
        visits: number;
        win_rate: number;
    }

    Properties

    lcb? +JGOFAIReviewMoveVariation | goban

    Interface JGOFAIReviewMoveVariation

    interface JGOFAIReviewMoveVariation {
        lcb?: number;
        moves: JGOFIntersection[];
        policy?: number;
        score?: number;
        score_mean?: number;
        score_stdev?: number;
        utility?: number;
        utility_lcb?: number;
        visits: number;
        win_rate: number;
    }

    Properties

    lcb? moves policy? score? @@ -9,13 +9,13 @@ visits win_rate

    Properties

    lcb?: number

    lower confidence bound, both KataGo and LeelaZero provide this

    -

    Followup predicted moves by the AI

    -
    policy?: number

    From Leela Zero

    -
    score?: number

    How many points black is predicted to win for this variation (or lose by if negative)

    -
    score_mean?: number

    From KataGo

    -
    score_stdev?: number

    From KataGo

    -
    utility?: number

    From KataGo

    -
    utility_lcb?: number

    From KataGo

    -
    visits: number

    Number of times the AI considered the first move of this variation

    -
    win_rate: number

    Probability of black wining to report for this variation

    -
    \ No newline at end of file +

    Followup predicted moves by the AI

    +
    policy?: number

    From Leela Zero

    +
    score?: number

    How many points black is predicted to win for this variation (or lose by if negative)

    +
    score_mean?: number

    From KataGo

    +
    score_stdev?: number

    From KataGo

    +
    utility?: number

    From KataGo

    +
    utility_lcb?: number

    From KataGo

    +
    visits: number

    Number of times the AI considered the first move of this variation

    +
    win_rate: number

    Probability of black wining to report for this variation

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFAbsoluteTimeControl.html b/docs/interfaces/JGOFAbsoluteTimeControl.html index 02b93278..0d79b9ff 100644 --- a/docs/interfaces/JGOFAbsoluteTimeControl.html +++ b/docs/interfaces/JGOFAbsoluteTimeControl.html @@ -1,5 +1,5 @@ -JGOFAbsoluteTimeControl | goban

    Interface JGOFAbsoluteTimeControl

    interface JGOFAbsoluteTimeControl {
        pause_on_weekends: boolean;
        speed: JGOFTimeControlSpeed;
        system: "absolute";
        total_time: number;
    }

    Properties

    pause_on_weekends +JGOFAbsoluteTimeControl | goban

    Interface JGOFAbsoluteTimeControl

    interface JGOFAbsoluteTimeControl {
        pause_on_weekends: boolean;
        speed: JGOFTimeControlSpeed;
        system: "absolute";
        total_time: number;
    }

    Properties

    pause_on_weekends: boolean
    system: "absolute"
    total_time: number
    \ No newline at end of file +

    Properties

    pause_on_weekends: boolean
    system: "absolute"
    total_time: number
    \ No newline at end of file diff --git a/docs/interfaces/JGOFByoYomiTimeControl.html b/docs/interfaces/JGOFByoYomiTimeControl.html index caf09639..0a2e3747 100644 --- a/docs/interfaces/JGOFByoYomiTimeControl.html +++ b/docs/interfaces/JGOFByoYomiTimeControl.html @@ -1,7 +1,7 @@ -JGOFByoYomiTimeControl | goban

    Interface JGOFByoYomiTimeControl

    interface JGOFByoYomiTimeControl {
        main_time: number;
        pause_on_weekends: boolean;
        period_time: number;
        periods: number;
        speed: JGOFTimeControlSpeed;
        system: "byoyomi";
    }

    Properties

    main_time +JGOFByoYomiTimeControl | goban

    Interface JGOFByoYomiTimeControl

    interface JGOFByoYomiTimeControl {
        main_time: number;
        pause_on_weekends: boolean;
        period_time: number;
        periods: number;
        speed: JGOFTimeControlSpeed;
        system: "byoyomi";
    }

    Properties

    main_time: number
    pause_on_weekends: boolean
    period_time: number
    periods: number
    system: "byoyomi"
    \ No newline at end of file +

    Properties

    main_time: number
    pause_on_weekends: boolean
    period_time: number
    periods: number
    system: "byoyomi"
    \ No newline at end of file diff --git a/docs/interfaces/JGOFCanadianTimeControl.html b/docs/interfaces/JGOFCanadianTimeControl.html index dd21dfdd..ccb09d32 100644 --- a/docs/interfaces/JGOFCanadianTimeControl.html +++ b/docs/interfaces/JGOFCanadianTimeControl.html @@ -1,7 +1,7 @@ -JGOFCanadianTimeControl | goban

    Interface JGOFCanadianTimeControl

    interface JGOFCanadianTimeControl {
        main_time: number;
        pause_on_weekends: boolean;
        period_time: number;
        speed: JGOFTimeControlSpeed;
        stones_per_period: number;
        system: "canadian";
    }

    Properties

    main_time +JGOFCanadianTimeControl | goban

    Interface JGOFCanadianTimeControl

    interface JGOFCanadianTimeControl {
        main_time: number;
        pause_on_weekends: boolean;
        period_time: number;
        speed: JGOFTimeControlSpeed;
        stones_per_period: number;
        system: "canadian";
    }

    Properties

    main_time: number
    pause_on_weekends: boolean
    period_time: number
    stones_per_period: number
    system: "canadian"
    \ No newline at end of file +

    Properties

    main_time: number
    pause_on_weekends: boolean
    period_time: number
    stones_per_period: number
    system: "canadian"
    \ No newline at end of file diff --git a/docs/interfaces/JGOFClock.html b/docs/interfaces/JGOFClock.html index 4666b1bd..4ce7db89 100644 --- a/docs/interfaces/JGOFClock.html +++ b/docs/interfaces/JGOFClock.html @@ -1,5 +1,5 @@ JGOFClock | goban

    Interface JGOFClock


    -
    interface JGOFClock {
        black_clock: JGOFPlayerClock;
        current_player: "black" | "white";
        current_player_id: string;
        pause_state?: JGOFPauseState;
        paused_since?: number;
        start_mode?: boolean;
        start_time_left?: number;
        stone_removal_time_left?: number;
        time_of_last_move: number;
        white_clock: JGOFPlayerClock;
    }

    Hierarchy (view full)

    Properties

    interface JGOFClock {
        black_clock: JGOFPlayerClock;
        current_player: "black" | "white";
        current_player_id: string;
        pause_state?: JGOFPauseState;
        paused_since?: number;
        start_mode?: boolean;
        start_time_left?: number;
        stone_removal_time_left?: number;
        time_of_last_move: number;
        white_clock: JGOFPlayerClock;
    }

    Hierarchy (view full)

    Properties

    black_clock: JGOFPlayerClock

    Time left on blacks clock.

    -
    current_player: "black" | "white"

    Player to move, and thus player whose clock is running.

    -
    current_player_id: string

    Player ID of player to move

    -
    pause_state?: JGOFPauseState

    If this field is set, the game clocks are paused for one or more reasons.

    -
    paused_since?: number

    Time the game was paused, in milliseconds since 1970, as observed by the server

    -
    start_mode?: boolean

    True if the game has not begun yet and we are waiting for the first +

    current_player: "black" | "white"

    Player to move, and thus player whose clock is running.

    +
    current_player_id: string

    Player ID of player to move

    +
    pause_state?: JGOFPauseState

    If this field is set, the game clocks are paused for one or more reasons.

    +
    paused_since?: number

    Time the game was paused, in milliseconds since 1970, as observed by the server

    +
    start_mode?: boolean

    True if the game has not begun yet and we are waiting for the first move to be played. If this is true, start_time_left will be set.

    -
    start_time_left?: number

    If start_mode is true, this is the number of milliseconds left +

    start_time_left?: number

    If start_mode is true, this is the number of milliseconds left on the start clock, when the clock reaches zero the game will be canceled.

    -
    stone_removal_time_left?: number

    If pause_State.stone_removal is true, this is the number of +

    stone_removal_time_left?: number

    If pause_State.stone_removal is true, this is the number of milliseconds left before the result is automatically accepted.

    -
    time_of_last_move: number

    Time the last move was made, in milliseconds since 1970, as observed by the server.

    -
    white_clock: JGOFPlayerClock

    Time left on whites clock.

    -
    \ No newline at end of file +
    time_of_last_move: number

    Time the last move was made, in milliseconds since 1970, as observed by the server.

    +
    white_clock: JGOFPlayerClock

    Time left on whites clock.

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFClockWithTransmitting.html b/docs/interfaces/JGOFClockWithTransmitting.html index 24d586ef..1a37c611 100644 --- a/docs/interfaces/JGOFClockWithTransmitting.html +++ b/docs/interfaces/JGOFClockWithTransmitting.html @@ -1,5 +1,5 @@ JGOFClockWithTransmitting | goban

    Interface JGOFClockWithTransmitting


    -
    interface JGOFClockWithTransmitting {
        black_clock: JGOFPlayerClock;
        black_move_transmitting: number;
        current_player: "black" | "white";
        current_player_id: string;
        pause_state?: JGOFPauseState;
        paused_since?: number;
        start_mode?: boolean;
        start_time_left?: number;
        stone_removal_time_left?: number;
        time_of_last_move: number;
        white_clock: JGOFPlayerClock;
        white_move_transmitting: number;
    }

    Hierarchy (view full)

    Properties

    interface JGOFClockWithTransmitting {
        black_clock: JGOFPlayerClock;
        black_move_transmitting: number;
        current_player: "black" | "white";
        current_player_id: string;
        pause_state?: JGOFPauseState;
        paused_since?: number;
        start_mode?: boolean;
        start_time_left?: number;
        stone_removal_time_left?: number;
        time_of_last_move: number;
        white_clock: JGOFPlayerClock;
        white_move_transmitting: number;
    }

    Hierarchy (view full)

    Properties

    black_clock: JGOFPlayerClock

    Time left on blacks clock.

    -
    black_move_transmitting: number
    current_player: "black" | "white"

    Player to move, and thus player whose clock is running.

    -
    current_player_id: string

    Player ID of player to move

    -
    pause_state?: JGOFPauseState

    If this field is set, the game clocks are paused for one or more reasons.

    -
    paused_since?: number

    Time the game was paused, in milliseconds since 1970, as observed by the server

    -
    start_mode?: boolean

    True if the game has not begun yet and we are waiting for the first +

    black_move_transmitting: number
    current_player: "black" | "white"

    Player to move, and thus player whose clock is running.

    +
    current_player_id: string

    Player ID of player to move

    +
    pause_state?: JGOFPauseState

    If this field is set, the game clocks are paused for one or more reasons.

    +
    paused_since?: number

    Time the game was paused, in milliseconds since 1970, as observed by the server

    +
    start_mode?: boolean

    True if the game has not begun yet and we are waiting for the first move to be played. If this is true, start_time_left will be set.

    -
    start_time_left?: number

    If start_mode is true, this is the number of milliseconds left +

    start_time_left?: number

    If start_mode is true, this is the number of milliseconds left on the start clock, when the clock reaches zero the game will be canceled.

    -
    stone_removal_time_left?: number

    If pause_State.stone_removal is true, this is the number of +

    stone_removal_time_left?: number

    If pause_State.stone_removal is true, this is the number of milliseconds left before the result is automatically accepted.

    -
    time_of_last_move: number

    Time the last move was made, in milliseconds since 1970, as observed by the server.

    -
    white_clock: JGOFPlayerClock

    Time left on whites clock.

    -
    white_move_transmitting: number
    \ No newline at end of file +
    time_of_last_move: number

    Time the last move was made, in milliseconds since 1970, as observed by the server.

    +
    white_clock: JGOFPlayerClock

    Time left on whites clock.

    +
    white_move_transmitting: number
    \ No newline at end of file diff --git a/docs/interfaces/JGOFFischerTimeControl.html b/docs/interfaces/JGOFFischerTimeControl.html index 525048a1..ac1e20dc 100644 --- a/docs/interfaces/JGOFFischerTimeControl.html +++ b/docs/interfaces/JGOFFischerTimeControl.html @@ -1,7 +1,7 @@ -JGOFFischerTimeControl | goban

    Interface JGOFFischerTimeControl

    interface JGOFFischerTimeControl {
        initial_time: number;
        max_time: number;
        pause_on_weekends: boolean;
        speed: JGOFTimeControlSpeed;
        system: "fischer";
        time_increment: number;
    }

    Properties

    initial_time +JGOFFischerTimeControl | goban

    Interface JGOFFischerTimeControl

    interface JGOFFischerTimeControl {
        initial_time: number;
        max_time: number;
        pause_on_weekends: boolean;
        speed: JGOFTimeControlSpeed;
        system: "fischer";
        time_increment: number;
    }

    Properties

    initial_time: number
    max_time: number
    pause_on_weekends: boolean
    system: "fischer"
    time_increment: number
    \ No newline at end of file +

    Properties

    initial_time: number
    max_time: number
    pause_on_weekends: boolean
    system: "fischer"
    time_increment: number
    \ No newline at end of file diff --git a/docs/interfaces/JGOFIntersection.html b/docs/interfaces/JGOFIntersection.html index e21b831e..5c04cbdf 100644 --- a/docs/interfaces/JGOFIntersection.html +++ b/docs/interfaces/JGOFIntersection.html @@ -1,5 +1,5 @@ -JGOFIntersection | goban

    Interface JGOFIntersection

    interface JGOFIntersection {
        x: number;
        y: number;
    }

    Hierarchy (view full)

    Properties

    x +JGOFIntersection | goban

    Interface JGOFIntersection

    interface JGOFIntersection {
        x: number;
        y: number;
    }

    Hierarchy (view full)

    Properties

    x y

    Properties

    x: number

    Horizontal coordinate, counting left to right, starting with zero

    -
    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    -
    \ No newline at end of file +
    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFMove.html b/docs/interfaces/JGOFMove.html index 29ed445e..d1ab6054 100644 --- a/docs/interfaces/JGOFMove.html +++ b/docs/interfaces/JGOFMove.html @@ -1,4 +1,4 @@ -JGOFMove | goban

    Interface JGOFMove

    interface JGOFMove {
        blur?: number;
        color?: JGOFNumericPlayerColor;
        edited?: boolean;
        played_by?: number;
        player_update?: JGOFPlayerSummary;
        removal_reason?: string;
        sgf_downloaded_by?: number[];
        timedelta?: number;
        x: number;
        y: number;
    }

    Hierarchy (view full)

    Properties

    blur? +JGOFMove | goban

    Interface JGOFMove

    interface JGOFMove {
        blur?: number;
        color?: JGOFNumericPlayerColor;
        edited?: boolean;
        played_by?: number;
        player_update?: JGOFPlayerSummary;
        removal_reason?: string;
        sgf_downloaded_by?: number[];
        timedelta?: number;
        x: number;
        y: number;
    }

    Hierarchy (view full)

    Properties

    Properties

    blur?: number
    edited?: boolean
    played_by?: number
    player_update?: JGOFPlayerSummary
    removal_reason?: string

    Stone removal reasoning, primarily for debugging

    -
    sgf_downloaded_by?: number[]
    timedelta?: number
    x: number

    Horizontal coordinate, counting left to right, starting with zero

    -
    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    -
    \ No newline at end of file +

    Properties

    blur?: number
    edited?: boolean
    played_by?: number
    player_update?: JGOFPlayerSummary
    removal_reason?: string

    Stone removal reasoning, primarily for debugging

    +
    sgf_downloaded_by?: number[]
    timedelta?: number
    x: number

    Horizontal coordinate, counting left to right, starting with zero

    +
    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFNoneTimeControl.html b/docs/interfaces/JGOFNoneTimeControl.html index 4e78e503..a9182f88 100644 --- a/docs/interfaces/JGOFNoneTimeControl.html +++ b/docs/interfaces/JGOFNoneTimeControl.html @@ -1,4 +1,4 @@ -JGOFNoneTimeControl | goban

    Interface JGOFNoneTimeControl

    interface JGOFNoneTimeControl {
        pause_on_weekends: boolean;
        speed: "correspondence";
        system: "none";
    }

    Properties

    pause_on_weekends +JGOFNoneTimeControl | goban

    Interface JGOFNoneTimeControl

    interface JGOFNoneTimeControl {
        pause_on_weekends: boolean;
        speed: "correspondence";
        system: "none";
    }

    Properties

    pause_on_weekends: boolean
    speed: "correspondence"
    system: "none"
    \ No newline at end of file +

    Properties

    pause_on_weekends: boolean
    speed: "correspondence"
    system: "none"
    \ No newline at end of file diff --git a/docs/interfaces/JGOFPauseState.html b/docs/interfaces/JGOFPauseState.html index 5533ab3b..ed22bcfe 100644 --- a/docs/interfaces/JGOFPauseState.html +++ b/docs/interfaces/JGOFPauseState.html @@ -1,16 +1,16 @@ -JGOFPauseState | goban

    Interface JGOFPauseState

    interface JGOFPauseState {
        moderator?: string;
        player?: {
            pauses_left: number;
            player_id: string;
        };
        server?: true;
        stone_removal?: true;
        vacation?: {
            [player_id: string]: true;
        };
        weekend?: true;
    }

    Properties

    moderator? +JGOFPauseState | goban

    Interface JGOFPauseState

    interface JGOFPauseState {
        moderator?: string;
        player?: {
            pauses_left: number;
            player_id: string;
        };
        server?: true;
        stone_removal?: true;
        vacation?: {
            [player_id: string]: true;
        };
        weekend?: true;
    }

    Properties

    moderator?: string

    Paused by a moderator, value of this field is the moderator's id

    -
    player?: {
        pauses_left: number;
        player_id: string;
    }

    Paused by a player. The game can only be paused by one player at a time.

    +
    player?: {
        pauses_left: number;
        player_id: string;
    }

    Paused by a player. The game can only be paused by one player at a time.

    Type declaration

    • pauses_left: number

      Number of pauses left for the pausing player.

    • player_id: string

      Player id of the player who paused the game.

      -
    server?: true

    Paused by the server

    -
    stone_removal?: true

    Paused because the game is in the stone removal phase

    -
    vacation?: {
        [player_id: string]: true;
    }

    Paused because one or more players is on vacation

    +
    server?: true

    Paused by the server

    +
    stone_removal?: true

    Paused because the game is in the stone removal phase

    +
    vacation?: {
        [player_id: string]: true;
    }

    Paused because one or more players is on vacation

    Type declaration

    • [player_id: string]: true

      Player id that is on vacation

      -
    weekend?: true

    Paused because it is the weekend

    -
    \ No newline at end of file +
    weekend?: true

    Paused because it is the weekend

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFPlayer.html b/docs/interfaces/JGOFPlayer.html index 765a4cd6..43c37384 100644 --- a/docs/interfaces/JGOFPlayer.html +++ b/docs/interfaces/JGOFPlayer.html @@ -1,5 +1,5 @@ -JGOFPlayer | goban

    Interface JGOFPlayer

    interface JGOFPlayer {
        id?: string;
        name: string;
    }

    Properties

    id? +JGOFPlayer | goban

    Interface JGOFPlayer

    interface JGOFPlayer {
        id?: string;
        name: string;
    }

    Properties

    Properties

    id?: string

    Identifier for the player

    -
    name: string

    Name or username of the player

    -
    \ No newline at end of file +
    name: string

    Name or username of the player

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFPlayerClock.html b/docs/interfaces/JGOFPlayerClock.html index 77f41b6d..eb87a9f2 100644 --- a/docs/interfaces/JGOFPlayerClock.html +++ b/docs/interfaces/JGOFPlayerClock.html @@ -1,13 +1,13 @@ -JGOFPlayerClock | goban

    Interface JGOFPlayerClock

    interface JGOFPlayerClock {
        block_time_left?: number;
        main_time: number;
        moves_left?: number;
        period_time_left?: number;
        periods_left?: number;
    }

    Hierarchy (view full)

    Properties

    block_time_left? +JGOFPlayerClock | goban

    Interface JGOFPlayerClock

    interface JGOFPlayerClock {
        block_time_left?: number;
        main_time: number;
        moves_left?: number;
        period_time_left?: number;
        periods_left?: number;
    }

    Hierarchy (view full)

    Properties

    block_time_left?: number

    Used with canadian time control. Time left in milliseconds to make the remainder of your moves in the current block

    -
    main_time: number

    Main time left on the clock, in milliseconds.

    -
    moves_left?: number

    Used with canadian time control. Number of moves left before a new +

    main_time: number

    Main time left on the clock, in milliseconds.

    +
    moves_left?: number

    Used with canadian time control. Number of moves left before a new block of time.

    -
    period_time_left?: number

    Used with byo-yomi time control. Time left on the period time, in milliseconds.

    -
    periods_left?: number

    Used with byo-yomi time control. Number of periods left.

    -
    \ No newline at end of file +
    period_time_left?: number

    Used with byo-yomi time control. Time left on the period time, in milliseconds.

    +
    periods_left?: number

    Used with byo-yomi time control. Number of periods left.

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFPlayerSummary.html b/docs/interfaces/JGOFPlayerSummary.html index a329ecf3..1c7920ac 100644 --- a/docs/interfaces/JGOFPlayerSummary.html +++ b/docs/interfaces/JGOFPlayerSummary.html @@ -1,4 +1,4 @@ -JGOFPlayerSummary | goban

    Interface JGOFPlayerSummary

    interface JGOFPlayerSummary {
        dropped_players?: {
            black?: number[];
            white?: number[];
        };
        players: {
            black: number;
            white: number;
        };
        rengo_teams: {
            black: number[];
            white: number[];
        };
    }

    Properties

    dropped_players? +JGOFPlayerSummary | goban

    Interface JGOFPlayerSummary

    interface JGOFPlayerSummary {
        dropped_players?: {
            black?: number[];
            white?: number[];
        };
        players: {
            black: number;
            white: number;
        };
        rengo_teams: {
            black: number[];
            white: number[];
        };
    }

    Properties

    dropped_players?: {
        black?: number[];
        white?: number[];
    }

    Type declaration

    • Optional black?: number[]
    • Optional white?: number[]
    players: {
        black: number;
        white: number;
    }

    Type declaration

    • black: number
    • white: number
    rengo_teams: {
        black: number[];
        white: number[];
    }

    Type declaration

    • black: number[]
    • white: number[]
    \ No newline at end of file +

    Properties

    dropped_players?: {
        black?: number[];
        white?: number[];
    }

    Type declaration

    • Optional black?: number[]
    • Optional white?: number[]
    players: {
        black: number;
        white: number;
    }

    Type declaration

    • black: number
    • white: number
    rengo_teams: {
        black: number[];
        white: number[];
    }

    Type declaration

    • black: number[]
    • white: number[]
    \ No newline at end of file diff --git a/docs/interfaces/JGOFSealingIntersection.html b/docs/interfaces/JGOFSealingIntersection.html index 81b4c7ae..5d5f49f2 100644 --- a/docs/interfaces/JGOFSealingIntersection.html +++ b/docs/interfaces/JGOFSealingIntersection.html @@ -1,8 +1,8 @@ -JGOFSealingIntersection | goban

    Interface JGOFSealingIntersection

    interface JGOFSealingIntersection {
        color: JGOFNumericPlayerColor;
        x: number;
        y: number;
    }

    Hierarchy (view full)

    Properties

    color +JGOFSealingIntersection | goban

    Interface JGOFSealingIntersection

    interface JGOFSealingIntersection {
        color: JGOFNumericPlayerColor;
        x: number;
        y: number;
    }

    Hierarchy (view full)

    Properties

    Properties

    Color the intersection is probably presumed to be by the players, but is in fact empty.

    -
    x: number

    Horizontal coordinate, counting left to right, starting with zero

    -
    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    -
    \ No newline at end of file +
    x: number

    Horizontal coordinate, counting left to right, starting with zero

    +
    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    +
    \ No newline at end of file diff --git a/docs/interfaces/JGOFSimpleTimeControl.html b/docs/interfaces/JGOFSimpleTimeControl.html index 9c836b8d..e9a5b5d5 100644 --- a/docs/interfaces/JGOFSimpleTimeControl.html +++ b/docs/interfaces/JGOFSimpleTimeControl.html @@ -1,5 +1,5 @@ -JGOFSimpleTimeControl | goban

    Interface JGOFSimpleTimeControl

    interface JGOFSimpleTimeControl {
        pause_on_weekends: boolean;
        per_move: number;
        speed: JGOFTimeControlSpeed;
        system: "simple";
    }

    Properties

    pause_on_weekends +JGOFSimpleTimeControl | goban

    Interface JGOFSimpleTimeControl

    interface JGOFSimpleTimeControl {
        pause_on_weekends: boolean;
        per_move: number;
        speed: JGOFTimeControlSpeed;
        system: "simple";
    }

    Properties

    pause_on_weekends: boolean
    per_move: number
    system: "simple"
    \ No newline at end of file +

    Properties

    pause_on_weekends: boolean
    per_move: number
    system: "simple"
    \ No newline at end of file diff --git a/docs/interfaces/MarkInterface.html b/docs/interfaces/MarkInterface.html index 9a9c9879..e63daf93 100644 --- a/docs/interfaces/MarkInterface.html +++ b/docs/interfaces/MarkInterface.html @@ -1,4 +1,4 @@ -MarkInterface | goban

    Interface MarkInterface

    interface MarkInterface {
        black?: boolean;
        blue_move?: boolean;
        chat_triangle?: boolean;
        circle?: boolean;
        color?: string;
        cross?: boolean;
        hint?: boolean;
        letter?: string;
        mark_x?: boolean;
        needs_sealing?: boolean;
        remove?: boolean;
        score?: string;
        square?: boolean;
        stone_removed?: boolean;
        sub_triangle?: boolean;
        subscript?: string;
        transient_letter?: string;
        triangle?: boolean;
        white?: boolean;
        [label: string]: string | boolean | undefined;
    }

    Indexable

    [label: string]: string | boolean | undefined

    Properties

    black? +MarkInterface | goban

    Interface MarkInterface

    interface MarkInterface {
        black?: boolean;
        blue_move?: boolean;
        chat_triangle?: boolean;
        circle?: boolean;
        color?: string;
        cross?: boolean;
        hint?: boolean;
        letter?: string;
        mark_x?: boolean;
        needs_sealing?: boolean;
        remove?: boolean;
        score?: string;
        square?: boolean;
        stone_removed?: boolean;
        sub_triangle?: boolean;
        subscript?: string;
        transient_letter?: string;
        triangle?: boolean;
        white?: boolean;
        [label: string]: string | boolean | undefined;
    }

    Indexable

    [label: string]: string | boolean | undefined

    Properties

    black?: boolean
    blue_move?: boolean
    chat_triangle?: boolean
    circle?: boolean
    color?: string
    cross?: boolean
    hint?: boolean
    letter?: string
    mark_x?: boolean
    needs_sealing?: boolean
    remove?: boolean
    score?: string
    square?: boolean
    stone_removed?: boolean
    sub_triangle?: boolean
    subscript?: string
    transient_letter?: string
    triangle?: boolean
    white?: boolean
    \ No newline at end of file +

    Properties

    black?: boolean
    blue_move?: boolean
    chat_triangle?: boolean
    circle?: boolean
    color?: string
    cross?: boolean
    hint?: boolean
    letter?: string
    mark_x?: boolean
    needs_sealing?: boolean
    remove?: boolean
    score?: string
    square?: boolean
    stone_removed?: boolean
    sub_triangle?: boolean
    subscript?: string
    transient_letter?: string
    triangle?: boolean
    white?: boolean
    \ No newline at end of file diff --git a/docs/interfaces/MoveCommand.html b/docs/interfaces/MoveCommand.html index 1ade42c5..809965a8 100644 --- a/docs/interfaces/MoveCommand.html +++ b/docs/interfaces/MoveCommand.html @@ -1,5 +1,5 @@ -MoveCommand | goban

    Interface MoveCommand

    interface MoveCommand {
        blur?: number;
        clock?: JGOFPlayerClock;
        game_id: number;
        move: string;
    }

    Properties

    blur? +MoveCommand | goban

    Interface MoveCommand

    interface MoveCommand {
        blur?: number;
        clock?: JGOFPlayerClock;
        game_id: number;
        move: string;
    }

    Properties

    Properties

    blur?: number
    game_id: number
    move: string
    \ No newline at end of file +

    Properties

    blur?: number
    game_id: number
    move: string
    \ No newline at end of file diff --git a/docs/interfaces/MoveTreeChatLine.html b/docs/interfaces/MoveTreeChatLine.html index 74caccf4..0fccc544 100644 --- a/docs/interfaces/MoveTreeChatLine.html +++ b/docs/interfaces/MoveTreeChatLine.html @@ -1,3 +1,3 @@ -MoveTreeChatLine | goban

    Interface MoveTreeChatLine

    interface MoveTreeChatLine {
        body: MoveTreeChatLineBody;
        username: string;
    }

    Properties

    body +MoveTreeChatLine | goban

    Interface MoveTreeChatLine

    interface MoveTreeChatLine {
        body: MoveTreeChatLineBody;
        username: string;
    }

    Properties

    Properties

    username: string
    \ No newline at end of file +

    Properties

    username: string
    \ No newline at end of file diff --git a/docs/interfaces/MoveTreeChatLineBody.html b/docs/interfaces/MoveTreeChatLineBody.html index fbe754c3..59c98f0b 100644 --- a/docs/interfaces/MoveTreeChatLineBody.html +++ b/docs/interfaces/MoveTreeChatLineBody.html @@ -1,5 +1,5 @@ -MoveTreeChatLineBody | goban

    Interface MoveTreeChatLineBody

    interface MoveTreeChatLineBody {
        from: number;
        moves: string | AdHocPackedMove;
        name: string;
        type: "analysis";
    }

    Properties

    from +MoveTreeChatLineBody | goban

    Interface MoveTreeChatLineBody

    interface MoveTreeChatLineBody {
        from: number;
        moves: string | AdHocPackedMove;
        name: string;
        type: "analysis";
    }

    Properties

    Properties

    from: number
    moves: string | AdHocPackedMove
    name: string
    type: "analysis"
    \ No newline at end of file +

    Properties

    from: number
    moves: string | AdHocPackedMove
    name: string
    type: "analysis"
    \ No newline at end of file diff --git a/docs/interfaces/MoveTreeJson.html b/docs/interfaces/MoveTreeJson.html index 57b293cf..b7c6fce1 100644 --- a/docs/interfaces/MoveTreeJson.html +++ b/docs/interfaces/MoveTreeJson.html @@ -1,4 +1,4 @@ -MoveTreeJson | goban

    Interface MoveTreeJson

    interface MoveTreeJson {
        branches?: MoveTreeJson[];
        correct_answer?: boolean;
        marks?: {
            marks: MarkInterface;
            x: number;
            y: number;
        }[];
        pen_marks?: MoveTreePenMarks;
        text?: string;
        trunk_next?: MoveTreeJson;
        wrong_answer?: boolean;
        x: number;
        y: number;
    }

    Properties

    branches? +MoveTreeJson | goban

    Interface MoveTreeJson

    interface MoveTreeJson {
        branches?: MoveTreeJson[];
        correct_answer?: boolean;
        marks?: {
            marks: MarkInterface;
            x: number;
            y: number;
        }[];
        pen_marks?: MoveTreePenMarks;
        text?: string;
        trunk_next?: MoveTreeJson;
        wrong_answer?: boolean;
        x: number;
        y: number;
    }

    Properties

    branches?: MoveTreeJson[]
    correct_answer?: boolean
    marks?: {
        marks: MarkInterface;
        x: number;
        y: number;
    }[]

    Type declaration

    pen_marks?: MoveTreePenMarks
    text?: string
    trunk_next?: MoveTreeJson
    wrong_answer?: boolean
    x: number
    y: number
    \ No newline at end of file +

    Properties

    branches?: MoveTreeJson[]
    correct_answer?: boolean
    marks?: {
        marks: MarkInterface;
        x: number;
        y: number;
    }[]

    Type declaration

    pen_marks?: MoveTreePenMarks
    text?: string
    trunk_next?: MoveTreeJson
    wrong_answer?: boolean
    x: number
    y: number
    \ No newline at end of file diff --git a/docs/interfaces/PlayerScore.html b/docs/interfaces/PlayerScore.html index 953347ce..0cc2cad4 100644 --- a/docs/interfaces/PlayerScore.html +++ b/docs/interfaces/PlayerScore.html @@ -1,8 +1,8 @@ -PlayerScore | goban

    Interface PlayerScore

    interface PlayerScore {
        handicap: number;
        komi: number;
        prisoners: number;
        scoring_positions: string;
        stones: number;
        territory: number;
        total: number;
    }

    Properties

    handicap +PlayerScore | goban

    Interface PlayerScore

    interface PlayerScore {
        handicap: number;
        komi: number;
        prisoners: number;
        scoring_positions: string;
        stones: number;
        territory: number;
        total: number;
    }

    Properties

    handicap: number
    komi: number
    prisoners: number
    scoring_positions: string
    stones: number
    territory: number
    total: number
    \ No newline at end of file +

    Properties

    handicap: number
    komi: number
    prisoners: number
    scoring_positions: string
    stones: number
    territory: number
    total: number
    \ No newline at end of file diff --git a/docs/interfaces/PuzzleConfig.html b/docs/interfaces/PuzzleConfig.html index 78a8f593..23a1e297 100644 --- a/docs/interfaces/PuzzleConfig.html +++ b/docs/interfaces/PuzzleConfig.html @@ -1,4 +1,4 @@ -PuzzleConfig | goban

    Interface PuzzleConfig

    interface PuzzleConfig {
        black_prisoners?: number;
        board?: JGOFNumericPlayerColor[][];
        board_is_repeating?: boolean;
        height?: number;
        initial_player?: PlayerColor;
        initial_state?: GobanEngineInitialState;
        isobranch_hash?: string;
        marks?: {
            [mark: string]: string;
        };
        mode?: string;
        move_tree?: MoveTreeJson;
        name?: string;
        player?: JGOFNumericPlayerColor;
        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;
        removal?: boolean[][];
        white_prisoners?: number;
        width?: number;
    }

    Hierarchy (view full)

    Properties

    black_prisoners? +PuzzleConfig | goban

    Interface PuzzleConfig

    interface PuzzleConfig {
        black_prisoners?: number;
        board?: JGOFNumericPlayerColor[][];
        board_is_repeating?: boolean;
        height?: number;
        initial_player?: PlayerColor;
        initial_state?: GobanEngineInitialState;
        isobranch_hash?: string;
        marks?: {
            [mark: string]: string;
        };
        mode?: string;
        move_tree?: MoveTreeJson;
        name?: string;
        player?: JGOFNumericPlayerColor;
        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;
        removal?: boolean[][];
        white_prisoners?: number;
        width?: number;
    }

    Hierarchy (view full)

    Properties

    black_prisoners?: number
    board_is_repeating?: boolean
    height?: number
    initial_player?: PlayerColor
    initial_state?: GobanEngineInitialState
    isobranch_hash?: string
    marks?: {
        [mark: string]: string;
    }

    Type declaration

    • [mark: string]: string
    mode?: string
    move_tree?: MoveTreeJson
    name?: string
    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
    removal?: boolean[][]
    white_prisoners?: number
    width?: number
    \ No newline at end of file +

    Properties

    black_prisoners?: number
    board_is_repeating?: boolean
    height?: number
    initial_player?: PlayerColor
    initial_state?: GobanEngineInitialState
    isobranch_hash?: string
    marks?: {
        [mark: string]: string;
    }

    Type declaration

    • [mark: string]: string
    mode?: string
    move_tree?: MoveTreeJson
    name?: string
    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
    removal?: boolean[][]
    white_prisoners?: number
    width?: number
    \ No newline at end of file diff --git a/docs/interfaces/ReviewMessage.html b/docs/interfaces/ReviewMessage.html index ef2739af..2d79af72 100644 --- a/docs/interfaces/ReviewMessage.html +++ b/docs/interfaces/ReviewMessage.html @@ -1,7 +1,7 @@ ReviewMessage | goban

    Interface ReviewMessage

    Reviews are constructed by a stream of modifications messages, this interface describes the format of those modification messages. A message can contain any number of the fields listed.

    -
    interface ReviewMessage {
        chat?: {
            channel: string;
            chat_id: string;
            date: number;
            from: number;
            moves: string | AdHocPackedMove;
            player_id: number;
        };
        clearpen?: boolean;
        controller?: number | {
            id: number;
            username: string;
        };
        delete?: number;
        f?: number;
        gamedata?: GobanEngineConfig;
        k?: {
            [mark: string]: string;
        };
        m?: string;
        om?: [number, number, number];
        owner?: number | {
            id: number;
            username: string;
        };
        pen?: string;
        player_update?: JGOFPlayerSummary;
        pp?: [number, number];
        remove-chat?: string;
        review_id?: number;
        t?: string;
        t+?: string;
        ts?: number;
        undo?: boolean;
    }

    Properties

    interface ReviewMessage {
        chat?: {
            channel: string;
            chat_id: string;
            date: number;
            from: number;
            moves: string | AdHocPackedMove;
            player_id: number;
        };
        clearpen?: boolean;
        controller?: number | {
            id: number;
            username: string;
        };
        delete?: number;
        f?: number;
        gamedata?: GobanEngineConfig;
        k?: {
            [mark: string]: string;
        };
        m?: string;
        om?: [number, number, number];
        owner?: number | {
            id: number;
            username: string;
        };
        pen?: string;
        player_update?: JGOFPlayerSummary;
        pp?: [number, number];
        remove-chat?: string;
        review_id?: number;
        t?: string;
        t+?: string;
        ts?: number;
        undo?: boolean;
    }

    Properties

    chat? clearpen? controller? delete? @@ -23,24 +23,24 @@

    Properties

    chat?: {
        channel: string;
        chat_id: string;
        date: number;
        from: number;
        moves: string | AdHocPackedMove;
        player_id: number;
    }

    Chat message

    Type declaration

    • channel: string
    • chat_id: string
    • date: number
    • from: number

      Turn number

    • moves: string | AdHocPackedMove

      this might just be "string", i'm not entirely sure

      -
    • player_id: number
    clearpen?: boolean

    Clears the pen drawings on the node

    -
    controller?: number | {
        id: number;
        username: string;
    }

    Sets the controller of the review

    -

    Type declaration

    • id: number
    • username: string
    delete?: number

    Delete

    -
    f?: number

    from (move number)

    -

    Initial gamedata to review

    -
    k?: {
        [mark: string]: string;
    }

    Marks made

    -

    Type declaration

    • [mark: string]: string
    m?: string

    Moves made

    -
    om?: [number, number, number]

    official move [reviewing live game]

    -
    owner?: number | {
        id: number;
        username: string;
    }

    Sets the owner of the review

    -

    Type declaration

    • id: number
    • username: string
    pen?: string

    pen color / pen start

    -
    player_update?: JGOFPlayerSummary

    Updated information about the players, such as name etc.

    -
    pp?: [number, number]

    pen point

    -
    remove-chat?: string

    Remove's the given chat by id

    -
    review_id?: number

    The review ID. This is used when sending from the client to the server, +

  • player_id: number
  • clearpen?: boolean

    Clears the pen drawings on the node

    +
    controller?: number | {
        id: number;
        username: string;
    }

    Sets the controller of the review

    +

    Type declaration

    • id: number
    • username: string
    delete?: number

    Delete

    +
    f?: number

    from (move number)

    +

    Initial gamedata to review

    +
    k?: {
        [mark: string]: string;
    }

    Marks made

    +

    Type declaration

    • [mark: string]: string
    m?: string

    Moves made

    +
    om?: [number, number, number]

    official move [reviewing live game]

    +
    owner?: number | {
        id: number;
        username: string;
    }

    Sets the owner of the review

    +

    Type declaration

    • id: number
    • username: string
    pen?: string

    pen color / pen start

    +
    player_update?: JGOFPlayerSummary

    Updated information about the players, such as name etc.

    +
    pp?: [number, number]

    pen point

    +
    remove-chat?: string

    Remove's the given chat by id

    +
    review_id?: number

    The review ID. This is used when sending from the client to the server, but is not sent by the server back to the client (as the id is encoded in the message event name)

    -
    t?: string

    text note for the current node

    -
    t+?: string

    text append to the current node

    -
    ts?: number

    timestamp (ms)

    -
    undo?: boolean

    official undo [reviewing live game]

    -
    \ No newline at end of file +
    t?: string

    text note for the current node

    +
    t+?: string

    text append to the current node

    +
    ts?: number

    timestamp (ms)

    +
    undo?: boolean

    official undo [reviewing live game]

    +
    \ No newline at end of file diff --git a/docs/interfaces/SVGRendererGobanConfig.html b/docs/interfaces/SVGRendererGobanConfig.html index 465b87a8..e5396d13 100644 --- a/docs/interfaces/SVGRendererGobanConfig.html +++ b/docs/interfaces/SVGRendererGobanConfig.html @@ -1,4 +1,4 @@ -SVGRendererGobanConfig | goban

    Interface SVGRendererGobanConfig

    interface SVGRendererGobanConfig {
        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_div?: HTMLElement;
        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);
        isobranch_hash?: string;
        komi?: number;
        ladder?: number;
        ladder_id?: number;
        last_move_opacity?: number;
        last_move_radius?: number;
        latencies?: {
            [player_id: string]: number;
        };
        leavePushedAnalysis?: (() => void);
        malkovich_log?: GobanChatLog;
        marks?: {
            [mark: string]: string;
        };
        mode?: GobanModes;
        move_tree?: MoveTreeJson;
        move_tree_container?: HTMLElement;
        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;
        strict_seki_mode?: boolean;
        superko_algorithm?: GobanEngineSuperKoAlgorithm;
        throw_all_errors?: boolean;
        time_control?: JGOFTimeControl;
        time_per_move?: number;
        title_div?: HTMLElement;
        tournament_id?: number;
        username?: string;
        variation_stone_opacity?: number;
        visual_undo_request_indicator?: boolean;
        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? +SVGRendererGobanConfig | goban

    Interface SVGRendererGobanConfig

    interface SVGRendererGobanConfig {
        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_div?: HTMLElement;
        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);
        isobranch_hash?: string;
        komi?: number;
        ladder?: number;
        ladder_id?: number;
        last_move_opacity?: number;
        last_move_radius?: number;
        latencies?: {
            [player_id: string]: number;
        };
        leavePushedAnalysis?: (() => void);
        malkovich_log?: GobanChatLog;
        marks?: {
            [mark: string]: string;
        };
        mode?: GobanModes;
        move_tree?: MoveTreeJson;
        move_tree_container?: HTMLElement;
        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;
        strict_seki_mode?: boolean;
        superko_algorithm?: GobanEngineSuperKoAlgorithm;
        throw_all_errors?: boolean;
        time_control?: JGOFTimeControl;
        time_per_move?: number;
        title_div?: HTMLElement;
        tournament_id?: number;
        username?: string;
        variation_stone_opacity?: number;
        visual_undo_request_indicator?: boolean;
        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?: 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_div?: HTMLElement
    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;
    }[]

    Type declaration

    • 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)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isobranch_hash?: string
    komi?: number
    ladder?: number
    ladder_id?: number
    last_move_opacity?: number
    last_move_radius?: number
    latencies?: {
        [player_id: string]: number;
    }

    Type declaration

    • [player_id: string]: number
    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void
      • Returns void

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

    Type declaration

    • [mark: string]: string
    mode?: GobanModes
    move_tree?: MoveTreeJson
    move_tree_container?: HTMLElement
    name?: string
    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    -
    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
    ogs_import?: boolean

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

    -
    onError?: ((err) => void)

    Type declaration

      • (err): void
      • Parameters

        • err: Error

        Returns void

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

    Type declaration

      • (winning_color, points): void
      • Parameters

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

        Returns 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
    player_id?: number
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    }

    Type declaration

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

    Type declaration

    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[]

    Removed stones in stone removal phase +

    Properties

    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_div?: HTMLElement
    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;
    }[]

    Type declaration

    • 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)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean
      • Returns boolean

    isobranch_hash?: string
    komi?: number
    ladder?: number
    ladder_id?: number
    last_move_opacity?: number
    last_move_radius?: number
    latencies?: {
        [player_id: string]: number;
    }

    Type declaration

    • [player_id: string]: number
    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void
      • Returns void

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

    Type declaration

    • [mark: string]: string
    mode?: GobanModes
    move_tree?: MoveTreeJson
    move_tree_container?: HTMLElement
    name?: string
    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    +
    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
    ogs_import?: boolean

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

    +
    onError?: ((err) => void)

    Type declaration

      • (err): void
      • Parameters

        • err: Error

        Returns void

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

    Type declaration

      • (winning_color, points): void
      • Parameters

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

        Returns 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
    player_id?: number
    player_pool?: {
        [id: number]: GobanEnginePlayerEntry;
    }

    Type declaration

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

    Type declaration

    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[]

    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

    -
    rengo?: boolean
    rengo_casual_mode?: boolean
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    }

    Type declaration

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

    Type declaration

    score?: Score
    score_handicap?: boolean
    score_passes?: boolean
    score_prisoners?: boolean
    score_stones?: boolean
    score_territory?: boolean
    score_territory_in_seki?: boolean
    spectator_log?: GobanChatLog
    square_size?: number | "auto" | ((goban) => number)

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    stalling_score_estimate?: StallingScoreEstimate
    start_time?: number
    strict_seki_mode?: boolean
    superko_algorithm?: GobanEngineSuperKoAlgorithm
    throw_all_errors?: boolean

    When loading initial state or moves, by default GobanEngine will try and +

    rengo?: boolean
    rengo_casual_mode?: boolean
    rengo_teams?: {
        black: GobanEnginePlayerEntry[];
        white: GobanEnginePlayerEntry[];
    }

    Type declaration

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

    Type declaration

    score?: Score
    score_handicap?: boolean
    score_passes?: boolean
    score_prisoners?: boolean
    score_stones?: boolean
    score_territory?: boolean
    score_territory_in_seki?: boolean
    spectator_log?: GobanChatLog
    square_size?: number | "auto" | ((goban) => number)

    Type declaration

      • (goban): number
      • Parameters

        Returns number

    stalling_score_estimate?: StallingScoreEstimate
    start_time?: number
    strict_seki_mode?: boolean
    superko_algorithm?: GobanEngineSuperKoAlgorithm
    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.

    -
    time_control?: JGOFTimeControl
    time_per_move?: number
    title_div?: HTMLElement
    tournament_id?: number
    username?: string
    variation_stone_opacity?: number
    visual_undo_request_indicator?: boolean
    white_must_pass_last?: boolean
    white_player_id?: number
    white_prisoners?: number
    width?: number
    winner?: number | "black" | "white"
    \ No newline at end of file +
    time_control?: JGOFTimeControl
    time_per_move?: number
    title_div?: HTMLElement
    tournament_id?: number
    username?: string
    variation_stone_opacity?: number
    visual_undo_request_indicator?: boolean
    white_must_pass_last?: boolean
    white_player_id?: number
    white_prisoners?: number
    width?: number
    winner?: number | "black" | "white"
    \ No newline at end of file diff --git a/docs/interfaces/SVGStoneParameters.html b/docs/interfaces/SVGStoneParameters.html index 4cfe9abe..ddb96299 100644 --- a/docs/interfaces/SVGStoneParameters.html +++ b/docs/interfaces/SVGStoneParameters.html @@ -1,7 +1,7 @@ -SVGStoneParameters | goban

    Interface SVGStoneParameters

    interface SVGStoneParameters {
        fill?: string;
        gradient?: {
            cx?: number;
            cy?: number;
            fx?: number;
            fy?: number;
            r?: number;
            stops: SVGStop[];
            type?: "radial" | "linear";
            x1?: number;
            x2?: number;
            y1?: number;
            y2?: number;
        };
        id: string;
        stroke?: string;
        stroke_scale?: number;
        url?: string;
    }

    Properties

    fill? +SVGStoneParameters | goban

    Interface SVGStoneParameters

    interface SVGStoneParameters {
        fill?: string;
        gradient?: {
            cx?: number;
            cy?: number;
            fx?: number;
            fy?: number;
            r?: number;
            stops: SVGStop[];
            type?: "radial" | "linear";
            x1?: number;
            x2?: number;
            y1?: number;
            y2?: number;
        };
        id: string;
        stroke?: string;
        stroke_scale?: number;
        url?: string;
    }

    Properties

    fill?: string
    gradient?: {
        cx?: number;
        cy?: number;
        fx?: number;
        fy?: number;
        r?: number;
        stops: SVGStop[];
        type?: "radial" | "linear";
        x1?: number;
        x2?: number;
        y1?: number;
        y2?: number;
    }

    Type declaration

    • Optional cx?: number
    • Optional cy?: number
    • Optional fx?: number
    • Optional fy?: number
    • Optional r?: number
    • stops: SVGStop[]
    • Optional type?: "radial" | "linear"
    • Optional x1?: number
    • Optional x2?: number
    • Optional y1?: number
    • Optional y2?: number
    id: string
    stroke?: string
    stroke_scale?: number
    url?: string
    \ No newline at end of file +

    Properties

    fill?: string
    gradient?: {
        cx?: number;
        cy?: number;
        fx?: number;
        fy?: number;
        r?: number;
        stops: SVGStop[];
        type?: "radial" | "linear";
        x1?: number;
        x2?: number;
        y1?: number;
        y2?: number;
    }

    Type declaration

    • Optional cx?: number
    • Optional cy?: number
    • Optional fx?: number
    • Optional fy?: number
    • Optional r?: number
    • stops: SVGStop[]
    • Optional type?: "radial" | "linear"
    • Optional x1?: number
    • Optional x2?: number
    • Optional y1?: number
    • Optional y2?: number
    id: string
    stroke?: string
    stroke_scale?: number
    url?: string
    \ No newline at end of file diff --git a/docs/interfaces/SVGStop.html b/docs/interfaces/SVGStop.html index 34bafed4..98a3dad6 100644 --- a/docs/interfaces/SVGStop.html +++ b/docs/interfaces/SVGStop.html @@ -1,3 +1,3 @@ -SVGStop | goban

    Interface SVGStop

    interface SVGStop {
        color: string;
        offset: number;
    }

    Properties

    color +SVGStop | goban

    Interface SVGStop

    interface SVGStop {
        color: string;
        offset: number;
    }

    Properties

    Properties

    color: string
    offset: number
    \ No newline at end of file +

    Properties

    color: string
    offset: number
    \ No newline at end of file diff --git a/docs/interfaces/Score.html b/docs/interfaces/Score.html index dc3d2d87..ee7e94a1 100644 --- a/docs/interfaces/Score.html +++ b/docs/interfaces/Score.html @@ -1,3 +1,3 @@ -Score | goban

    Interface Score

    interface Score {
        black: PlayerScore;
        white: PlayerScore;
    }

    Properties

    black +Score | goban

    Interface Score

    interface Score {
        black: PlayerScore;
        white: PlayerScore;
    }

    Properties

    Properties

    \ No newline at end of file +

    Properties

    \ No newline at end of file diff --git a/docs/interfaces/ScoreEstimateRequest.html b/docs/interfaces/ScoreEstimateRequest.html index bb733f67..011d8883 100644 --- a/docs/interfaces/ScoreEstimateRequest.html +++ b/docs/interfaces/ScoreEstimateRequest.html @@ -1,4 +1,4 @@ -ScoreEstimateRequest | goban

    Interface ScoreEstimateRequest

    interface ScoreEstimateRequest {
        autoscore?: boolean;
        black_prisoners?: number;
        board_state: JGOFNumericPlayerColor[][];
        height: number;
        jwt: string;
        komi?: number;
        player_to_move: "black" | "white";
        rules: GobanEngineRules;
        white_prisoners?: number;
        width: number;
    }

    Properties

    autoscore? +ScoreEstimateRequest | goban

    Interface ScoreEstimateRequest

    interface ScoreEstimateRequest {
        autoscore?: boolean;
        black_prisoners?: number;
        board_state: JGOFNumericPlayerColor[][];
        height: number;
        jwt: string;
        komi?: number;
        player_to_move: "black" | "white";
        rules: GobanEngineRules;
        white_prisoners?: number;
        width: number;
    }

    Properties

    Properties

    autoscore?: boolean

    Whether to run autoscoring logic. If true, player_to_move is essentially ignored as we compute estimates with each player moving first in turn.

    -
    black_prisoners?: number
    board_state: JGOFNumericPlayerColor[][]
    height: number
    jwt: string
    komi?: number
    player_to_move: "black" | "white"
    white_prisoners?: number
    width: number
    \ No newline at end of file +
    black_prisoners?: number
    board_state: JGOFNumericPlayerColor[][]
    height: number
    jwt: string
    komi?: number
    player_to_move: "black" | "white"
    white_prisoners?: number
    width: number
    \ No newline at end of file diff --git a/docs/interfaces/ScoreEstimateResponse.html b/docs/interfaces/ScoreEstimateResponse.html index a7a73d9c..4e2b5483 100644 --- a/docs/interfaces/ScoreEstimateResponse.html +++ b/docs/interfaces/ScoreEstimateResponse.html @@ -1,13 +1,13 @@ -ScoreEstimateResponse | goban

    Interface ScoreEstimateResponse

    interface ScoreEstimateResponse {
        autoscored_board_state?: JGOFNumericPlayerColor[][];
        autoscored_needs_sealing?: JGOFSealingIntersection[];
        autoscored_removed?: JGOFMove[];
        ownership: number[][];
        score?: number;
        win_rate?: number;
    }

    Properties

    autoscored_board_state? +ScoreEstimateResponse | goban

    Interface ScoreEstimateResponse

    interface ScoreEstimateResponse {
        autoscored_board_state?: JGOFNumericPlayerColor[][];
        autoscored_needs_sealing?: JGOFSealingIntersection[];
        autoscored_removed?: JGOFMove[];
        ownership: number[][];
        score?: number;
        win_rate?: number;
    }

    Properties

    autoscored_board_state?: JGOFNumericPlayerColor[][]

    Board state after autoscoring logic has been run. Only defined if autoscore was true in the request.

    -
    autoscored_needs_sealing?: JGOFSealingIntersection[]

    Coordinates that still need sealing

    -
    autoscored_removed?: JGOFMove[]

    Intersections that are dead or dame. Only defined if autoscore was true in the request.

    -
    ownership: number[][]

    Matrix of ownership estimates ranged from -1 (white) to 1 (black)

    -
    score?: number

    Estimated score

    -
    win_rate?: number

    Estimated win rate

    -
    \ No newline at end of file +
    autoscored_needs_sealing?: JGOFSealingIntersection[]

    Coordinates that still need sealing

    +
    autoscored_removed?: JGOFMove[]

    Intersections that are dead or dame. Only defined if autoscore was true in the request.

    +
    ownership: number[][]

    Matrix of ownership estimates ranged from -1 (white) to 1 (black)

    +
    score?: number

    Estimated score

    +
    win_rate?: number

    Estimated win rate

    +
    \ No newline at end of file diff --git a/docs/interfaces/ScoringLocations.html b/docs/interfaces/ScoringLocations.html index 775f65cf..16c121c4 100644 --- a/docs/interfaces/ScoringLocations.html +++ b/docs/interfaces/ScoringLocations.html @@ -1,3 +1,3 @@ -ScoringLocations | goban

    Interface ScoringLocations

    interface ScoringLocations {
        black: {
            locations: JGOFIntersection[];
            stones: number;
            territory: number;
        };
        white: {
            locations: JGOFIntersection[];
            stones: number;
            territory: number;
        };
    }

    Properties

    black +ScoringLocations | goban

    Interface ScoringLocations

    interface ScoringLocations {
        black: {
            locations: JGOFIntersection[];
            stones: number;
            territory: number;
        };
        white: {
            locations: JGOFIntersection[];
            stones: number;
            territory: number;
        };
    }

    Properties

    Properties

    black: {
        locations: JGOFIntersection[];
        stones: number;
        territory: number;
    }

    Type declaration

    white: {
        locations: JGOFIntersection[];
        stones: number;
        territory: number;
    }

    Type declaration

    \ No newline at end of file +

    Properties

    black: {
        locations: JGOFIntersection[];
        stones: number;
        territory: number;
    }

    Type declaration

    white: {
        locations: JGOFIntersection[];
        stones: number;
        territory: number;
    }

    Type declaration

    \ No newline at end of file diff --git a/docs/interfaces/StateUpdateEvents.html b/docs/interfaces/StateUpdateEvents.html index 33455d80..65c07ff4 100644 --- a/docs/interfaces/StateUpdateEvents.html +++ b/docs/interfaces/StateUpdateEvents.html @@ -1,4 +1,4 @@ -StateUpdateEvents | goban

    Interface StateUpdateEvents

    interface StateUpdateEvents {
        analyze_subtool: ((d) => void);
        analyze_tool: ((d) => void);
        cur_move: ((d) => void);
        cur_review_move: ((d) => void);
        last_official_move: ((d) => void);
        mode: ((d) => void);
        outcome: ((d) => void);
        paused: ((d) => void);
        phase: ((d) => void);
        review_controller_id: ((d) => void);
        review_owner_id: ((d) => void);
        rules: ((d) => void);
        score_estimate: ((d) => void);
        stalling_score_estimate: ((data?) => void);
        strict_seki_mode: ((d) => void);
        submit_move: ((d) => void);
        title: ((d) => void);
        undo_canceled: (() => void);
        undo_requested: ((d) => void);
        winner: ((d) => void);
    }

    Hierarchy (view full)

    Properties

    analyze_subtool +StateUpdateEvents | goban

    Interface StateUpdateEvents

    interface StateUpdateEvents {
        analyze_subtool: ((d) => void);
        analyze_tool: ((d) => void);
        cur_move: ((d) => void);
        cur_review_move: ((d) => void);
        last_official_move: ((d) => void);
        mode: ((d) => void);
        outcome: ((d) => void);
        paused: ((d) => void);
        phase: ((d) => void);
        review_controller_id: ((d) => void);
        review_owner_id: ((d) => void);
        rules: ((d) => void);
        score_estimate: ((d) => void);
        stalling_score_estimate: ((data?) => void);
        strict_seki_mode: ((d) => void);
        submit_move: ((d) => void);
        title: ((d) => void);
        undo_canceled: (() => void);
        undo_requested: ((d) => void);
        winner: ((d) => void);
    }

    Hierarchy (view full)

    Properties

    analyze_subtool: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    analyze_tool: ((d) => void)

    Type declaration

    cur_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    cur_review_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    last_official_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    mode: ((d) => void)

    Type declaration

    outcome: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    paused: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: boolean

        Returns void

    phase: ((d) => void)

    Type declaration

    review_controller_id: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    review_owner_id: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    rules: ((d) => void)

    Type declaration

    score_estimate: ((d) => void)

    Type declaration

    stalling_score_estimate: ((data?) => void)

    Type declaration

    strict_seki_mode: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: boolean

        Returns void

    submit_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | (() => void)

        Returns void

    title: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    undo_canceled: (() => void)

    Type declaration

      • (): void
      • Returns void

    undo_requested: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    winner: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    \ No newline at end of file +

    Properties

    analyze_subtool: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    analyze_tool: ((d) => void)

    Type declaration

    cur_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    cur_review_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    last_official_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        Returns void

    mode: ((d) => void)

    Type declaration

    outcome: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    paused: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: boolean

        Returns void

    phase: ((d) => void)

    Type declaration

    review_controller_id: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    review_owner_id: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    rules: ((d) => void)

    Type declaration

    score_estimate: ((d) => void)

    Type declaration

    stalling_score_estimate: ((data?) => void)

    Type declaration

    strict_seki_mode: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: boolean

        Returns void

    submit_move: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | (() => void)

        Returns void

    title: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: string

        Returns void

    undo_canceled: (() => void)

    Type declaration

      • (): void
      • Returns void

    undo_requested: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    winner: ((d) => void)

    Type declaration

      • (d): void
      • Parameters

        • d: undefined | number

        Returns void

    \ No newline at end of file diff --git a/docs/interfaces/ThemesInterface.html b/docs/interfaces/ThemesInterface.html index 1eb37421..da81a62f 100644 --- a/docs/interfaces/ThemesInterface.html +++ b/docs/interfaces/ThemesInterface.html @@ -1,4 +1,4 @@ -ThemesInterface | goban

    Interface ThemesInterface

    interface ThemesInterface {
        black: {
            [name: string]: typeof GobanTheme;
        };
        board: {
            [name: string]: typeof GobanTheme;
        };
        white: {
            [name: string]: typeof GobanTheme;
        };
        [key: string]: {
            [name: string]: typeof GobanTheme;
        };
    }

    Indexable

    [key: string]: {
        [name: string]: typeof GobanTheme;
    }

    Properties

    black +ThemesInterface | goban

    Interface ThemesInterface

    interface ThemesInterface {
        black: {
            [name: string]: typeof GobanTheme;
        };
        board: {
            [name: string]: typeof GobanTheme;
        };
        white: {
            [name: string]: typeof GobanTheme;
        };
        [key: string]: {
            [name: string]: typeof GobanTheme;
        };
    }

    Indexable

    [key: string]: {
        [name: string]: typeof GobanTheme;
    }

    Properties

    Properties

    black: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    board: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    white: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    \ No newline at end of file +

    Properties

    black: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    board: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    white: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    \ No newline at end of file diff --git a/docs/interfaces/_internal_.AbsoluteClock.html b/docs/interfaces/_internal_.AbsoluteClock.html index caf742b7..8d1f34c5 100644 --- a/docs/interfaces/_internal_.AbsoluteClock.html +++ b/docs/interfaces/_internal_.AbsoluteClock.html @@ -1,2 +1,2 @@ -AbsoluteClock | goban

    Interface AbsoluteClock

    interface AbsoluteClock {
        thinking_time: number;
    }

    Properties

    Properties

    thinking_time: number
    \ No newline at end of file +AbsoluteClock | goban

    Interface AbsoluteClock

    interface AbsoluteClock {
        thinking_time: number;
    }

    Properties

    Properties

    thinking_time: number
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.AnalysisComment.html b/docs/interfaces/_internal_.AnalysisComment.html index 55cd00f4..42506526 100644 --- a/docs/interfaces/_internal_.AnalysisComment.html +++ b/docs/interfaces/_internal_.AnalysisComment.html @@ -1,8 +1,8 @@ -AnalysisComment | goban

    Interface AnalysisComment

    interface AnalysisComment {
        branch_move?: number;
        from?: number;
        marks?: {
            [mark: string]: string;
        };
        moves?: string;
        name?: string;
        pen_marks?: unknown[];
        type: "analysis";
    }

    Properties

    branch_move? +AnalysisComment | goban

    Interface AnalysisComment

    interface AnalysisComment {
        branch_move?: number;
        from?: number;
        marks?: {
            [mark: string]: string;
        };
        moves?: string;
        name?: string;
        pen_marks?: unknown[];
        type: "analysis";
    }

    Properties

    branch_move?: number
    from?: number
    marks?: {
        [mark: string]: string;
    }

    Type declaration

    • [mark: string]: string
    moves?: string
    name?: string
    pen_marks?: unknown[]
    type: "analysis"
    \ No newline at end of file +

    Properties

    branch_move?: number
    from?: number
    marks?: {
        [mark: string]: string;
    }

    Type declaration

    • [mark: string]: string
    moves?: string
    name?: string
    pen_marks?: unknown[]
    type: "analysis"
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.AutoscoreResults.html b/docs/interfaces/_internal_.AutoscoreResults.html index 7063a003..aab30809 100644 --- a/docs/interfaces/_internal_.AutoscoreResults.html +++ b/docs/interfaces/_internal_.AutoscoreResults.html @@ -1,5 +1,5 @@ -AutoscoreResults | goban

    Interface AutoscoreResults

    interface AutoscoreResults {
        needs_sealing: JGOFSealingIntersection[];
        removed: JGOFMove[];
        result: JGOFNumericPlayerColor[][];
        sealed_result: JGOFNumericPlayerColor[][];
    }

    Properties

    needs_sealing +AutoscoreResults | goban

    Interface AutoscoreResults

    interface AutoscoreResults {
        needs_sealing: JGOFSealingIntersection[];
        removed: JGOFMove[];
        result: JGOFNumericPlayerColor[][];
        sealed_result: JGOFNumericPlayerColor[][];
    }

    Properties

    needs_sealing: JGOFSealingIntersection[]
    removed: JGOFMove[]
    sealed_result: JGOFNumericPlayerColor[][]
    \ No newline at end of file +

    Properties

    needs_sealing: JGOFSealingIntersection[]
    removed: JGOFMove[]
    sealed_result: JGOFNumericPlayerColor[][]
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.BoardStateWithIsobranchHash.html b/docs/interfaces/_internal_.BoardStateWithIsobranchHash.html index 49d54655..a40ce766 100644 --- a/docs/interfaces/_internal_.BoardStateWithIsobranchHash.html +++ b/docs/interfaces/_internal_.BoardStateWithIsobranchHash.html @@ -1,4 +1,4 @@ -BoardStateWithIsobranchHash | goban

    Interface BoardStateWithIsobranchHash

    interface BoardStateWithIsobranchHash {
        black_prisoners: number;
        board: JGOFNumericPlayerColor[][];
        board_is_repeating: boolean;
        goban_callback?: GobanBase;
        height: number;
        isobranch_hash?: string;
        player: JGOFNumericPlayerColor;
        removal: boolean[][];
        white_prisoners: number;
        width: number;
        boardEquals(other): boolean;
        clearRemoved(): void;
        cloneBoard(): JGOFNumericPlayerColor[][];
        cloneBoardState(): BoardState;
        computeScoringLocations(area_scoring): ScoringLocations;
        countLiberties(raw_stone_string): number;
        foreachNeighbor(pt_or_raw_stone_string, callback): void;
        getNeighboringRawStoneStrings(raw_stone_string): RawStoneString[];
        getRawStoneString(x, y, clearMarks): RawStoneString;
        setRemoved(x, y, removed, emit_stone_removal_updated?): void;
        toggleSingleGroupRemoval(x, y, force_removal?): {
            group: RawStoneString;
            removed: boolean;
        };
    }

    Hierarchy (view full)

    Properties

    black_prisoners +BoardStateWithIsobranchHash | goban

    Interface BoardStateWithIsobranchHash

    interface BoardStateWithIsobranchHash {
        black_prisoners: number;
        board: JGOFNumericPlayerColor[][];
        board_is_repeating: boolean;
        goban_callback?: GobanBase;
        height: number;
        isobranch_hash?: string;
        player: JGOFNumericPlayerColor;
        removal: boolean[][];
        white_prisoners: number;
        width: number;
        boardEquals(other): boolean;
        clearRemoved(): void;
        cloneBoard(): JGOFNumericPlayerColor[][];
        cloneBoardState(): BoardState;
        computeScoringLocations(area_scoring): ScoringLocations;
        countLiberties(raw_stone_string): number;
        foreachNeighbor(pt_or_raw_stone_string, callback): void;
        getNeighboringRawStoneStrings(raw_stone_string): RawStoneString[];
        getRawStoneString(x, y, clearMarks): RawStoneString;
        setRemoved(x, y, removed, emit_stone_removal_updated?): void;
        toggleSingleGroupRemoval(x, y, force_removal?): {
            group: RawStoneString;
            removed: boolean;
        };
    }

    Hierarchy (view full)

    Properties

    black_prisoners: number
    board_is_repeating: boolean
    goban_callback?: GobanBase
    height: number = 19
    isobranch_hash?: string

    The isobranch hash is a hash of the board state. This field is used by +

    Properties

    black_prisoners: number
    board_is_repeating: boolean
    goban_callback?: GobanBase
    height: number = 19
    isobranch_hash?: string

    The isobranch hash is a hash of the board state. This field is used by the move tree to detect isomorphic branches. This field is populated when recomputeIsoBranches is called.

    -
    removal: boolean[][]
    white_prisoners: number
    width: number = 19

    Methods

    removal: boolean[][]
    white_prisoners: number
    width: number = 19

    Methods

    • 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

    • Toggles a group of stones for removal or restoration.

      +

      Parameters

      • x: number
      • y: number
      • removed: boolean
      • emit_stone_removal_updated: boolean = true

      Returns void

    • 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;
      }

    \ No newline at end of file +

    Parameters

    Returns {
        group: RawStoneString;
        removed: boolean;
    }

    \ No newline at end of file diff --git a/docs/interfaces/_internal_.ByoYomiClock.html b/docs/interfaces/_internal_.ByoYomiClock.html index 07e2d2f8..354401d3 100644 --- a/docs/interfaces/_internal_.ByoYomiClock.html +++ b/docs/interfaces/_internal_.ByoYomiClock.html @@ -1,5 +1,5 @@ -ByoYomiClock | goban

    Interface ByoYomiClock

    interface ByoYomiClock {
        period_time: number;
        period_time_left?: number;
        periods: number;
        thinking_time: number;
    }

    Properties

    period_time +ByoYomiClock | goban

    Interface ByoYomiClock

    interface ByoYomiClock {
        period_time: number;
        period_time_left?: number;
        periods: number;
        thinking_time: number;
    }

    Properties

    period_time: number
    period_time_left?: number
    periods: number
    thinking_time: number
    \ No newline at end of file +

    Properties

    period_time: number
    period_time_left?: number
    periods: number
    thinking_time: number
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.CanadianClock.html b/docs/interfaces/_internal_.CanadianClock.html index 659f5469..80183a47 100644 --- a/docs/interfaces/_internal_.CanadianClock.html +++ b/docs/interfaces/_internal_.CanadianClock.html @@ -1,4 +1,4 @@ -CanadianClock | goban

    Interface CanadianClock

    interface CanadianClock {
        block_time: number;
        moves_left: number;
        thinking_time: number;
    }

    Properties

    block_time +CanadianClock | goban

    Interface CanadianClock

    interface CanadianClock {
        block_time: number;
        moves_left: number;
        thinking_time: number;
    }

    Properties

    block_time: number
    moves_left: number
    thinking_time: number
    \ No newline at end of file +

    Properties

    block_time: number
    moves_left: number
    thinking_time: number
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.ErrorResponse.html b/docs/interfaces/_internal_.ErrorResponse.html index cc35d93e..df680b1a 100644 --- a/docs/interfaces/_internal_.ErrorResponse.html +++ b/docs/interfaces/_internal_.ErrorResponse.html @@ -1,3 +1,3 @@ -ErrorResponse | goban

    Interface ErrorResponse

    interface ErrorResponse {
        code: string;
        message: string;
    }

    Properties

    code +ErrorResponse | goban

    Interface ErrorResponse

    interface ErrorResponse {
        code: string;
        message: string;
    }

    Properties

    Properties

    code: string
    message: string
    \ No newline at end of file +

    Properties

    code: string
    message: string
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.FischerClock.html b/docs/interfaces/_internal_.FischerClock.html index 77858360..e28bfcc3 100644 --- a/docs/interfaces/_internal_.FischerClock.html +++ b/docs/interfaces/_internal_.FischerClock.html @@ -1,3 +1,3 @@ -FischerClock | goban

    Interface FischerClock

    interface FischerClock {
        skip_bonus: boolean;
        thinking_time: number;
    }

    Properties

    skip_bonus +FischerClock | goban

    Interface FischerClock

    interface FischerClock {
        skip_bonus: boolean;
        thinking_time: number;
    }

    Properties

    skip_bonus: boolean
    thinking_time: number
    \ No newline at end of file +

    Properties

    skip_bonus: boolean
    thinking_time: number
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.GameListPlayer.html b/docs/interfaces/_internal_.GameListPlayer.html index 85dd8ff3..e8d70589 100644 --- a/docs/interfaces/_internal_.GameListPlayer.html +++ b/docs/interfaces/_internal_.GameListPlayer.html @@ -1,7 +1,7 @@ -GameListPlayer | goban

    Interface GameListPlayer

    interface GameListPlayer {
        accepted: boolean;
        id: number;
        professional: boolean;
        rank: number;
        ratings: {
            overall: {
                deviation: number;
                rating: number;
                volatility: number;
            };
            version: number;
        };
        username: string;
    }

    Properties

    accepted +GameListPlayer | goban

    Interface GameListPlayer

    interface GameListPlayer {
        accepted: boolean;
        id: number;
        professional: boolean;
        rank: number;
        ratings: {
            overall: {
                deviation: number;
                rating: number;
                volatility: number;
            };
            version: number;
        };
        username: string;
    }

    Properties

    accepted: boolean
    id: number
    professional: boolean
    rank: number
    ratings: {
        overall: {
            deviation: number;
            rating: number;
            volatility: number;
        };
        version: number;
    }

    Type declaration

    • overall: {
          deviation: number;
          rating: number;
          volatility: number;
      }
      • deviation: number
      • rating: number
      • volatility: number
    • version: number
    username: string
    \ No newline at end of file +

    Properties

    accepted: boolean
    id: number
    professional: boolean
    rank: number
    ratings: {
        overall: {
            deviation: number;
            rating: number;
            volatility: number;
        };
        version: number;
    }

    Type declaration

    • overall: {
          deviation: number;
          rating: number;
          volatility: number;
      }
      • deviation: number
      • rating: number
      • volatility: number
    • version: number
    username: string
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.GobanSVGInterface.html b/docs/interfaces/_internal_.GobanSVGInterface.html index 12418da3..17e45d43 100644 --- a/docs/interfaces/_internal_.GobanSVGInterface.html +++ b/docs/interfaces/_internal_.GobanSVGInterface.html @@ -1,4 +1,4 @@ -GobanSVGInterface | goban

    Interface GobanSVGInterface

    interface GobanSVGInterface {
        engine: GobanEngine;
        move_tree_container?: HTMLElement;
        clearAnalysisDrawing(): void;
        clearMessage(): void;
        destroy(): void;
        disablePen(): void;
        drawPenMarks(pen_marks): void;
        drawSquare(i, j): void;
        enablePen(): void;
        move_tree_bindEvents(svg): void;
        move_tree_redraw(no_warp?): void;
        setByoYomiLabel(label): void;
        setLastMoveOpacity(opacity): void;
        setMoveTreeContainer(container): void;
        showMessage(message_id_or_error, parameters?, timeout?): void;
    }

    Implemented by

    Properties

    engine +GobanSVGInterface | goban

    Interface GobanSVGInterface

    interface GobanSVGInterface {
        engine: GobanEngine;
        move_tree_container?: HTMLElement;
        clearAnalysisDrawing(): void;
        clearMessage(): void;
        destroy(): void;
        disablePen(): void;
        drawPenMarks(pen_marks): void;
        drawSquare(i, j): void;
        enablePen(): void;
        move_tree_bindEvents(svg): void;
        move_tree_redraw(no_warp?): void;
        setByoYomiLabel(label): void;
        setLastMoveOpacity(opacity): void;
        setMoveTreeContainer(container): void;
        showMessage(message_id_or_error, parameters?, timeout?): void;
    }

    Implemented by

    Properties

    engine: GobanEngine
    move_tree_container?: HTMLElement

    Methods

    • Parameters

      • container: HTMLElement

      Returns void

    • Parameters

      • message_id_or_error: MessageID
      • Optional parameters: {
            [key: string]: any;
        }
        • [key: string]: any
      • Optional timeout: number

      Returns void

    \ No newline at end of file +

    Properties

    engine: GobanEngine
    move_tree_container?: HTMLElement

    Methods

    • Parameters

      • container: HTMLElement

      Returns void

    • Parameters

      • message_id_or_error: MessageID
      • Optional parameters: {
            [key: string]: any;
        }
        • [key: string]: any
      • Optional timeout: number

      Returns void

    \ No newline at end of file diff --git a/docs/interfaces/_internal_.GobanSocketOptions.html b/docs/interfaces/_internal_.GobanSocketOptions.html index 47b33899..5f02c8ff 100644 --- a/docs/interfaces/_internal_.GobanSocketOptions.html +++ b/docs/interfaces/_internal_.GobanSocketOptions.html @@ -1,7 +1,7 @@ -GobanSocketOptions | goban

    Interface GobanSocketOptions

    interface GobanSocketOptions {
        dont_ping?: boolean;
        ping_interval?: number;
        quiet?: boolean;
        timeout_delay?: number;
    }

    Properties

    dont_ping? +GobanSocketOptions | goban

    Interface GobanSocketOptions

    interface GobanSocketOptions {
        dont_ping?: boolean;
        ping_interval?: number;
        quiet?: boolean;
        timeout_delay?: number;
    }

    Properties

    dont_ping?: boolean

    Don't automatically send pings

    -
    ping_interval?: number
    quiet?: boolean

    Don't log connection/disconnect things

    -
    timeout_delay?: number
    \ No newline at end of file +
    ping_interval?: number
    quiet?: boolean

    Don't log connection/disconnect things

    +
    timeout_delay?: number
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.JGOFPlayerClockWithTimedOut.html b/docs/interfaces/_internal_.JGOFPlayerClockWithTimedOut.html index 467bb023..c8f153b0 100644 --- a/docs/interfaces/_internal_.JGOFPlayerClockWithTimedOut.html +++ b/docs/interfaces/_internal_.JGOFPlayerClockWithTimedOut.html @@ -1,4 +1,4 @@ -JGOFPlayerClockWithTimedOut | goban

    Interface JGOFPlayerClockWithTimedOut

    interface JGOFPlayerClockWithTimedOut {
        block_time_left?: number;
        main_time: number;
        moves_left?: number;
        period_time_left?: number;
        periods_left?: number;
        timed_out: boolean;
    }

    Hierarchy (view full)

    Properties

    block_time_left? +JGOFPlayerClockWithTimedOut | goban

    Interface JGOFPlayerClockWithTimedOut

    interface JGOFPlayerClockWithTimedOut {
        block_time_left?: number;
        main_time: number;
        moves_left?: number;
        period_time_left?: number;
        periods_left?: number;
        timed_out: boolean;
    }

    Hierarchy (view full)

    Properties

    block_time_left?: number

    Used with canadian time control. Time left in milliseconds to make the remainder of your moves in the current block

    -
    main_time: number

    Main time left on the clock, in milliseconds.

    -
    moves_left?: number

    Used with canadian time control. Number of moves left before a new +

    main_time: number

    Main time left on the clock, in milliseconds.

    +
    moves_left?: number

    Used with canadian time control. Number of moves left before a new block of time.

    -
    period_time_left?: number

    Used with byo-yomi time control. Time left on the period time, in milliseconds.

    -
    periods_left?: number

    Used with byo-yomi time control. Number of periods left.

    -
    timed_out: boolean
    \ No newline at end of file +
    period_time_left?: number

    Used with byo-yomi time control. Time left on the period time, in milliseconds.

    +
    periods_left?: number

    Used with byo-yomi time control. Number of periods left.

    +
    timed_out: boolean
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.MoveTreeViewPortInterface.html b/docs/interfaces/_internal_.MoveTreeViewPortInterface.html index 8390c0a1..05038c69 100644 --- a/docs/interfaces/_internal_.MoveTreeViewPortInterface.html +++ b/docs/interfaces/_internal_.MoveTreeViewPortInterface.html @@ -1,7 +1,7 @@ -MoveTreeViewPortInterface | goban

    Interface MoveTreeViewPortInterface

    interface MoveTreeViewPortInterface {
        maxx: number;
        maxy: number;
        minx: number;
        miny: number;
        offset_x: number;
        offset_y: number;
    }

    Properties

    maxx +MoveTreeViewPortInterface | goban

    Interface MoveTreeViewPortInterface

    interface MoveTreeViewPortInterface {
        maxx: number;
        maxy: number;
        minx: number;
        miny: number;
        offset_x: number;
        offset_y: number;
    }

    Properties

    maxx: number
    maxy: number
    minx: number
    miny: number
    offset_x: number
    offset_y: number
    \ No newline at end of file +

    Properties

    maxx: number
    maxy: number
    minx: number
    miny: number
    offset_x: number
    offset_y: number
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.ReviewComment.html b/docs/interfaces/_internal_.ReviewComment.html index 231f3534..0f2d776c 100644 --- a/docs/interfaces/_internal_.ReviewComment.html +++ b/docs/interfaces/_internal_.ReviewComment.html @@ -1,3 +1,3 @@ -ReviewComment | goban

    Interface ReviewComment

    interface ReviewComment {
        review_id: number;
        type: "review";
    }

    Properties

    review_id +ReviewComment | goban

    Interface ReviewComment

    interface ReviewComment {
        review_id: number;
        type: "review";
    }

    Properties

    Properties

    review_id: number
    type: "review"
    \ No newline at end of file +

    Properties

    review_id: number
    type: "review"
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.ViewPortInterface.html b/docs/interfaces/_internal_.ViewPortInterface.html index dc9cbf27..dfc30e62 100644 --- a/docs/interfaces/_internal_.ViewPortInterface.html +++ b/docs/interfaces/_internal_.ViewPortInterface.html @@ -1,7 +1,7 @@ -ViewPortInterface | goban

    Interface ViewPortInterface

    interface ViewPortInterface {
        maxx: number;
        maxy: number;
        minx: number;
        miny: number;
        offset_x: number;
        offset_y: number;
    }

    Properties

    maxx +ViewPortInterface | goban

    Interface ViewPortInterface

    interface ViewPortInterface {
        maxx: number;
        maxy: number;
        minx: number;
        miny: number;
        offset_x: number;
        offset_y: number;
    }

    Properties

    maxx: number
    maxy: number
    minx: number
    miny: number
    offset_x: number
    offset_y: number
    \ No newline at end of file +

    Properties

    maxx: number
    maxy: number
    minx: number
    miny: number
    offset_x: number
    offset_y: number
    \ No newline at end of file diff --git a/docs/interfaces/protocol.AIServerToClient.html b/docs/interfaces/protocol.AIServerToClient.html index 5b052564..845fe892 100644 --- a/docs/interfaces/protocol.AIServerToClient.html +++ b/docs/interfaces/protocol.AIServerToClient.html @@ -1,6 +1,6 @@ AIServerToClient | goban

    Interface AIServerToClient

    interface AIServerToClient {
        net/pong: ((data) => void);
        [uuid: string]: ((data) => void);
    }

    Indexable

    [uuid: string]: ((data) => void)

    AI review messages are streamed back to the AI review UUID.

    -
      • (data): void
      • Parameters

        • data: any

        Returns void

    Properties

      • (data): void
      • Parameters

        • data: any

        Returns void

    Properties

    Properties

    net/pong: ((data) => void)

    Pong response from a ping

    Type declaration

      • (data): void
      • Parameters

        • data: {
              client: number;
              server: number;
          }
          • client: number

            Client timestamp that was sent

          • server: number

            Server timestamp when it was received

            -

        Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/interfaces/protocol.AutomatchPreferences.html b/docs/interfaces/protocol.AutomatchPreferences.html index b0c81cee..2ae1688e 100644 --- a/docs/interfaces/protocol.AutomatchPreferences.html +++ b/docs/interfaces/protocol.AutomatchPreferences.html @@ -1,4 +1,4 @@ -AutomatchPreferences | goban

    Interface AutomatchPreferences

    interface AutomatchPreferences {
        handicap: {
            condition: AutomatchCondition;
            value: "enabled" | "disabled";
        };
        lower_rank_diff: number;
        rules: {
            condition: AutomatchCondition;
            value: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz";
        };
        size_speed_options: {
            size: Size;
            speed: Speed;
        }[];
        time_control: {
            condition: AutomatchCondition;
            value: {
                initial_time?: number;
                main_time?: number;
                max_time?: number;
                pause_on_weekends?: boolean;
                per_move?: number;
                period_time?: number;
                periods?: number;
                stones_per_period?: number;
                system: "fischer" | "byoyomi" | "canadian" | "simple";
                time_increment?: number;
            };
        };
        timestamp?: number;
        upper_rank_diff: number;
        uuid: string;
    }

    Properties

    handicap +AutomatchPreferences | goban

    Interface AutomatchPreferences

    interface AutomatchPreferences {
        handicap: {
            condition: AutomatchCondition;
            value: "enabled" | "disabled";
        };
        lower_rank_diff: number;
        rules: {
            condition: AutomatchCondition;
            value: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz";
        };
        size_speed_options: {
            size: Size;
            speed: Speed;
        }[];
        time_control: {
            condition: AutomatchCondition;
            value: {
                initial_time?: number;
                main_time?: number;
                max_time?: number;
                pause_on_weekends?: boolean;
                per_move?: number;
                period_time?: number;
                periods?: number;
                stones_per_period?: number;
                system: "fischer" | "byoyomi" | "canadian" | "simple";
                time_increment?: number;
            };
        };
        timestamp?: number;
        upper_rank_diff: number;
        uuid: string;
    }

    Properties

    handicap: {
        condition: AutomatchCondition;
        value: "enabled" | "disabled";
    }

    Type declaration

    lower_rank_diff: number
    rules: {
        condition: AutomatchCondition;
        value: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz";
    }

    Type declaration

    • condition: AutomatchCondition
    • value: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz"
    size_speed_options: {
        size: Size;
        speed: Speed;
    }[]

    Type declaration

    time_control: {
        condition: AutomatchCondition;
        value: {
            initial_time?: number;
            main_time?: number;
            max_time?: number;
            pause_on_weekends?: boolean;
            per_move?: number;
            period_time?: number;
            periods?: number;
            stones_per_period?: number;
            system: "fischer" | "byoyomi" | "canadian" | "simple";
            time_increment?: number;
        };
    }

    Type declaration

    • condition: AutomatchCondition
    • value: {
          initial_time?: number;
          main_time?: number;
          max_time?: number;
          pause_on_weekends?: boolean;
          per_move?: number;
          period_time?: number;
          periods?: number;
          stones_per_period?: number;
          system: "fischer" | "byoyomi" | "canadian" | "simple";
          time_increment?: number;
      }
      • Optional initial_time?: number
      • Optional main_time?: number
      • Optional max_time?: number
      • Optional pause_on_weekends?: boolean
      • Optional per_move?: number
      • Optional period_time?: number
      • Optional periods?: number
      • Optional stones_per_period?: number
      • system: "fischer" | "byoyomi" | "canadian" | "simple"
      • Optional time_increment?: number
    timestamp?: number
    upper_rank_diff: number
    uuid: string
    \ No newline at end of file +

    Properties

    handicap: {
        condition: AutomatchCondition;
        value: "enabled" | "disabled";
    }

    Type declaration

    lower_rank_diff: number
    rules: {
        condition: AutomatchCondition;
        value: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz";
    }

    Type declaration

    • condition: AutomatchCondition
    • value: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz"
    size_speed_options: {
        size: Size;
        speed: Speed;
    }[]

    Type declaration

    time_control: {
        condition: AutomatchCondition;
        value: {
            initial_time?: number;
            main_time?: number;
            max_time?: number;
            pause_on_weekends?: boolean;
            per_move?: number;
            period_time?: number;
            periods?: number;
            stones_per_period?: number;
            system: "fischer" | "byoyomi" | "canadian" | "simple";
            time_increment?: number;
        };
    }

    Type declaration

    • condition: AutomatchCondition
    • value: {
          initial_time?: number;
          main_time?: number;
          max_time?: number;
          pause_on_weekends?: boolean;
          per_move?: number;
          period_time?: number;
          periods?: number;
          stones_per_period?: number;
          system: "fischer" | "byoyomi" | "canadian" | "simple";
          time_increment?: number;
      }
      • Optional initial_time?: number
      • Optional main_time?: number
      • Optional max_time?: number
      • Optional pause_on_weekends?: boolean
      • Optional per_move?: number
      • Optional period_time?: number
      • Optional periods?: number
      • Optional stones_per_period?: number
      • system: "fischer" | "byoyomi" | "canadian" | "simple"
      • Optional time_increment?: number
    timestamp?: number
    upper_rank_diff: number
    uuid: string
    \ No newline at end of file diff --git a/docs/interfaces/protocol.ClientToAIServer.html b/docs/interfaces/protocol.ClientToAIServer.html index b128fc02..ebd8d52e 100644 --- a/docs/interfaces/protocol.ClientToAIServer.html +++ b/docs/interfaces/protocol.ClientToAIServer.html @@ -1,6 +1,6 @@ ClientToAIServer | goban

    Interface ClientToAIServer

    This is an exhaustive list of the messages that the client can send to the AI servers.

    -
    interface ClientToAIServer {
        ai-analyze-position: ((data) => any);
        ai-analyze-subscribe: ((data) => void);
        ai-analyze-unsubscribe: ((data) => void);
        ai-analyze-variation: ((data) => void);
        ai-relay-analyzed-position: ((data) => any);
        ai-review-connect: ((data) => void);
        ai-review-disconnect: ((data) => void);
        authenticate: ((data) => undefined | {
            id: number;
            username: string;
        });
        net/ping: ((data) => void);
    }

    Hierarchy (view full)

    Properties

    interface ClientToAIServer {
        ai-analyze-position: ((data) => any);
        ai-analyze-subscribe: ((data) => void);
        ai-analyze-unsubscribe: ((data) => void);
        ai-analyze-variation: ((data) => void);
        ai-relay-analyzed-position: ((data) => any);
        ai-review-connect: ((data) => void);
        ai-review-disconnect: ((data) => void);
        authenticate: ((data) => undefined | {
            id: number;
            username: string;
        });
        net/ping: ((data) => void);
    }

    Hierarchy (view full)

    Properties

  • rules: RuleSet

    Ruleset to use

  • uuid: string

    UUID identifying the request

  • white_prisoners: number

    Number of captures white has

    -
  • Returns any

    ai-analyze-subscribe: ((data) => void)

    Subscribers to analyze position calls

    -

    Type declaration

      • (data): void
      • Parameters

        • data: {
              channel_id: string;
          }
          • channel_id: string

        Returns void

    ai-analyze-unsubscribe: ((data) => void)

    Un-subscribers to analyze position calls

    -

    Type declaration

      • (data): void
      • Parameters

        • data: {
              channel_id: string;
          }
          • channel_id: string

        Returns void

    ai-analyze-variation: ((data) => void)

    Type declaration

      • (data): void
      • Parameters

        • data: {
              ai_review_id: string | number;
              from: number;
              game_id: string | number;
              uuid: string;
              variation: string;
          }
          • ai_review_id: string | number

            The AI review id we're basing our analysis off of

            +

        Returns any

    ai-analyze-subscribe: ((data) => void)

    Subscribers to analyze position calls

    +

    Type declaration

      • (data): void
      • Parameters

        • data: {
              channel_id: string;
          }
          • channel_id: string

        Returns void

    ai-analyze-unsubscribe: ((data) => void)

    Un-subscribers to analyze position calls

    +

    Type declaration

      • (data): void
      • Parameters

        • data: {
              channel_id: string;
          }
          • channel_id: string

        Returns void

    ai-analyze-variation: ((data) => void)

    Type declaration

      • (data): void
      • Parameters

        • data: {
              ai_review_id: string | number;
              from: number;
              game_id: string | number;
              uuid: string;
              variation: string;
          }
          • ai_review_id: string | number

            The AI review id we're basing our analysis off of

          • from: number

            The move number we're branching from

          • game_id: string | number

            The game id we're analyzing

          • uuid: string

            AI UUID

          • variation: string

            Move string

            -

        Returns void

    ai-relay-analyzed-position: ((data) => any)

    Relay an already analyzed position out to any other viewers

    +

    Returns void

    ai-relay-analyzed-position: ((data) => any)

    Relay an already analyzed position out to any other viewers

    Type declaration

    ai-review-connect: ((data) => void)

    Type declaration

    ai-review-connect: ((data) => void)

    Type declaration

    ai-review-disconnect: ((data) => void)

    Type declaration

    authenticate: ((data) => undefined | {
        id: number;
        username: string;
    })

    Authenticate with the server.

    +

    Returns void

    ai-review-disconnect: ((data) => void)

    Type declaration

    authenticate: ((data) => undefined | {
        id: number;
        username: string;
    })

    Authenticate with the server.

    Prior to authentication, you should perform a GET request to /api/v1/ui/config to get the current configuration. Within the returned JSON @@ -47,7 +47,7 @@

  • Optional language?: string

    ISO 639-1 language code used on this device.

  • Optional language_version?: string

    The version of the translation dictionary.

  • Optional user_agent?: string

    Browser user agent (or websocket library)

    -
  • Returns undefined | {
        id: number;
        username: string;
    }

    net/ping: ((data) => void)

    Sends a ping to the server. This message should be +

    Returns undefined | {
        id: number;
        username: string;
    }

    net/ping: ((data) => void)

    Sends a ping to the server. This message should be sent regularly. The default interval is 10 seconds. This keeps the connection alive and allows a client to measure clock drift and latency, both of which @@ -55,4 +55,4 @@

    Type declaration

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/interfaces/protocol.ClientToServer.html b/docs/interfaces/protocol.ClientToServer.html index 299a7527..63d604f1 100644 --- a/docs/interfaces/protocol.ClientToServer.html +++ b/docs/interfaces/protocol.ClientToServer.html @@ -11,7 +11,7 @@
     {
    bot_apikey?: string;
    bot_username?: string;
    client?: string;
    client_version?: string;
    device_id?: string;
    jwt: string;
    language?: string;
    language_version?: string;
    user_agent?: string;
    }

    and you can expect to receive back either undefined or {id: number, username: string}

    -
    interface ClientToServer {
        authenticate: ((data) => undefined | {
            id: number;
            username: string;
        });
        automatch/cancel: ((data) => void);
        automatch/find_match: ((data) => void);
        automatch/list: ((data) => void);
        bot/config: ((config) => void);
        bot/status: ((data) => void);
        challenge/keepalive: ((data) => void);
        chat/join: ((data) => void);
        chat/part: ((data) => void);
        chat/pm: ((data) => undefined | {
            from: User;
            message: {
                i: string;
                m: string;
                t: number;
            };
            to: {
                id: number;
                username: string;
            };
        });
        chat/pm/close: ((data) => void);
        chat/pm/load: ((data) => void);
        chat/pm/superchat: ((data) => void);
        chat/remove: ((data) => void);
        chat/remove_all: ((data) => void);
        chat/send: ((data) => void);
        chat/topic: ((data) => void);
        game/annul: ((data) => void);
        game/cancel: ((data) => void);
        game/chat: ((data) => void);
        game/chat/remove: ((data) => void);
        game/clear_delayed_resign: ((data) => void);
        game/conditional_moves/set: ((data) => void);
        game/connect: ((data) => void);
        game/delayed_resign: ((data) => void);
        game/disconnect: ((data) => void);
        game/latency: ((data) => void);
        game/log: ((data) => {
            data: any;
            event: string;
            timestamp: string;
        }[]);
        game/move: ((data) => void);
        game/pause: ((data) => void);
        game/prevent_escaping: ((data) => void);
        game/prevent_stalling: ((data) => void);
        game/removed_stones/accept: ((data) => void);
        game/removed_stones/reject: ((data) => void);
        game/removed_stones/set: ((data) => void);
        game/resign: ((data) => void);
        game/resume: ((data) => void);
        game/timed_out: ((data) => void);
        game/undo/accept: ((data) => void);
        game/undo/cancel: ((data) => void);
        game/undo/request: ((data) => void);
        gamelist/count/subscribe: ((data) => void);
        gamelist/count/unsubscribe: ((data) => void);
        gamelist/query: ((data) => undefined | {
            by: string;
            from: number;
            limit: number;
            list: string;
            results: GameListEntry[];
            size: number;
            where: GameListWhere;
        });
        hostinfo: ((data) => {
            clients: number;
            ggs-version: string;
            hostname: string;
            uptime: number;
        });
        itc: ((data) => void);
        net/ping: ((data) => void);
        notification/delete: ((data) => void);
        remote_storage/remove: ((data) => {
            error?: string;
            retry?: boolean;
        } | {
            success: true;
        });
        remote_storage/set: ((data) => {
            error?: string;
            retry?: boolean;
        } | {
            success: true;
        });
        remote_storage/sync: ((data) => {
            error?: string;
            retry?: boolean;
        } | {
            success: true;
        });
        review/append: ((data) => void);
        review/chat: ((data) => void);
        review/chat/remove: ((data) => void);
        review/connect: ((data) => void);
        review/disconnect: ((data) => void);
        seek_graph/connect: ((data) => void);
        seek_graph/disconnect: ((data) => void);
        stats/online: ((data) => number);
        ui-pushes/subscribe: ((data) => void);
        ui-pushes/unsubscribe: ((data) => void);
        user/monitor: ((data) => void);
    }

    Hierarchy (view full)

    Properties

    interface ClientToServer {
        authenticate: ((data) => undefined | {
            id: number;
            username: string;
        });
        automatch/cancel: ((data) => void);
        automatch/find_match: ((data) => void);
        automatch/list: ((data) => void);
        bot/config: ((config) => void);
        bot/status: ((data) => void);
        challenge/keepalive: ((data) => void);
        chat/join: ((data) => void);
        chat/part: ((data) => void);
        chat/pm: ((data) => undefined | {
            from: User;
            message: {
                i: string;
                m: string;
                t: number;
            };
            to: {
                id: number;
                username: string;
            };
        });
        chat/pm/close: ((data) => void);
        chat/pm/load: ((data) => void);
        chat/pm/superchat: ((data) => void);
        chat/remove: ((data) => void);
        chat/remove_all: ((data) => void);
        chat/send: ((data) => void);
        chat/topic: ((data) => void);
        game/annul: ((data) => void);
        game/cancel: ((data) => void);
        game/chat: ((data) => void);
        game/chat/remove: ((data) => void);
        game/clear_delayed_resign: ((data) => void);
        game/conditional_moves/set: ((data) => void);
        game/connect: ((data) => void);
        game/delayed_resign: ((data) => void);
        game/disconnect: ((data) => void);
        game/latency: ((data) => void);
        game/log: ((data) => {
            data: any;
            event: string;
            timestamp: string;
        }[]);
        game/move: ((data) => void);
        game/pause: ((data) => void);
        game/prevent_escaping: ((data) => void);
        game/prevent_stalling: ((data) => void);
        game/removed_stones/accept: ((data) => void);
        game/removed_stones/reject: ((data) => void);
        game/removed_stones/set: ((data) => void);
        game/resign: ((data) => void);
        game/resume: ((data) => void);
        game/timed_out: ((data) => void);
        game/undo/accept: ((data) => void);
        game/undo/cancel: ((data) => void);
        game/undo/request: ((data) => void);
        gamelist/count/subscribe: ((data) => void);
        gamelist/count/unsubscribe: ((data) => void);
        gamelist/query: ((data) => undefined | {
            by: string;
            from: number;
            limit: number;
            list: string;
            results: GameListEntry[];
            size: number;
            where: GameListWhere;
        });
        hostinfo: ((data) => {
            clients: number;
            ggs-version: string;
            hostname: string;
            uptime: number;
        });
        itc: ((data) => void);
        net/ping: ((data) => void);
        notification/delete: ((data) => void);
        remote_storage/remove: ((data) => {
            error?: string;
            retry?: boolean;
        } | {
            success: true;
        });
        remote_storage/set: ((data) => {
            error?: string;
            retry?: boolean;
        } | {
            success: true;
        });
        remote_storage/sync: ((data) => {
            error?: string;
            retry?: boolean;
        } | {
            success: true;
        });
        review/append: ((data) => void);
        review/chat: ((data) => void);
        review/chat/remove: ((data) => void);
        review/connect: ((data) => void);
        review/disconnect: ((data) => void);
        seek_graph/connect: ((data) => void);
        seek_graph/disconnect: ((data) => void);
        stats/online: ((data) => number);
        ui-pushes/subscribe: ((data) => void);
        ui-pushes/unsubscribe: ((data) => void);
        user/monitor: ((data) => void);
    }

    Hierarchy (view full)

    Properties

  • Optional language?: string

    ISO 639-1 language code used on this device.

  • Optional language_version?: string

    The version of the translation dictionary.

  • Optional user_agent?: string

    Browser user agent (or websocket library)

    -
  • Returns undefined | {
        id: number;
        username: string;
    }

    automatch/cancel: ((data) => void)

    Cancel a match request

    -

    Type declaration

      • (data): void
      • Parameters

        • data: {
              uuid: string;
          }
          • uuid: string

        Returns void

    automatch/find_match: ((data) => void)

    Request a match via the automatch system

    -

    Type declaration

    automatch/list: ((data) => void)

    Get active automatch entries for the current user

    -

    Type declaration

      • (data): void
      • Parameters

        • data: {}

          Returns void

      bot/config: ((config) => void)

      Updates the config for the bot

      -

      Type declaration

        • (config): void
        • Parameters

          • config: any

          Returns void

      bot/status: ((data) => void)

      Update the number of games that the bot is currently playing

      -

      Type declaration

        • (data): void
        • Parameters

          • data: {
                ongoing_blitz_count: number;
                ongoing_correspondence_count: number;
                ongoing_live_count: number;
            }
            • ongoing_blitz_count: number
            • ongoing_correspondence_count: number
            • ongoing_live_count: number

          Returns void

      challenge/keepalive: ((data) => void)

      Message to let the server know the client is still interested +

      Returns undefined | {
          id: number;
          username: string;
      }

      automatch/cancel: ((data) => void)

      Cancel a match request

      +

      Type declaration

        • (data): void
        • Parameters

          • data: {
                uuid: string;
            }
            • uuid: string

          Returns void

      automatch/find_match: ((data) => void)

      Request a match via the automatch system

      +

      Type declaration

      automatch/list: ((data) => void)

      Get active automatch entries for the current user

      +

      Type declaration

        • (data): void
        • Parameters

          • data: {}

            Returns void

        bot/config: ((config) => void)

        Updates the config for the bot

        +

        Type declaration

          • (config): void
          • Parameters

            • config: any

            Returns void

        bot/status: ((data) => void)

        Update the number of games that the bot is currently playing

        +

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  ongoing_blitz_count: number;
                  ongoing_correspondence_count: number;
                  ongoing_live_count: number;
              }
              • ongoing_blitz_count: number
              • ongoing_correspondence_count: number
              • ongoing_live_count: number

            Returns void

        challenge/keepalive: ((data) => void)

        Message to let the server know the client is still interested in the specified blitz or live challenge. These should be sent about once a second to prevent the server from canceling the challenge.

        -

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  challenge_id: number;
                  game_id: number;
              }
              • challenge_id: number
              • game_id: number

            Returns void

        chat/join: ((data) => void)

        Join a chat channel

        +

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  challenge_id: number;
                  game_id: number;
              }
              • challenge_id: number
              • game_id: number

            Returns void

        chat/join: ((data) => void)

        Join a chat channel

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel: string;
              }
              • channel: string

                Channel to join

                -

            Returns void

        chat/part: ((data) => void)

        Leave a channel

        +

        Returns void

        chat/part: ((data) => void)

        Leave a channel

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel: string;
              }
              • channel: string

                Channel to leave

                -

            Returns void

        chat/pm: ((data) => undefined | {
            from: User;
            message: {
                i: string;
                m: string;
                t: number;
            };
            to: {
                id: number;
                username: string;
            };
        })

        Send a private message to another user

        +

        Returns void

        chat/pm: ((data) => undefined | {
            from: User;
            message: {
                i: string;
                m: string;
                t: number;
            };
            to: {
                id: number;
                username: string;
            };
        })

        Send a private message to another user

        Type declaration

          • (data): undefined | {
                from: User;
                message: {
                    i: string;
                    m: string;
                    t: number;
                };
                to: {
                    id: number;
                    username: string;
                };
            }
          • Parameters

            • data: {
                  as_system?: true;
                  message: string;
                  player_id: number;
                  uid: string;
                  username: string;
              }
              • Optional as_system?: true

                Moderator option to send the chat from the system not from their personal PM

              • message: string

                Message text

              • player_id: number

                Player ID of the recipient

              • uid: string

                UUID for the message

              • username: string

                Username of the recipient

                -

            Returns undefined | {
                from: User;
                message: {
                    i: string;
                    m: string;
                    t: number;
                };
                to: {
                    id: number;
                    username: string;
                };
            }

        chat/pm/close: ((data) => void)

        Closes the current user's private message session with the given player id

        -

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  player_id: number;
              }
              • player_id: number

            Returns void

        chat/pm/load: ((data) => void)

        Loads the current user's private message session history with the given player id

        -

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  player_id: number;
              }
              • player_id: number

            Returns void

        chat/pm/superchat: ((data) => void)

        Begins a "super chat" session with the given player id, which creates an +

        Returns undefined | {
            from: User;
            message: {
                i: string;
                m: string;
                t: number;
            };
            to: {
                id: number;
                username: string;
            };
        }

        chat/pm/close: ((data) => void)

        Closes the current user's private message session with the given player id

        +

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  player_id: number;
              }
              • player_id: number

            Returns void

        chat/pm/load: ((data) => void)

        Loads the current user's private message session history with the given player id

        +

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  player_id: number;
              }
              • player_id: number

            Returns void

        chat/pm/superchat: ((data) => void)

        Begins a "super chat" session with the given player id, which creates an unclosable dialog if enable is true, and makes the dialog closable again if enable is false. This is only available to moderators.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  enable: boolean;
                  player_id: number;
                  username: string;
              }
              • enable: boolean

                Set to true if you want the modal to be unclosable, false if you want the modal to be closable again

              • player_id: number
              • username: string

                Username of the recipient

                -

            Returns void

        chat/remove: ((data) => void)

        Moderator only command to remove a single chat message

        -

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  uuid: string;
              }
              • uuid: string

            Returns void

        chat/remove_all: ((data) => void)

        Moderator only command to remove all chat messages for a given player

        +

        Returns void

        chat/remove: ((data) => void)

        Moderator only command to remove a single chat message

        +

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  uuid: string;
              }
              • uuid: string

            Returns void

        chat/remove_all: ((data) => void)

        Moderator only command to remove all chat messages for a given player

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  player_id: number;
              }
              • player_id: number

                Player id to remove all messages for

                -

            Returns void

        chat/send: ((data) => void)

        Sends a chat message to the given channel

        +

        Returns void

        chat/send: ((data) => void)

        Sends a chat message to the given channel

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel: string;
                  message: string;
                  uuid: string;
              }
              • channel: string

                Channel to send the message to

              • message: string

                Message text

              • uuid: string

                ID for the message

                -

            Returns void

        chat/topic: ((data) => void)

        Sets a channel topic

        -

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel: string;
                  topic: string;
              }
              • channel: string
              • topic: string

            Returns void

        game/annul: ((data) => void)

        In Japanese rules, if the game is found to be repeating, the players +

        Returns void

        chat/topic: ((data) => void)

        Sets a channel topic

        +

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel: string;
                  topic: string;
              }
              • channel: string
              • topic: string

            Returns void

        game/annul: ((data) => void)

        In Japanese rules, if the game is found to be repeating, the players may opt to annul the entire game and start over.

        This is largely undesired in an online setting and support for this will probably be removed in the future, dont' bother implementing this.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/cancel: ((data) => void)

        Cancels a game. This is effectively the same as resign, except the +

        Returns void

        game/cancel: ((data) => void)

        Cancels a game. This is effectively the same as resign, except the game will not be ranked. This is only allowed within the first few moves of the game. (See GobanEngine.gameCanBeCancelled for cancellation )

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/chat: ((data) => void)

        Sends a chat message to a game

        +

        Returns void

        game/chat: ((data) => void)

        Sends a chat message to a game

        Type declaration

        game/chat/remove: ((data) => void)

        Moderator only command to remove a single chat message from a game

        -

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel: string;
                  chat_id: string;
                  game_id: number;
              }
              • channel: string
              • chat_id: string
              • game_id: number

            Returns void

        game/clear_delayed_resign: ((data) => void)

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/conditional_moves/set: ((data) => void)

        Sets conditional moves to be made on behalf of the player in response +

        Returns void

        game/chat/remove: ((data) => void)

        Moderator only command to remove a single chat message from a game

        +

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel: string;
                  chat_id: string;
                  game_id: number;
              }
              • channel: string
              • chat_id: string
              • game_id: number

            Returns void

        game/clear_delayed_resign: ((data) => void)

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                +

            Returns void

        game/conditional_moves/set: ((data) => void)

        Sets conditional moves to be made on behalf of the player in response to a move by the opponent.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  conditional_moves: ConditionalMoveResponse;
                  game_id: number;
                  move_number: number;
              }
              • conditional_moves: ConditionalMoveResponse

                The conditional moves. The top level should be an array that looks like [null, { ... }] where the second element contains the responses to the opponent's move.

              • game_id: number

                The game id

              • move_number: number

                The move number from which the conditional moves are rooted in

                -

            Returns void

        game/connect: ((data) => void)

        Connect to a game. Once connected, the client will receive game +

        Returns void

        game/connect: ((data) => void)

        Connect to a game. Once connected, the client will receive game updates relevant to the game.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  chat?: boolean;
                  game_id: number;
              }
              • Optional chat?: boolean

                If true, the client will receive the game chat log and new chat events

              • game_id: number

                The game id to connect to

                -

            Returns void

        game/delayed_resign: ((data) => void)

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/disconnect: ((data) => void)

        Disconnect from a game. This will stop game updates for a particular game.

        -

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

            Returns void

        game/latency: ((data) => void)

        Update your latency information for a particular game. This is used +

        Returns void

        game/delayed_resign: ((data) => void)

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                +

            Returns void

        game/disconnect: ((data) => void)

        Disconnect from a game. This will stop game updates for a particular game.

        +

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

            Returns void

        game/latency: ((data) => void)

        Update your latency information for a particular game. This is used for clock synchronization. It is not strictly required, however strongly suggested for live games.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
                  latency: number;
              }
              • game_id: number

                The game id

              • latency: number

                Network latency, measured in milliseconds. See net/ping to measure this.

                -

            Returns void

        game/log: ((data) => {
            data: any;
            event: string;
            timestamp: string;
        }[])

        Returns an event log for the given game. This is primarily +

        Returns void

        game/log: ((data) => {
            data: any;
            event: string;
            timestamp: string;
        }[])

        Returns an event log for the given game. This is primarily for moderation purposes, although the endpoint is generally available to all users.

        -

        Type declaration

          • (data): {
                data: any;
                event: string;
                timestamp: string;
            }[]
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

            Returns {
                data: any;
                event: string;
                timestamp: string;
            }[]

        game/move: ((data) => void)

        Submit a move for a game

        +

        Type declaration

          • (data): {
                data: any;
                event: string;
                timestamp: string;
            }[]
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

            Returns {
                data: any;
                event: string;
                timestamp: string;
            }[]

        game/move: ((data) => void)

        Submit a move for a game

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  blur?: number;
                  clock?: JGOFPlayerClock;
                  game_id: number;
                  move: string;
              }
              • Optional blur?: number

                Maximum number of milliseconds the client was out of focus between the last move and this move

              • Optional clock?: JGOFPlayerClock

                Clock according to the client. If this is within the margin of @@ -168,18 +168,18 @@ clock value. If not provided, the server clock will be used.

              • game_id: number

                The game id

              • move: string

                The move number to play at

                -

            Returns void

        game/pause: ((data) => void)

        Pauses the game clocks

        +

        Returns void

        game/pause: ((data) => void)

        Pauses the game clocks

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/prevent_escaping: ((data) => void)

        Request the server end a game that someone has left without resigning +

        Returns void

        game/prevent_escaping: ((data) => void)

        Request the server end a game that someone has left without resigning from

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  annul: boolean;
                  game_id: number;
                  winner: "black" | "white";
              }
              • annul: boolean

                Request that the game be annulled or not

              • game_id: number

                The game id

              • winner: "black" | "white"

                The proposed winner

                -

            Returns void

        game/prevent_stalling: ((data) => void)

        Request the server end a game that is being stalled by one of the +

        Returns void

        game/prevent_stalling: ((data) => void)

        Request the server end a game that is being stalled by one of the players. This will only work if the server agrees in the outcome.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
                  winner: "black" | "white";
              }
              • game_id: number

                The game id

              • winner: "black" | "white"

                The proposed winner

                -

            Returns void

        game/removed_stones/accept: ((data) => void)

        Accepts the stones as removed. Once both players have accepted the same +

        Returns void

        game/removed_stones/accept: ((data) => void)

        Accepts the stones as removed. Once both players have accepted the same stones, the stone removal phase will conclude and the game will finish.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
                  stones: string;
                  strict_seki_mode: boolean;
              }
              • game_id: number

                The game id

              • stones: string

                All of the stones that are accepted as removed, and all @@ -190,9 +190,9 @@ era of the game, the official client no longer displays this as an option to the user as it was very largely unused and was a large source of confusion.

                -

            Returns void

        game/removed_stones/reject: ((data) => void)

        Rejects the removed stones and resumes the game from the stone removal phase

        +

        Returns void

        game/removed_stones/reject: ((data) => void)

        Rejects the removed stones and resumes the game from the stone removal phase

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/removed_stones/set: ((data) => void)

        Sets removed stones in the stone removal phase.

        +

        Returns void

        game/removed_stones/set: ((data) => void)

        Sets removed stones in the stone removal phase.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
                  needs_sealing?: JGOFSealingIntersection[];
                  removed: boolean;
                  stones: string | JGOFMove[];
                  strict_seki_mode?: boolean;
              }
              • game_id: number

                The game id

              • Optional needs_sealing?: JGOFSealingIntersection[]

                List of intersections that need to be sealed before the game can be correctly scored. Note, if this is undefined, the value will not @@ -208,47 +208,47 @@ option to the user as it was very largely unused and was a large source of confusion. This field is deprecated and will likely be removed in the future.

                -

            Returns void

        game/resign: ((data) => void)

        Resigns from the game

        +

        Returns void

        game/resign: ((data) => void)

        Resigns from the game

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/resume: ((data) => void)

        Resumes the game clocks

        +

        Returns void

        game/resume: ((data) => void)

        Resumes the game clocks

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/timed_out: ((data) => void)

        Inform the server that the client believes it's clock has timed out +

        Returns void

        game/timed_out: ((data) => void)

        Inform the server that the client believes it's clock has timed out and the game should be ended in a timeout. This is not strictly necessary to implement as the server will also timeout games, however there is a grace period to account for network latency, so well behaved clients can (and should) send this message to be very exact with timeouts.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/undo/accept: ((data) => void)

        Accepts an undo

        +

        Returns void

        game/undo/accept: ((data) => void)

        Accepts an undo

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
                  move_number: number;
              }
              • game_id: number

                The game id

              • move_number: number

                The current move number

                -

            Returns void

        game/undo/cancel: ((data) => void)

        Cancels an undo request

        +

        Returns void

        game/undo/cancel: ((data) => void)

        Cancels an undo request

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
                  move_number: number;
              }
              • game_id: number

                The game id

              • move_number: number

                The current move number

                -

            Returns void

        game/undo/request: ((data) => void)

        Requests an undo

        +

        Returns void

        game/undo/request: ((data) => void)

        Requests an undo

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  game_id: number;
                  move_number: number;
              }
              • game_id: number

                The game id

              • move_number: number

                The current move number

                -

            Returns void

        gamelist/count/subscribe: ((data) => void)

        Connects to the game list count. +

        Returns void

        gamelist/count/subscribe: ((data) => void)

        Connects to the game list count. Once connected you'll start receiving gamelist-count or gamelist-count-${channel} messages.

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel?: string;
              }
              • Optional channel?: string

                The group or tournament channel to subscribe to. If no channel is provided, the global server counts will be sent

                -

            Returns void

        gamelist/count/unsubscribe: ((data) => void)

        Disconnects from the game list count

        +

        Returns void

        gamelist/count/unsubscribe: ((data) => void)

        Disconnects from the game list count

        Type declaration

          • (data): void
          • Parameters

            • data: {
                  channel?: string;
              }
              • Optional channel?: string

                The group or tournament channel to unsubscribe from. If no channel is provided, the global server counts will be unsubscribed from

                -

            Returns void

        gamelist/query: ((data) => undefined | {
            by: string;
            from: number;
            limit: number;
            list: string;
            results: GameListEntry[];
            size: number;
            where: GameListWhere;
        })

        Queries the server for a list of games

        +

        Returns void

        gamelist/query: ((data) => undefined | {
            by: string;
            from: number;
            limit: number;
            list: string;
            results: GameListEntry[];
            size: number;
            where: GameListWhere;
        })

        Queries the server for a list of games

        Type declaration

          • (data): undefined | {
                by: string;
                from: number;
                limit: number;
                list: string;
                results: GameListEntry[];
                size: number;
                where: GameListWhere;
            }
          • Parameters

            • data: {
                  channel?: string;
                  from: number;
                  limit: number;
                  list: "live" | "corr" | "kidsgo";
                  sort_by: "rank";
                  where: GameListWhere;
              }
              • Optional channel?: string

                The group or tournament channel to query

              • from: number

                The number of games to skip before returning results

              • limit: number

                Number of games to return, between 1 and 300

              • list: "live" | "corr" | "kidsgo"
              • sort_by: "rank"
              • where: GameListWhere

                Filtering options

                -

            Returns undefined | {
                by: string;
                from: number;
                limit: number;
                list: string;
                results: GameListEntry[];
                size: number;
                where: GameListWhere;
            }

        hostinfo: ((data) => {
            clients: number;
            ggs-version: string;
            hostname: string;
            uptime: number;
        })

        Retrieve host information for the termination server you are connected to

        -

        Type declaration

          • (data): {
                clients: number;
                ggs-version: string;
                hostname: string;
                uptime: number;
            }
          • Parameters

            • data: {}

              Returns {
                  clients: number;
                  ggs-version: string;
                  hostname: string;
                  uptime: number;
              }

              • clients: number
              • ggs-version: string
              • hostname: string
              • uptime: number
          itc: ((data) => void)

          Sends an "Inter Tab Communication" message to all other connected +

          Returns undefined | {
              by: string;
              from: number;
              limit: number;
              list: string;
              results: GameListEntry[];
              size: number;
              where: GameListWhere;
          }

          hostinfo: ((data) => {
              clients: number;
              ggs-version: string;
              hostname: string;
              uptime: number;
          })

          Retrieve host information for the termination server you are connected to

          +

          Type declaration

            • (data): {
                  clients: number;
                  ggs-version: string;
                  hostname: string;
                  uptime: number;
              }
            • Parameters

              • data: {}

                Returns {
                    clients: number;
                    ggs-version: string;
                    hostname: string;
                    uptime: number;
                }

                • clients: number
                • ggs-version: string
                • hostname: string
                • uptime: number
            itc: ((data) => void)

            Sends an "Inter Tab Communication" message to all other connected clients for the current user. This includes other devices, so the "Tab" part is a bit of a misnomer.

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      data: any;
                      event: string;
                  }
                  • data: any

                    User defined data

                  • event: string

                    User defined event string

                    -

                Returns void

            net/ping: ((data) => void)

            Sends a ping to the server. This message should be +

            Returns void

            net/ping: ((data) => void)

            Sends a ping to the server. This message should be sent regularly. The default interval is 10 seconds. This keeps the connection alive and allows a client to measure clock drift and latency, both of which @@ -256,37 +256,37 @@

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      client: number;
                      drift: number;
                      latency: number;
                  }
                  • client: number

                    Client timestamp - milliseconds since epoch

                  • drift: number

                    Last clock drift measurement, or 0

                  • latency: number

                    Last latency measurement, or 0

                    -

                Returns void

            notification/delete: ((data) => void)

            Deletes a notification

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      notification_id: string;
                  }
                  • notification_id: string

                Returns void

            remote_storage/remove: ((data) => {
                error?: string;
                retry?: boolean;
            } | {
                success: true;
            })

            Remove the given key from remote storage system for this user

            +

            Returns void

            notification/delete: ((data) => void)

            Deletes a notification

            +

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      notification_id: string;
                  }
                  • notification_id: string

                Returns void

            remote_storage/remove: ((data) => {
                error?: string;
                retry?: boolean;
            } | {
                success: true;
            })

            Remove the given key from remote storage system for this user

            For more details on the remote storage replication system see: https://github.com/online-go/online-go.com/blob/devel/src/lib/data.ts

            -

            Type declaration

              • (data): {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }
              • Parameters

                Returns {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }

            remote_storage/set: ((data) => {
                error?: string;
                retry?: boolean;
            } | {
                success: true;
            })

            Set the given key in the remote storage system for this user

            +

            Type declaration

              • (data): {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }
              • Parameters

                Returns {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }

            remote_storage/set: ((data) => {
                error?: string;
                retry?: boolean;
            } | {
                success: true;
            })

            Set the given key in the remote storage system for this user

            For more details on the remote storage replication system see: https://github.com/online-go/online-go.com/blob/devel/src/lib/data.ts

            -

            Type declaration

              • (data): {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }
              • Parameters

                Returns {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }

            remote_storage/sync: ((data) => {
                error?: string;
                retry?: boolean;
            } | {
                success: true;
            })

            Requests all updated key/value pairs for this user since the +

            Type declaration

              • (data): {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }
              • Parameters

                Returns {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }

            remote_storage/sync: ((data) => {
                error?: string;
                retry?: boolean;
            } | {
                success: true;
            })

            Requests all updated key/value pairs for this user since the provided timestamp (as as ISO 8601 string).

            For more details on the remote storage replication system see: https://github.com/online-go/online-go.com/blob/devel/src/lib/data.ts

            Type declaration

              • (data): {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }
              • Parameters

                • data: {
                      since: string;
                  }
                  • since: string

                    ISO 8601 timestamp. Updates made after this timestamp will be sent to the client.

                    -

                Returns {
                    error?: string;
                    retry?: boolean;
                } | {
                    success: true;
                }

            review/append: ((data) => void)

            Append a review action to the review log.

            -

            Type declaration

            review/chat: ((data) => void)

            Sends a chat message to a review

            +

            Returns {
                error?: string;
                retry?: boolean;
            } | {
                success: true;
            }

            review/append: ((data) => void)

            Append a review action to the review log.

            +

            Type declaration

            review/chat: ((data) => void)

            Sends a chat message to a review

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      body: string;
                      from: number;
                      moves: string;
                      review_id: number;
                  }
                  • body: string

                    The chat message

                  • from: number

                    The root of the branch the user is viewing

                  • moves: string

                    The analysis branch the user is viewing

                  • review_id: number

                    The review id

                    -

                Returns void

            review/chat/remove: ((data) => void)

            Moderator only command to remove a single chat message from a game

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: string;
                      chat_id: string;
                      review_id: number;
                  }
                  • channel: string
                  • chat_id: string
                  • review_id: number

                Returns void

            review/connect: ((data) => void)

            Connects to a review

            +

            Returns void

            review/chat/remove: ((data) => void)

            Moderator only command to remove a single chat message from a game

            +

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: string;
                      chat_id: string;
                      review_id: number;
                  }
                  • channel: string
                  • chat_id: string
                  • review_id: number

                Returns void

            review/connect: ((data) => void)

            Connects to a review

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      review_id: number;
                  }
                  • review_id: number

                    The review id

                    -

                Returns void

            review/disconnect: ((data) => void)

            Disconnects from a review

            +

            Returns void

            review/disconnect: ((data) => void)

            Disconnects from a review

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      review_id: number;
                  }
                  • review_id: number

                    The review id

                    -

                Returns void

            seek_graph/connect: ((data) => void)

            Subscribes to the seek graph events. The channel is required to be "global" +

            Returns void

            seek_graph/connect: ((data) => void)

            Subscribes to the seek graph events. The channel is required to be "global" for now and the foreseeable future.

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: "global";
                  }
                  • channel: "global"

                Returns void

            seek_graph/disconnect: ((data) => void)

            Un-Subscribes to the seek graph events. The channel is required to be "global" +

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: "global";
                  }
                  • channel: "global"

                Returns void

            seek_graph/disconnect: ((data) => void)

            Un-Subscribes to the seek graph events. The channel is required to be "global" for now and the foreseeable future.

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: "global";
                  }
                  • channel: "global"

                Returns void

            stats/online: ((data) => number)

            Request the number of unique authenticated players +

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: "global";
                  }
                  • channel: "global"

                Returns void

            stats/online: ((data) => number)

            Request the number of unique authenticated players online within the given interval

            Type declaration

              • (data): number
              • Parameters

                • data: {
                      interval: number;
                  }
                  • interval: number

                    Interval in seconds

                    -

                Returns number

            ui-pushes/subscribe: ((data) => void)

            Subscribes to UI related push event messages sent to a particular channel

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: string;
                  }
                  • channel: string

                Returns void

            ui-pushes/unsubscribe: ((data) => void)

            Un-Subscribes to UI related push event messages sent to a particular channel

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: string;
                  }
                  • channel: string

                Returns void

            user/monitor: ((data) => void)

            Subscribes to online status updates for the given player ids

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      user_ids: number[];
                  }
                  • user_ids: number[]

                Returns void

            \ No newline at end of file +

            Returns number

            ui-pushes/subscribe: ((data) => void)

            Subscribes to UI related push event messages sent to a particular channel

            +

            Type declaration

            ui-pushes/unsubscribe: ((data) => void)

            Un-Subscribes to UI related push event messages sent to a particular channel

            +

            Type declaration

            user/monitor: ((data) => void)

            Subscribes to online status updates for the given player ids

            +

            Type declaration

            \ No newline at end of file diff --git a/docs/interfaces/protocol.ClientToServerBase.html b/docs/interfaces/protocol.ClientToServerBase.html index fd440328..8eed3525 100644 --- a/docs/interfaces/protocol.ClientToServerBase.html +++ b/docs/interfaces/protocol.ClientToServerBase.html @@ -1,5 +1,5 @@ ClientToServerBase | goban

            Interface ClientToServerBase

            Messages that clients send, regardless of target server

            -
            interface ClientToServerBase {
                authenticate: ((data) => undefined | {
                    id: number;
                    username: string;
                });
                net/ping: ((data) => void);
            }

            Hierarchy (view full)

            Properties

            interface ClientToServerBase {
                authenticate: ((data) => undefined | {
                    id: number;
                    username: string;
                });
                net/ping: ((data) => void);
            }

            Hierarchy (view full)

            Properties

            authenticate: ((data) => undefined | {
                id: number;
                username: string;
            })

            Authenticate with the server.

            Prior to authentication, you should perform a GET request to @@ -16,7 +16,7 @@

          • Optional language?: string

            ISO 639-1 language code used on this device.

          • Optional language_version?: string

            The version of the translation dictionary.

          • Optional user_agent?: string

            Browser user agent (or websocket library)

            -
          • Returns undefined | {
                id: number;
                username: string;
            }

            net/ping: ((data) => void)

            Sends a ping to the server. This message should be +

            Returns undefined | {
                id: number;
                username: string;
            }

            net/ping: ((data) => void)

            Sends a ping to the server. This message should be sent regularly. The default interval is 10 seconds. This keeps the connection alive and allows a client to measure clock drift and latency, both of which @@ -24,4 +24,4 @@

            Type declaration

            \ No newline at end of file +

            Returns void

            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatAnalysisMessage.html b/docs/interfaces/protocol.GameChatAnalysisMessage.html index ae92f562..633410b3 100644 --- a/docs/interfaces/protocol.GameChatAnalysisMessage.html +++ b/docs/interfaces/protocol.GameChatAnalysisMessage.html @@ -1,4 +1,4 @@ -GameChatAnalysisMessage | goban

            Interface GameChatAnalysisMessage

            interface GameChatAnalysisMessage {
                branch_move?: number;
                engine_analysis?: {
                    score?: number;
                    visits?: number;
                    win_rate: number;
                    [key: string]: number | undefined;
                };
                from?: number;
                marks?: {
                    [mark: string]: string;
                };
                moves?: string;
                name?: string;
                pen_marks?: unknown[];
                type: "analysis";
            }

            Properties

            branch_move? +GameChatAnalysisMessage | goban

            Interface GameChatAnalysisMessage

            interface GameChatAnalysisMessage {
                branch_move?: number;
                engine_analysis?: {
                    score?: number;
                    visits?: number;
                    win_rate: number;
                    [key: string]: number | undefined;
                };
                from?: number;
                marks?: {
                    [mark: string]: string;
                };
                moves?: string;
                name?: string;
                pen_marks?: unknown[];
                type: "analysis";
            }

            Properties

            branch_move?: number
            engine_analysis?: {
                score?: number;
                visits?: number;
                win_rate: number;
                [key: string]: number | undefined;
            }

            Type declaration

            • [key: string]: number | undefined
            • Optional score?: number
            • Optional visits?: number
            • win_rate: number
            from?: number
            marks?: {
                [mark: string]: string;
            }

            Type declaration

            • [mark: string]: string
            moves?: string
            name?: string
            pen_marks?: unknown[]
            type: "analysis"
            \ No newline at end of file +

            Properties

            branch_move?: number
            engine_analysis?: {
                score?: number;
                visits?: number;
                win_rate: number;
                [key: string]: number | undefined;
            }

            Type declaration

            • [key: string]: number | undefined
            • Optional score?: number
            • Optional visits?: number
            • win_rate: number
            from?: number
            marks?: {
                [mark: string]: string;
            }

            Type declaration

            • [mark: string]: string
            moves?: string
            name?: string
            pen_marks?: unknown[]
            type: "analysis"
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatLine.html b/docs/interfaces/protocol.GameChatLine.html index 60d817bb..2de11f2f 100644 --- a/docs/interfaces/protocol.GameChatLine.html +++ b/docs/interfaces/protocol.GameChatLine.html @@ -1,4 +1,4 @@ -GameChatLine | goban

            Interface GameChatLine

            interface GameChatLine {
                body: string | AnalysisComment | ReviewComment;
                channel: string;
                chat_id: string;
                date: number;
                from?: number;
                move_number: number;
                moves?: string;
                player_id: number;
                username?: string;
            }

            Properties

            body +GameChatLine | goban

            Interface GameChatLine

            interface GameChatLine {
                body: string | AnalysisComment | ReviewComment;
                channel: string;
                chat_id: string;
                date: number;
                from?: number;
                move_number: number;
                moves?: string;
                player_id: number;
                username?: string;
            }

            Properties

            Properties

            channel: string
            chat_id: string
            date: number
            from?: number
            move_number: number
            moves?: string
            player_id: number
            username?: string
            \ No newline at end of file +

            Properties

            channel: string
            chat_id: string
            date: number
            from?: number
            move_number: number
            moves?: string
            player_id: number
            username?: string
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatMessage.html b/docs/interfaces/protocol.GameChatMessage.html index a66a6ff0..b4203e42 100644 --- a/docs/interfaces/protocol.GameChatMessage.html +++ b/docs/interfaces/protocol.GameChatMessage.html @@ -1,3 +1,3 @@ -GameChatMessage | goban

            Interface GameChatMessage

            interface GameChatMessage {
                channel: "main" | "malkovich" | "hidden" | "personal" | "spectator" | "shadowban";
                line: GameChatLine;
            }

            Properties

            channel +GameChatMessage | goban

            Interface GameChatMessage

            interface GameChatMessage {
                channel: "main" | "malkovich" | "hidden" | "personal" | "spectator" | "shadowban";
                line: GameChatLine;
            }

            Properties

            Properties

            channel: "main" | "malkovich" | "hidden" | "personal" | "spectator" | "shadowban"
            \ No newline at end of file +

            Properties

            channel: "main" | "malkovich" | "hidden" | "personal" | "spectator" | "shadowban"
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatReviewMessage.html b/docs/interfaces/protocol.GameChatReviewMessage.html index b9bdc76d..968d497b 100644 --- a/docs/interfaces/protocol.GameChatReviewMessage.html +++ b/docs/interfaces/protocol.GameChatReviewMessage.html @@ -1,3 +1,3 @@ -GameChatReviewMessage | goban

            Interface GameChatReviewMessage

            interface GameChatReviewMessage {
                review_id: number;
                type: "review";
            }

            Properties

            review_id +GameChatReviewMessage | goban

            Interface GameChatReviewMessage

            interface GameChatReviewMessage {
                review_id: number;
                type: "review";
            }

            Properties

            Properties

            review_id: number
            type: "review"
            \ No newline at end of file +

            Properties

            review_id: number
            type: "review"
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatTranslatedMessage.html b/docs/interfaces/protocol.GameChatTranslatedMessage.html index 105adc3a..38b0d927 100644 --- a/docs/interfaces/protocol.GameChatTranslatedMessage.html +++ b/docs/interfaces/protocol.GameChatTranslatedMessage.html @@ -1,3 +1,3 @@ -GameChatTranslatedMessage | goban

            Interface GameChatTranslatedMessage

            interface GameChatTranslatedMessage {
                en: string;
                type: "translated";
                [lang: string]: string;
            }

            Indexable

            [lang: string]: string

            Properties

            en +GameChatTranslatedMessage | goban

            Interface GameChatTranslatedMessage

            interface GameChatTranslatedMessage {
                en: string;
                type: "translated";
                [lang: string]: string;
            }

            Indexable

            [lang: string]: string

            Properties

            Properties

            en: string
            type: "translated"
            \ No newline at end of file +

            Properties

            en: string
            type: "translated"
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameClock.html b/docs/interfaces/protocol.GameClock.html index d67f2653..12a94e09 100644 --- a/docs/interfaces/protocol.GameClock.html +++ b/docs/interfaces/protocol.GameClock.html @@ -1,4 +1,4 @@ -GameClock | goban

            Interface GameClock

            interface GameClock {
                black_player_id: number;
                black_time?: ClockTime;
                current_player: number;
                expiration: number;
                expiration_delta?: number;
                game_id: number;
                last_move: number;
                now?: number;
                pause?: {
                    pause_control?: {
                        [key: string]: boolean;
                    };
                    paused?: boolean;
                    paused_since?: number;
                };
                pause_delta?: number;
                paused_since?: number;
                start_mode?: boolean;
                stone_removal_expiration?: number;
                stone_removal_mode?: boolean;
                title: string;
                white_player_id: number;
                white_time?: ClockTime;
            }

            Properties

            black_player_id +GameClock | goban

            Interface GameClock

            interface GameClock {
                black_player_id: number;
                black_time?: ClockTime;
                current_player: number;
                expiration: number;
                expiration_delta?: number;
                game_id: number;
                last_move: number;
                now?: number;
                pause?: {
                    pause_control?: {
                        [key: string]: boolean;
                    };
                    paused?: boolean;
                    paused_since?: number;
                };
                pause_delta?: number;
                paused_since?: number;
                start_mode?: boolean;
                stone_removal_expiration?: number;
                stone_removal_mode?: boolean;
                title: string;
                white_player_id: number;
                white_time?: ClockTime;
            }

            Properties

            black_player_id: number
            black_time?: ClockTime
            current_player: number
            expiration: number
            expiration_delta?: number
            game_id: number
            last_move: number
            now?: number
            pause?: {
                pause_control?: {
                    [key: string]: boolean;
                };
                paused?: boolean;
                paused_since?: number;
            }

            Type declaration

            • Optional pause_control?: {
                  [key: string]: boolean;
              }
              • [key: string]: boolean
            • Optional paused?: boolean
            • Optional paused_since?: number
            pause_delta?: number
            paused_since?: number
            start_mode?: boolean
            stone_removal_expiration?: number
            stone_removal_mode?: boolean
            title: string
            white_player_id: number
            white_time?: ClockTime
            \ No newline at end of file +

            Properties

            black_player_id: number
            black_time?: ClockTime
            current_player: number
            expiration: number
            expiration_delta?: number
            game_id: number
            last_move: number
            now?: number
            pause?: {
                pause_control?: {
                    [key: string]: boolean;
                };
                paused?: boolean;
                paused_since?: number;
            }

            Type declaration

            • Optional pause_control?: {
                  [key: string]: boolean;
              }
              • [key: string]: boolean
            • Optional paused?: boolean
            • Optional paused_since?: number
            pause_delta?: number
            paused_since?: number
            start_mode?: boolean
            stone_removal_expiration?: number
            stone_removal_mode?: boolean
            title: string
            white_player_id: number
            white_time?: ClockTime
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameListEntry.html b/docs/interfaces/protocol.GameListEntry.html index b705e682..02716b17 100644 --- a/docs/interfaces/protocol.GameListEntry.html +++ b/docs/interfaces/protocol.GameListEntry.html @@ -1,4 +1,4 @@ -GameListEntry | goban

            Interface GameListEntry

            interface GameListEntry {
                _participants?: number[];
                black: GameListPlayer;
                bot_game?: boolean;
                clock_expiration: number;
                dropped_player: number;
                group_ids?: number[];
                group_ids_map?: {
                    [id: string]: boolean;
                };
                handicap?: number;
                height: number;
                id: number;
                in_beginning?: boolean;
                in_end?: boolean;
                in_middle?: boolean;
                kidsgo_game?: boolean;
                komi?: number;
                ladder_id?: number;
                malkovich_present?: boolean;
                move_number: number;
                name: string;
                paused: boolean;
                phase: string;
                player_to_move: number;
                private: boolean;
                ranked?: boolean;
                rengo: boolean;
                rengo_casual_mode: boolean;
                rengo_teams: {
                    black: User[];
                    white: User[];
                };
                socket_id?: any;
                time_per_move: number;
                tournament_id?: number;
                white: GameListPlayer;
                width: number;
            }

            Properties

            _participants? +GameListEntry | goban

            Interface GameListEntry

            interface GameListEntry {
                _participants?: number[];
                black: GameListPlayer;
                bot_game?: boolean;
                clock_expiration: number;
                dropped_player: number;
                group_ids?: number[];
                group_ids_map?: {
                    [id: string]: boolean;
                };
                handicap?: number;
                height: number;
                id: number;
                in_beginning?: boolean;
                in_end?: boolean;
                in_middle?: boolean;
                kidsgo_game?: boolean;
                komi?: number;
                ladder_id?: number;
                malkovich_present?: boolean;
                move_number: number;
                name: string;
                paused: boolean;
                phase: string;
                player_to_move: number;
                private: boolean;
                ranked?: boolean;
                rengo: boolean;
                rengo_casual_mode: boolean;
                rengo_teams: {
                    black: User[];
                    white: User[];
                };
                socket_id?: any;
                time_per_move: number;
                tournament_id?: number;
                white: GameListPlayer;
                width: number;
            }

            Properties

            _participants?: number[]
            bot_game?: boolean
            clock_expiration: number
            dropped_player: number
            group_ids?: number[]
            group_ids_map?: {
                [id: string]: boolean;
            }

            Type declaration

            • [id: string]: boolean
            handicap?: number
            height: number
            id: number
            in_beginning?: boolean
            in_end?: boolean
            in_middle?: boolean
            kidsgo_game?: boolean
            komi?: number
            ladder_id?: number
            malkovich_present?: boolean
            move_number: number
            name: string
            paused: boolean
            phase: string
            player_to_move: number
            private: boolean
            ranked?: boolean
            rengo: boolean
            rengo_casual_mode: boolean
            rengo_teams: {
                black: User[];
                white: User[];
            }

            Type declaration

            socket_id?: any
            time_per_move: number
            tournament_id?: number
            width: number
            \ No newline at end of file +

            Properties

            _participants?: number[]
            bot_game?: boolean
            clock_expiration: number
            dropped_player: number
            group_ids?: number[]
            group_ids_map?: {
                [id: string]: boolean;
            }

            Type declaration

            • [id: string]: boolean
            handicap?: number
            height: number
            id: number
            in_beginning?: boolean
            in_end?: boolean
            in_middle?: boolean
            kidsgo_game?: boolean
            komi?: number
            ladder_id?: number
            malkovich_present?: boolean
            move_number: number
            name: string
            paused: boolean
            phase: string
            player_to_move: number
            private: boolean
            ranked?: boolean
            rengo: boolean
            rengo_casual_mode: boolean
            rengo_teams: {
                black: User[];
                white: User[];
            }

            Type declaration

            socket_id?: any
            time_per_move: number
            tournament_id?: number
            width: number
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameListWhere.html b/docs/interfaces/protocol.GameListWhere.html index 663d2125..0566e438 100644 --- a/docs/interfaces/protocol.GameListWhere.html +++ b/docs/interfaces/protocol.GameListWhere.html @@ -1,5 +1,5 @@ GameListWhere | goban

            Interface GameListWhere

            Parameters for the gamelist/query message

            -
            interface GameListWhere {
                hide_13x13?: boolean;
                hide_19x19?: boolean;
                hide_9x9?: boolean;
                hide_beginning?: boolean;
                hide_bot_games?: boolean;
                hide_end?: boolean;
                hide_even?: boolean;
                hide_handicap?: boolean;
                hide_ladder?: boolean;
                hide_middle?: boolean;
                hide_open?: boolean;
                hide_other?: boolean;
                hide_ranked?: boolean;
                hide_tournament?: boolean;
                hide_unranked?: boolean;
                ladder_id?: number;
                malk_only?: boolean;
                players?: number[];
                rengo_only?: boolean;
                tournament_id?: number;
            }

            Properties

            interface GameListWhere {
                hide_13x13?: boolean;
                hide_19x19?: boolean;
                hide_9x9?: boolean;
                hide_beginning?: boolean;
                hide_bot_games?: boolean;
                hide_end?: boolean;
                hide_even?: boolean;
                hide_handicap?: boolean;
                hide_ladder?: boolean;
                hide_middle?: boolean;
                hide_open?: boolean;
                hide_other?: boolean;
                hide_ranked?: boolean;
                hide_tournament?: boolean;
                hide_unranked?: boolean;
                ladder_id?: number;
                malk_only?: boolean;
                players?: number[];
                rengo_only?: boolean;
                tournament_id?: number;
            }

            Properties

            hide_13x13?: boolean
            hide_19x19?: boolean
            hide_9x9?: boolean
            hide_beginning?: boolean
            hide_bot_games?: boolean
            hide_end?: boolean
            hide_even?: boolean
            hide_handicap?: boolean
            hide_ladder?: boolean
            hide_middle?: boolean
            hide_open?: boolean
            hide_other?: boolean
            hide_ranked?: boolean
            hide_tournament?: boolean
            hide_unranked?: boolean
            ladder_id?: number
            malk_only?: boolean
            players?: number[]
            rengo_only?: boolean
            tournament_id?: number
            \ No newline at end of file +

            Properties

            hide_13x13?: boolean
            hide_19x19?: boolean
            hide_9x9?: boolean
            hide_beginning?: boolean
            hide_bot_games?: boolean
            hide_end?: boolean
            hide_even?: boolean
            hide_handicap?: boolean
            hide_ladder?: boolean
            hide_middle?: boolean
            hide_open?: boolean
            hide_other?: boolean
            hide_ranked?: boolean
            hide_tournament?: boolean
            hide_unranked?: boolean
            ladder_id?: number
            malk_only?: boolean
            players?: number[]
            rengo_only?: boolean
            tournament_id?: number
            \ No newline at end of file diff --git a/docs/interfaces/protocol.Glicko2.html b/docs/interfaces/protocol.Glicko2.html index 8cbf04e2..b36c6a3c 100644 --- a/docs/interfaces/protocol.Glicko2.html +++ b/docs/interfaces/protocol.Glicko2.html @@ -1,5 +1,5 @@ -Glicko2 | goban

            Interface Glicko2

            interface Glicko2 {
                deviation: number;
                games_played?: number;
                rating: number;
                volatility: number;
            }

            Properties

            deviation +Glicko2 | goban

            Interface Glicko2

            interface Glicko2 {
                deviation: number;
                games_played?: number;
                rating: number;
                volatility: number;
            }

            Properties

            deviation: number
            games_played?: number
            rating: number
            volatility: number
            \ No newline at end of file +

            Properties

            deviation: number
            games_played?: number
            rating: number
            volatility: number
            \ No newline at end of file diff --git a/docs/interfaces/protocol.SeekgraphChallengeMessage.html b/docs/interfaces/protocol.SeekgraphChallengeMessage.html index 283c1268..f547a06b 100644 --- a/docs/interfaces/protocol.SeekgraphChallengeMessage.html +++ b/docs/interfaces/protocol.SeekgraphChallengeMessage.html @@ -1,4 +1,4 @@ -SeekgraphChallengeMessage | goban

            Interface SeekgraphChallengeMessage

            interface SeekgraphChallengeMessage {
                challenge_id: number;
                challenger_color: "black" | "white" | "automatic";
                disable_analysis: boolean;
                game_id: number;
                handicap: null | number;
                height: number;
                invite_only: boolean;
                komi: null | number;
                max_rank: number;
                min_rank: number;
                name: string;
                professional: boolean;
                ranked: boolean;
                ranking: number;
                rengo: boolean;
                rengo_auto_start: boolean;
                rengo_black_team: number[];
                rengo_casual_mode: boolean;
                rengo_nominees: number[];
                rengo_participants: number[];
                rengo_white_team: number[];
                rules: string;
                time_control: string;
                time_control_parameters: JGOFTimeControl;
                time_per_move: number;
                user_id: number;
                username: string;
                uuid: string;
                width: number;
            }

            Properties

            challenge_id +SeekgraphChallengeMessage | goban

            Interface SeekgraphChallengeMessage

            interface SeekgraphChallengeMessage {
                challenge_id: number;
                challenger_color: "black" | "white" | "automatic";
                disable_analysis: boolean;
                game_id: number;
                handicap: null | number;
                height: number;
                invite_only: boolean;
                komi: null | number;
                max_rank: number;
                min_rank: number;
                name: string;
                professional: boolean;
                ranked: boolean;
                ranking: number;
                rengo: boolean;
                rengo_auto_start: boolean;
                rengo_black_team: number[];
                rengo_casual_mode: boolean;
                rengo_nominees: number[];
                rengo_participants: number[];
                rengo_white_team: number[];
                rules: string;
                time_control: string;
                time_control_parameters: JGOFTimeControl;
                time_per_move: number;
                user_id: number;
                username: string;
                uuid: string;
                width: number;
            }

            Properties

            challenge_id: number

            The ID of the challenge

            -
            challenger_color: "black" | "white" | "automatic"

            Color the accepting player will be

            -
            disable_analysis: boolean

            If analysis is disabled

            -
            game_id: number

            The game ID

            -
            handicap: null | number

            The game handicap

            -
            height: number

            Board height

            -
            invite_only: boolean

            If the game is only joinable by invitation

            -
            komi: null | number

            Komi

            -
            max_rank: number

            Maximum rank allowed to accept the game

            -
            min_rank: number

            Minimum rank allowed to accept the game

            -
            name: string

            Game name

            -
            professional: boolean

            If they are a professional player

            -
            ranked: boolean

            If the game is ranked

            -
            ranking: number

            Their ranking *

            -
            rengo: boolean

            If it's a rengo game

            -
            rengo_auto_start: boolean

            If the rengo game will automatically start

            -
            rengo_black_team: number[]

            Player ids of the players on the Black team

            -
            rengo_casual_mode: boolean

            If the game is a casual rengo game

            -
            rengo_nominees: number[]

            Player ids of people that have been nominated to play

            -
            rengo_participants: number[]

            All player ids involved in the game

            -
            rengo_white_team: number[]

            Player ids of the players on the White team

            -
            rules: string

            Rules being used

            -
            time_control: string

            Time control system type

            -
            time_control_parameters: JGOFTimeControl

            Time control parameters

            -
            time_per_move: number

            Average time per move

            -
            user_id: number

            User id of the player who is looking for a game

            -
            username: string

            Username of the player looking for the game

            -
            uuid: string

            A UUID for the invitation

            -
            width: number

            Board width

            -
            \ No newline at end of file +
            challenger_color: "black" | "white" | "automatic"

            Color the accepting player will be

            +
            disable_analysis: boolean

            If analysis is disabled

            +
            game_id: number

            The game ID

            +
            handicap: null | number

            The game handicap

            +
            height: number

            Board height

            +
            invite_only: boolean

            If the game is only joinable by invitation

            +
            komi: null | number

            Komi

            +
            max_rank: number

            Maximum rank allowed to accept the game

            +
            min_rank: number

            Minimum rank allowed to accept the game

            +
            name: string

            Game name

            +
            professional: boolean

            If they are a professional player

            +
            ranked: boolean

            If the game is ranked

            +
            ranking: number

            Their ranking *

            +
            rengo: boolean

            If it's a rengo game

            +
            rengo_auto_start: boolean

            If the rengo game will automatically start

            +
            rengo_black_team: number[]

            Player ids of the players on the Black team

            +
            rengo_casual_mode: boolean

            If the game is a casual rengo game

            +
            rengo_nominees: number[]

            Player ids of people that have been nominated to play

            +
            rengo_participants: number[]

            All player ids involved in the game

            +
            rengo_white_team: number[]

            Player ids of the players on the White team

            +
            rules: string

            Rules being used

            +
            time_control: string

            Time control system type

            +
            time_control_parameters: JGOFTimeControl

            Time control parameters

            +
            time_per_move: number

            Average time per move

            +
            user_id: number

            User id of the player who is looking for a game

            +
            username: string

            Username of the player looking for the game

            +
            uuid: string

            A UUID for the invitation

            +
            width: number

            Board width

            +
            \ No newline at end of file diff --git a/docs/interfaces/protocol.SeekgraphDeleteMessage.html b/docs/interfaces/protocol.SeekgraphDeleteMessage.html index 9d4390d7..4bdade33 100644 --- a/docs/interfaces/protocol.SeekgraphDeleteMessage.html +++ b/docs/interfaces/protocol.SeekgraphDeleteMessage.html @@ -1,5 +1,5 @@ -SeekgraphDeleteMessage | goban

            Interface SeekgraphDeleteMessage

            interface SeekgraphDeleteMessage {
                challenge_id: number;
                delete: true;
            }

            Properties

            challenge_id +SeekgraphDeleteMessage | goban

            Interface SeekgraphDeleteMessage

            interface SeekgraphDeleteMessage {
                challenge_id: number;
                delete: true;
            }

            Properties

            Properties

            challenge_id: number

            The ID of the challenge

            -
            delete: true

            The entry should be deleted if this field exists and is true

            -
            \ No newline at end of file +
            delete: true

            The entry should be deleted if this field exists and is true

            +
            \ No newline at end of file diff --git a/docs/interfaces/protocol.SeekgraphStartedMessage.html b/docs/interfaces/protocol.SeekgraphStartedMessage.html index 9ae5b222..81bb8d6e 100644 --- a/docs/interfaces/protocol.SeekgraphStartedMessage.html +++ b/docs/interfaces/protocol.SeekgraphStartedMessage.html @@ -1,4 +1,4 @@ -SeekgraphStartedMessage | goban

            Interface SeekgraphStartedMessage

            interface SeekgraphStartedMessage {
                black: User;
                challenge_id: number;
                creator: number;
                game_id: number;
                game_started?: true;
                rengo?: true;
                rengo_auto_start?: boolean;
                rengo_black_team?: number[];
                rengo_casual_mode?: boolean;
                rengo_white_team?: number[];
                time_control: string;
                time_control_parameters: JGOFTimeControl;
                white: User;
            }

            Properties

            black +SeekgraphStartedMessage | goban

            Interface SeekgraphStartedMessage

            interface SeekgraphStartedMessage {
                black: User;
                challenge_id: number;
                creator: number;
                game_id: number;
                game_started?: true;
                rengo?: true;
                rengo_auto_start?: boolean;
                rengo_black_team?: number[];
                rengo_casual_mode?: boolean;
                rengo_white_team?: number[];
                time_control: string;
                time_control_parameters: JGOFTimeControl;
                white: User;
            }

            Properties

            black: User

            Black player

            -
            challenge_id: number

            The ID of the challenge

            -
            creator: number

            Player ID of the creator

            -
            game_id: number

            The game id

            -
            game_started?: true

            If exists and is true, the game has been started and the entry should be removed from the seek graph

            -
            rengo?: true

            Rengo game if true

            -
            rengo_auto_start?: boolean

            Whether the rengo game with automatically start

            -
            rengo_black_team?: number[]

            Player ids of the players on the Black team

            -
            rengo_casual_mode?: boolean

            Wether it's a Casual mode rengo game

            -
            rengo_white_team?: number[]

            Player ids of the players on the White team

            -
            time_control: string

            Time control system

            -
            time_control_parameters: JGOFTimeControl

            Time control parameters

            -
            white: User

            White player

            -
            \ No newline at end of file +
            challenge_id: number

            The ID of the challenge

            +
            creator: number

            Player ID of the creator

            +
            game_id: number

            The game id

            +
            game_started?: true

            If exists and is true, the game has been started and the entry should be removed from the seek graph

            +
            rengo?: true

            Rengo game if true

            +
            rengo_auto_start?: boolean

            Whether the rengo game with automatically start

            +
            rengo_black_team?: number[]

            Player ids of the players on the Black team

            +
            rengo_casual_mode?: boolean

            Wether it's a Casual mode rengo game

            +
            rengo_white_team?: number[]

            Player ids of the players on the White team

            +
            time_control: string

            Time control system

            +
            time_control_parameters: JGOFTimeControl

            Time control parameters

            +
            white: User

            White player

            +
            \ No newline at end of file diff --git a/docs/interfaces/protocol.ServerToClient.html b/docs/interfaces/protocol.ServerToClient.html index be8d9d84..388638d3 100644 --- a/docs/interfaces/protocol.ServerToClient.html +++ b/docs/interfaces/protocol.ServerToClient.html @@ -1,5 +1,5 @@ ServerToClient | goban

            Interface ServerToClient

            interface ServerToClient {
                ERROR: ((data) => void);
                HUP: (() => void);
                active-bots: ((data) => void);
                active_game: ((data) => void);
                automatch/cancel: ((data) => void);
                automatch/entry: ((data) => void);
                automatch/start: ((data) => void);
                chat-join: ((data) => void);
                chat-message: ((data) => void);
                chat-message-removed: ((data) => void);
                chat-part: ((data) => void);
                chat-topic: ((data) => void);
                chat-update-user: ((data) => void);
                game/:id/auto_resign: ((data) => void);
                game/:id/chat: ((data) => void);
                game/:id/chat/remove: ((data) => void);
                game/:id/clear_auto_resign: ((data) => void);
                game/:id/clock: ((data) => void);
                game/:id/conditional_moves: ((data) => void);
                game/:id/error: ((data) => void);
                game/:id/gamedata: ((data) => void);
                game/:id/latency: ((data) => void);
                game/:id/phase: ((data) => void);
                game/:id/removed_stones: ((data) => void);
                game/:id/removed_stones_accepted: ((data) => void);
                game/:id/reset-chats: (() => void);
                game/:id/stalling_score_estimate: ((data?) => void);
                game/:id/undo_accepted: ((data) => void);
                game/:id/undo_canceled: ((data) => void);
                game/:id/undo_requested: ((data) => void);
                gamelist-count: ((data) => void);
                gamelist-count-:channel: ((data) => void);
                hostinfo: ((data) => void);
                incident-report: ((data) => void);
                itc: ((data) => void);
                net/pong: ((data) => void);
                notification: ((data) => void);
                private-message: ((data) => void);
                private-superchat: ((data) => void);
                remote_storage/sync_complete: (() => void);
                remote_storage/update: ((data) => void);
                review/:id/full_state: ((data) => void);
                review/:id/r: ((data) => void);
                score-estimator-enabled-state: ((data) => void);
                seekgraph/global: ((messages) => void);
                ui-push: ((data) => void);
                user/jwt: ((jwt) => void);
                user/state: ((data) => void);
                user/update: ((user) => void);
                [k: `gamelist-count-${string}`]: ServerToClient["gamelist-count-:channel"];
            }

            Hierarchy (view full)

            Indexable

            [k: `gamelist-count-${string}`]: ServerToClient["gamelist-count-:channel"]

            A move was made on a game

            -

            Properties

            Properties

            ERROR HUP active-bots active_game @@ -51,16 +51,16 @@

            Properties

            ERROR: ((data) => void)

            An error occurred, the message string should be displayed to the user. For a list of errcode's used, see https://github.com/online-go/online-go.com/blob/devel/src/components/Errcode/Errcode.tsx

            -

            Type declaration

              • (data): void
              • Parameters

                • data: string | {
                      errcode: string;
                  }

                Returns void

            HUP: (() => void)

            The client should reload

            -

            Type declaration

              • (): void
              • Returns void

            active-bots: ((data) => void)

            Updates the list of bots that are connected and ready to the server

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      [id: number]: User;
                  }

                Returns void

            active_game: ((data) => void)

            Message to inform the client of an active game, or a change to an existing game

            -

            Type declaration

            automatch/cancel: ((data) => void)

            An automatch request was canceled

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      uuid: string;
                  }
                  • uuid: string

                Returns void

            automatch/entry: ((data) => void)

            An automatch request is active

            -

            Type declaration

            automatch/start: ((data) => void)

            An automatch request was started

            -

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      game_id: number;
                      uuid: string;
                  }
                  • game_id: number
                  • uuid: string

                Returns void

            chat-join: ((data) => void)

            User(s) joined a chat channel

            +

            Type declaration

              • (data): void
              • Parameters

                • data: string | {
                      errcode: string;
                  }

                Returns void

            HUP: (() => void)

            The client should reload

            +

            Type declaration

              • (): void
              • Returns void

            active-bots: ((data) => void)

            Updates the list of bots that are connected and ready to the server

            +

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      [id: number]: User;
                  }

                Returns void

            active_game: ((data) => void)

            Message to inform the client of an active game, or a change to an existing game

            +

            Type declaration

            automatch/cancel: ((data) => void)

            An automatch request was canceled

            +

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      uuid: string;
                  }
                  • uuid: string

                Returns void

            automatch/entry: ((data) => void)

            An automatch request is active

            +

            Type declaration

            automatch/start: ((data) => void)

            An automatch request was started

            +

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      game_id: number;
                      uuid: string;
                  }
                  • game_id: number
                  • uuid: string

                Returns void

            chat-join: ((data) => void)

            User(s) joined a chat channel

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: string;
                      users: User[];
                  }
                  • channel: string

                    The channel

                  • users: User[]

                    List of users that joined

                    -

                Returns void

            chat-message: ((data) => void)

            Chat message was received

            +

            Returns void

            chat-message: ((data) => void)

            Chat message was received

            Type declaration

              • (data): void
              • Parameters

                • data: {
                      channel: string;
                      country?: string;
                      id: number;
                      message: {
                          i?: string;
                          m: string;
                          t: number;
                      };
                      professional: boolean;
                      ranking: number;
                      system?: true;
                      system_message_type?: "flood";
                      ui_class: string;
                      username: string;
                  }
                  • channel: string

                    The channel

                  • Optional country?: string

                    Country the user is from

                  • id: number

                    User id of the sender

                    @@ -73,14 +73,14 @@
                  • Optional system?: true

                    Whether it's a system message or not

                  • Optional system_message_type?: "flood"
                  • ui_class: string

                    UI class of the sender

                  • username: string

                    Username of the sender

                    -

                Returns void

            chat-message-removed: ((data) => void)

            A chat message should be removed from the display

            +

            Returns void

            chat-message-removed: ((data) => void)

            A chat message should be removed from the display

            Type declaration

            chat-part: ((data) => void)

            User left a chat channel

            +

            Returns void

            chat-part: ((data) => void)

            User left a chat channel

            Type declaration

            chat-topic: ((data) => void)

            Channel topic was updated

            +

            Returns void

            chat-topic: ((data) => void)

            Channel topic was updated

            Type declaration

            chat-update-user: ((data) => void)

            A user's profile was updated

            +

            Returns void

            chat-update-user: ((data) => void)

            A user's profile was updated

            Type declaration

            game/:id/auto_resign: ((data) => void)

            Informs the client the player is scheduled to resign if not cleared

            +

            Returns void

            game/:id/auto_resign: ((data) => void)

            Informs the client the player is scheduled to resign if not cleared

            Type declaration

            game/:id/chat: ((data) => void)

            A game chat message

            -

            Type declaration

            game/:id/chat/remove: ((data) => void)

            Game chat lines should be removed

            +

            Returns void

            game/:id/chat: ((data) => void)

            A game chat message

            +

            Type declaration

            game/:id/chat/remove: ((data) => void)

            Game chat lines should be removed

            Type declaration

            game/:id/clear_auto_resign: ((data) => void)

            The auto resign for the given player has been cleared

            +

            Returns void

            game/:id/clear_auto_resign: ((data) => void)

            The auto resign for the given player has been cleared

            Type declaration

            game/:id/clock: ((data) => void)

            Game clock update

            -

            Type declaration

            game/:id/conditional_moves: ((data) => void)

            Update the conditional moves currently active

            +

            Returns void

            game/:id/clock: ((data) => void)

            Game clock update

            +

            Type declaration

            game/:id/conditional_moves: ((data) => void)

            Update the conditional moves currently active

            Type declaration

            game/:id/error: ((data) => void)

            Error that should be displayed to the user

            -

            Type declaration

            game/:id/gamedata: ((data) => void)

            Update the entire game state

            -

            Type declaration

            game/:id/latency: ((data) => void)

            Update latency information for a player

            +

            Returns void

            game/:id/error: ((data) => void)

            Error that should be displayed to the user

            +

            Type declaration

            game/:id/gamedata: ((data) => void)

            Update the entire game state

            +

            Type declaration

            game/:id/latency: ((data) => void)

            Update latency information for a player

            Type declaration

            game/:id/phase: ((data) => void)

            The phase has changed for the game

            -

            Type declaration

            game/:id/removed_stones: ((data) => void)

            Update the state of the stone removal phase

            -

            Type declaration

            game/:id/removed_stones_accepted: ((data) => void)

            The stone removal phase has been completed, this is the final state and +

            Returns void

            game/:id/phase: ((data) => void)

            The phase has changed for the game

            +

            Type declaration

            game/:id/removed_stones: ((data) => void)

            Update the state of the stone removal phase

            +

            Type declaration

            game/:id/removed_stones_accepted: ((data) => void)

            The stone removal phase has been completed, this is the final state and indicates a phase change to the given phase (should always be "finished")

            Type declaration

            game/:id/reset-chats: (() => void)

            The chat log should be reset.

            -

            Type declaration

            game/:id/stalling_score_estimate: ((data?) => void)

            A score estimation result has been broadcast, this is used for avoiding game stalling

            -

            Type declaration

            game/:id/undo_accepted: ((data) => void)

            Undo move has been accepted, the parameter is the new move number

            -

            Type declaration

            game/:id/undo_canceled: ((data) => void)

            Undo request has been canceled, the parameter is the move number of the original request

            -

            Type declaration

            game/:id/undo_requested: ((data) => void)

            Undo request has been requested, the parameter is the move number that we want to go back to

            -

            Type declaration

            gamelist-count: ((data) => void)

            Update number of live and correspondence games are currently being +

            Returns void

            game/:id/reset-chats: (() => void)

            The chat log should be reset.

            +

            Type declaration

            game/:id/stalling_score_estimate: ((data?) => void)

            A score estimation result has been broadcast, this is used for avoiding game stalling

            +

            Type declaration

            game/:id/undo_accepted: ((data) => void)

            Undo move has been accepted, the parameter is the new move number

            +

            Type declaration

            game/:id/undo_canceled: ((data) => void)

            Undo request has been canceled, the parameter is the move number of the original request

            +

            Type declaration

            game/:id/undo_requested: ((data) => void)

            Undo request has been requested, the parameter is the move number that we want to go back to

            +

            Type declaration

            gamelist-count: ((data) => void)

            Update number of live and correspondence games are currently being played

            Type declaration

            gamelist-count-:channel: ((data) => void)

            Update number of live and correspondence games are currently being +

            Returns void

            gamelist-count-:channel: ((data) => void)

            Update number of live and correspondence games are currently being played in a particular channel

            Type declaration

            hostinfo: ((data) => void)

            General host information for the termination server you +

            Returns void

            hostinfo: ((data) => void)

            General host information for the termination server you are connected to. This is a response to the hostinfo client message.

            Type declaration

            incident-report: ((data) => void)

            Incident report update

            -

            Type declaration

            itc: ((data) => void)

            "Inter Tab Communication" message. This is a client utility to enable +

            Returns void

            incident-report: ((data) => void)

            Incident report update

            +

            Type declaration

            itc: ((data) => void)

            "Inter Tab Communication" message. This is a client utility to enable relaying of messages between devices - the event and data are application defined, the server blindly relays to all connected devices for the sending user. Note this is relayed to all devices regardless @@ -163,17 +163,17 @@ the web client sending this will arrive on an android and ios instance)

            Type declaration

            net/pong: ((data) => void)

            Pong response from a ping

            +

            Returns void

            net/pong: ((data) => void)

            Pong response from a ping

            Type declaration

            notification: ((data) => void)

            A notification that should be displayed to the user +

            Returns void

            notification: ((data) => void)

            A notification that should be displayed to the user These are not strongly modeled, see https://github.com/online-go/online-go.com/blob/devel/src/components/Notifications/Notifications.tsx as a reference for what types there are and what data they contain

            Type declaration

            private-message: ((data) => void)

            A private message was received

            +

            Returns void

            private-message: ((data) => void)

            A private message was received

            Type declaration

            private-superchat: ((data) => void)

            Notify the client that a private message "super chat" has started. A +

            Returns void

            private-superchat: ((data) => void)

            Notify the client that a private message "super chat" has started. A super chat is an undismissable chat sent by a moderator. It should take all focus and not let the client do anything until the conversation is resolved (the enable flag is set to false)

            @@ -194,30 +194,30 @@
          • moderator_username: string

            The moderator username contacting the player

          • player_id: number

            Your id

          • player_username: string

            Your username

            -
          • Returns void

            remote_storage/sync_complete: (() => void)

            Notification that the server has completed sending all remote storage +

            Returns void

            remote_storage/sync_complete: (() => void)

            Notification that the server has completed sending all remote storage data and the client should now be up to date.

            -

            Type declaration

            remote_storage/update: ((data) => void)

            Updates a key value pair

            +

            Type declaration

            remote_storage/update: ((data) => void)

            Updates a key value pair

            Type declaration

            review/:id/full_state: ((data) => void)

            Replay of the entire full state of the review

            -

            Type declaration

            review/:id/r: ((data) => void)

            An incremental modification to the review stream

            -

            Type declaration

            score-estimator-enabled-state: ((data) => void)

            Notifies the client whether the the client shares an IP with one of the +

            Returns void

            review/:id/full_state: ((data) => void)

            Replay of the entire full state of the review

            +

            Type declaration

            review/:id/r: ((data) => void)

            An incremental modification to the review stream

            +

            Type declaration

            score-estimator-enabled-state: ((data) => void)

            Notifies the client whether the the client shares an IP with one of the players of the game. This is used to disable the score estimator in anonymous browsing windows for players of a game when the score estimator is disabled for the game.

            Type declaration

            seekgraph/global: ((messages) => void)

            Type declaration

            ui-push: ((data) => void)

            A UI Push notification. The event and data are not well defined here, +

            Returns void

            seekgraph/global: ((messages) => void)

            Type declaration

            ui-push: ((data) => void)

            A UI Push notification. The event and data are not well defined here, they come as a result to subscribing to ui push channels with ui-pushes/subscribe.

            Type declaration

            user/jwt: ((jwt) => void)

            Update the user's JWT token

            -

            Type declaration

            user/state: ((data) => void)

            Updates whether a user is online or not. Subscribe to these updates for +

            Returns void

            user/jwt: ((jwt) => void)

            Update the user's JWT token

            +

            Type declaration

            user/state: ((data) => void)

            Updates whether a user is online or not. Subscribe to these updates for particular users using the user/monitor command.

            -

            Type declaration

            user/update: ((user) => void)

            Update user information. For other players, this has the standard User +

            Type declaration

            user/update: ((user) => void)

            Update user information. For other players, this has the standard User fields, when this is the current user, it can have additional fields that are found in the ui/config

            -

            Type declaration

            \ No newline at end of file +

            Type declaration

            \ No newline at end of file diff --git a/docs/interfaces/protocol.StallingScoreEstimate.html b/docs/interfaces/protocol.StallingScoreEstimate.html index 01fc161d..3af3a534 100644 --- a/docs/interfaces/protocol.StallingScoreEstimate.html +++ b/docs/interfaces/protocol.StallingScoreEstimate.html @@ -1,8 +1,8 @@ -StallingScoreEstimate | goban

            Interface StallingScoreEstimate

            interface StallingScoreEstimate {
                game_id: number;
                move_number: number;
                ownership: any[];
                predicted_winner: "black" | "white";
                removed: string;
                score: number;
                win_rate: number;
            }

            Properties

            game_id +StallingScoreEstimate | goban

            Interface StallingScoreEstimate

            interface StallingScoreEstimate {
                game_id: number;
                move_number: number;
                ownership: any[];
                predicted_winner: "black" | "white";
                removed: string;
                score: number;
                win_rate: number;
            }

            Properties

            game_id: number
            move_number: number
            ownership: any[]
            predicted_winner: "black" | "white"
            removed: string
            score: number
            win_rate: number
            \ No newline at end of file +

            Properties

            game_id: number
            move_number: number
            ownership: any[]
            predicted_winner: "black" | "white"
            removed: string
            score: number
            win_rate: number
            \ No newline at end of file diff --git a/docs/interfaces/protocol.User.html b/docs/interfaces/protocol.User.html index 2fba7845..ddba2235 100644 --- a/docs/interfaces/protocol.User.html +++ b/docs/interfaces/protocol.User.html @@ -1,8 +1,8 @@ -User | goban

            Interface User

            interface User {
                country?: string;
                id: number;
                professional?: boolean;
                ranking?: number;
                ratings?: {
                    [speed_size: string]: Glicko2;
                };
                ui_class?: string;
                username: string;
            }

            Properties

            country? +User | goban

            Interface User

            interface User {
                country?: string;
                id: number;
                professional?: boolean;
                ranking?: number;
                ratings?: {
                    [speed_size: string]: Glicko2;
                };
                ui_class?: string;
                username: string;
            }

            Properties

            country?: string
            id: number
            professional?: boolean
            ranking?: number
            ratings?: {
                [speed_size: string]: Glicko2;
            }

            Type declaration

            ui_class?: string
            username: string
            \ No newline at end of file +

            Properties

            country?: string
            id: number
            professional?: boolean
            ranking?: number
            ratings?: {
                [speed_size: string]: Glicko2;
            }

            Type declaration

            ui_class?: string
            username: string
            \ No newline at end of file diff --git a/docs/interfaces/translate.GobanStrings.html b/docs/interfaces/translate.GobanStrings.html index 829d0bc4..17d39f43 100644 --- a/docs/interfaces/translate.GobanStrings.html +++ b/docs/interfaces/translate.GobanStrings.html @@ -1,4 +1,4 @@ -GobanStrings | goban

            Interface GobanStrings

            interface GobanStrings {
                %sd: string;
                %sh: string;
                %sm: string;
                %ss: string;
                %swk: string;
                A stone has already been placed here: string;
                Anime: string;
                Black: string;
                Black Walnut: string;
                Black to move: string;
                Book: string;
                Bright Kaya: string;
                Control passed to %s: string;
                Custom: string;
                Enter the label you want to add to the board: string;
                Error: string;
                Error submitting move: string;
                Game Finished: string;
                Glass: string;
                Granite: string;
                HNG: string;
                HNG Night: string;
                Illegal Ko Move: string;
                Illegal board repetition: string;
                Kaya: string;
                Loading...: string;
                Move is suicidal: string;
                Night: string;
                Night Play: string;
                Persimmon: string;
                Plain: string;
                Processing...: string;
                Red Oak: string;
                Review: string;
                Self-capture is not allowed: string;
                Shell: string;
                Slate: string;
                Stone Removal: string;
                Stone Removal Phase: string;
                Submitting...: string;
                Synchronization error, reloading: string;
                The game would be repeating with that move, please play somewhere else first: string;
                White: string;
                White to move: string;
                Worn Glass: string;
                Your move: string;
                Your move - opponent passed: string;
            }

            Properties

            %sd +GobanStrings | goban

            Interface GobanStrings

            interface GobanStrings {
                %sd: string;
                %sh: string;
                %sm: string;
                %ss: string;
                %swk: string;
                A stone has already been placed here: string;
                Anime: string;
                Black: string;
                Black Walnut: string;
                Black to move: string;
                Book: string;
                Bright Kaya: string;
                Control passed to %s: string;
                Custom: string;
                Enter the label you want to add to the board: string;
                Error: string;
                Error submitting move: string;
                Game Finished: string;
                Glass: string;
                Granite: string;
                HNG: string;
                HNG Night: string;
                Illegal Ko Move: string;
                Illegal board repetition: string;
                Kaya: string;
                Loading...: string;
                Move is suicidal: string;
                Night: string;
                Night Play: string;
                Persimmon: string;
                Plain: string;
                Processing...: string;
                Red Oak: string;
                Review: string;
                Self-capture is not allowed: string;
                Shell: string;
                Slate: string;
                Stone Removal: string;
                Stone Removal Phase: string;
                Submitting...: string;
                Synchronization error, reloading: string;
                The game would be repeating with that move, please play somewhere else first: string;
                White: string;
                White to move: string;
                Worn Glass: string;
                Your move: string;
                Your move - opponent passed: string;
            }

            Properties

            %sd: string
            %sh: string
            %sm: string
            %ss: string
            %swk: string
            A stone has already been placed here: string
            Anime: string
            Black: string
            Black Walnut: string
            Black to move: string
            Book: string
            Bright Kaya: string
            Control passed to %s: string
            Custom: string
            Enter the label you want to add to the board: string
            Error: string
            Error submitting move: string
            Game Finished: string
            Glass: string
            Granite: string
            HNG: string
            HNG Night: string
            Illegal Ko Move: string
            Illegal board repetition: string
            Kaya: string
            Loading...: string
            Move is suicidal: string
            Night: string
            Night Play: string
            Persimmon: string
            Plain: string
            Processing...: string
            Red Oak: string
            Review: string
            Self-capture is not allowed: string
            Shell: string
            Slate: string
            Stone Removal: string
            Stone Removal Phase: string
            Submitting...: string
            Synchronization error, reloading: string
            The game would be repeating with that move, please play somewhere else first: string
            White: string
            White to move: string
            Worn Glass: string
            Your move: string
            Your move - opponent passed: string
            \ No newline at end of file +

            Properties

            %sd: string
            %sh: string
            %sm: string
            %ss: string
            %swk: string
            A stone has already been placed here: string
            Anime: string
            Black: string
            Black Walnut: string
            Black to move: string
            Book: string
            Bright Kaya: string
            Control passed to %s: string
            Custom: string
            Enter the label you want to add to the board: string
            Error: string
            Error submitting move: string
            Game Finished: string
            Glass: string
            Granite: string
            HNG: string
            HNG Night: string
            Illegal Ko Move: string
            Illegal board repetition: string
            Kaya: string
            Loading...: string
            Move is suicidal: string
            Night: string
            Night Play: string
            Persimmon: string
            Plain: string
            Processing...: string
            Red Oak: string
            Review: string
            Self-capture is not allowed: string
            Shell: string
            Slate: string
            Stone Removal: string
            Stone Removal Phase: string
            Submitting...: string
            Synchronization error, reloading: string
            The game would be repeating with that move, please play somewhere else first: string
            White: string
            White to move: string
            Worn Glass: string
            Your move: string
            Your move - opponent passed: string
            \ No newline at end of file diff --git a/docs/modules/protocol.html b/docs/modules/protocol.html index dae3c7a0..f5782d25 100644 --- a/docs/modules/protocol.html +++ b/docs/modules/protocol.html @@ -59,7 +59,7 @@ for backwards compatibility.

            -

            Index

            Enumerations

            Index

            Enumerations

            Interfaces

            AIServerToClient AutomatchPreferences ClientToAIServer diff --git a/docs/modules/translate.html b/docs/modules/translate.html index 60231011..d541053e 100644 --- a/docs/modules/translate.html +++ b/docs/modules/translate.html @@ -1,4 +1,4 @@ -translate | goban

            Namespace translate

            Index

            Interfaces

            GobanStrings +translate | goban

            Namespace translate

            Index

            Interfaces

            Functions

            _ interpolate setGobanTranslations diff --git a/docs/types/AdHocPackedMove.html b/docs/types/AdHocPackedMove.html index 05393118..562768f0 100644 --- a/docs/types/AdHocPackedMove.html +++ b/docs/types/AdHocPackedMove.html @@ -1 +1 @@ -AdHocPackedMove | goban

            Type alias AdHocPackedMove

            AdHocPackedMove: [number, number, number?, JGOFNumericPlayerColor?, {
                [index: string]: any;
            }?]
            \ No newline at end of file +AdHocPackedMove | goban

            Type alias AdHocPackedMove

            AdHocPackedMove: [number, number, number?, JGOFNumericPlayerColor?, {
                [index: string]: any;
            }?]
            \ No newline at end of file diff --git a/docs/types/AnalysisSubTool.html b/docs/types/AnalysisSubTool.html index aae64627..160a1c15 100644 --- a/docs/types/AnalysisSubTool.html +++ b/docs/types/AnalysisSubTool.html @@ -1 +1 @@ -AnalysisSubTool | goban

            Type alias AnalysisSubTool

            AnalysisSubTool: "black" | "white" | "alternate" | "letters" | "numbers" | string
            \ No newline at end of file +AnalysisSubTool | goban

            Type alias AnalysisSubTool

            AnalysisSubTool: "black" | "white" | "alternate" | "letters" | "numbers" | string
            \ No newline at end of file diff --git a/docs/types/AnalysisTool.html b/docs/types/AnalysisTool.html index 34203149..eaa2fe1e 100644 --- a/docs/types/AnalysisTool.html +++ b/docs/types/AnalysisTool.html @@ -1 +1 @@ -AnalysisTool | goban

            Type alias AnalysisTool

            AnalysisTool: "stone" | "draw" | "label" | "score" | "removal"
            \ No newline at end of file +AnalysisTool | goban

            Type alias AnalysisTool

            AnalysisTool: "stone" | "draw" | "label" | "score" | "removal"
            \ No newline at end of file diff --git a/docs/types/BoardTransform.html b/docs/types/BoardTransform.html index 4dbebf8f..270cf991 100644 --- a/docs/types/BoardTransform.html +++ b/docs/types/BoardTransform.html @@ -9,4 +9,4 @@

            The "easy to understand" part is that the id can be compared visually to the board position

            The downside is that the id string can be moderately long for boards with lots of stones

            -

            Type declaration

              • (x, y): {
                    x: number;
                    y: number;
                }
              • Parameters

                • x: number
                • y: number

                Returns {
                    x: number;
                    y: number;
                }

                • x: number
                • y: number
            \ No newline at end of file +

            Type declaration

              • (x, y): {
                    x: number;
                    y: number;
                }
              • Parameters

                • x: number
                • y: number

                Returns {
                    x: number;
                    y: number;
                }

                • x: number
                • y: number
            \ No newline at end of file diff --git a/docs/types/ConditionalMoveResponse.html b/docs/types/ConditionalMoveResponse.html index 0cc1dd2f..97a01025 100644 --- a/docs/types/ConditionalMoveResponse.html +++ b/docs/types/ConditionalMoveResponse.html @@ -1,3 +1,3 @@ ConditionalMoveResponse | goban

            Type alias ConditionalMoveResponse

            ConditionalMoveResponse: [string | null, ConditionalMoveResponseTree]

            A branch in the conditional move tree, consists of the response move and the sub-tree of the next possible moves

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/docs/types/DataArgument.html b/docs/types/DataArgument.html index 894d0a60..402af117 100644 --- a/docs/types/DataArgument.html +++ b/docs/types/DataArgument.html @@ -1 +1 @@ -DataArgument | goban

            Type alias DataArgument<Entry>

            DataArgument<Entry>: Entry extends ((...args) => void)
                ? A[0]
                : never

            Type Parameters

            • Entry
            \ No newline at end of file +DataArgument | goban

            Type alias DataArgument<Entry>

            DataArgument<Entry>: Entry extends ((...args) => void)
                ? A[0]
                : never

            Type Parameters

            • Entry
            \ No newline at end of file diff --git a/docs/types/GobanChatLog.html b/docs/types/GobanChatLog.html index fc1e2bf4..ab059fc2 100644 --- a/docs/types/GobanChatLog.html +++ b/docs/types/GobanChatLog.html @@ -1 +1 @@ -GobanChatLog | goban

            Type alias GobanChatLog

            GobanChatLog: GameChatLine[]
            \ No newline at end of file +GobanChatLog | goban

            Type alias GobanChatLog

            GobanChatLog: GameChatLine[]
            \ No newline at end of file diff --git a/docs/types/GobanEnginePhase.html b/docs/types/GobanEnginePhase.html index 071ff329..318b59ec 100644 --- a/docs/types/GobanEnginePhase.html +++ b/docs/types/GobanEnginePhase.html @@ -1 +1 @@ -GobanEnginePhase | goban

            Type alias GobanEnginePhase

            GobanEnginePhase: "play" | "stone removal" | "finished"
            \ No newline at end of file +GobanEnginePhase | goban

            Type alias GobanEnginePhase

            GobanEnginePhase: "play" | "stone removal" | "finished"
            \ No newline at end of file diff --git a/docs/types/GobanEngineRules.html b/docs/types/GobanEngineRules.html index 6538c2e7..9df1725c 100644 --- a/docs/types/GobanEngineRules.html +++ b/docs/types/GobanEngineRules.html @@ -1 +1 @@ -GobanEngineRules | goban

            Type alias GobanEngineRules

            GobanEngineRules: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz"
            \ No newline at end of file +GobanEngineRules | goban

            Type alias GobanEngineRules

            GobanEngineRules: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz"
            \ No newline at end of file diff --git a/docs/types/GobanEngineSuperKoAlgorithm.html b/docs/types/GobanEngineSuperKoAlgorithm.html index 51193129..1ef0ea33 100644 --- a/docs/types/GobanEngineSuperKoAlgorithm.html +++ b/docs/types/GobanEngineSuperKoAlgorithm.html @@ -1 +1 @@ -GobanEngineSuperKoAlgorithm | goban

            Type alias GobanEngineSuperKoAlgorithm

            GobanEngineSuperKoAlgorithm: "psk" | "csk" | "ssk" | "noresult" | "ing"
            \ No newline at end of file +GobanEngineSuperKoAlgorithm | goban

            Type alias GobanEngineSuperKoAlgorithm

            GobanEngineSuperKoAlgorithm: "psk" | "csk" | "ssk" | "noresult" | "ing"
            \ No newline at end of file diff --git a/docs/types/GobanErrorMessageId.html b/docs/types/GobanErrorMessageId.html index 676a009f..7ddad23d 100644 --- a/docs/types/GobanErrorMessageId.html +++ b/docs/types/GobanErrorMessageId.html @@ -1 +1 @@ -GobanErrorMessageId | goban

            Type alias GobanErrorMessageId

            \ No newline at end of file +GobanErrorMessageId | goban

            Type alias GobanErrorMessageId

            \ No newline at end of file diff --git a/docs/types/GobanErrorMessageObject.html b/docs/types/GobanErrorMessageObject.html index 3eeb9e21..251c87bb 100644 --- a/docs/types/GobanErrorMessageObject.html +++ b/docs/types/GobanErrorMessageObject.html @@ -1 +1 @@ -GobanErrorMessageObject | goban

            Type alias GobanErrorMessageObject

            \ No newline at end of file +GobanErrorMessageObject | goban

            Type alias GobanErrorMessageObject

            \ No newline at end of file diff --git a/docs/types/GobanIOErrorMessageId.html b/docs/types/GobanIOErrorMessageId.html index 277f5b9c..e530bc70 100644 --- a/docs/types/GobanIOErrorMessageId.html +++ b/docs/types/GobanIOErrorMessageId.html @@ -1 +1 @@ -GobanIOErrorMessageId | goban

            Type alias GobanIOErrorMessageId

            GobanIOErrorMessageId: "failed_to_load_sgf"
            \ No newline at end of file +GobanIOErrorMessageId | goban

            Type alias GobanIOErrorMessageId

            GobanIOErrorMessageId: "failed_to_load_sgf"
            \ No newline at end of file diff --git a/docs/types/GobanModes.html b/docs/types/GobanModes.html index 8b8055e4..3b68f094 100644 --- a/docs/types/GobanModes.html +++ b/docs/types/GobanModes.html @@ -1 +1 @@ -GobanModes | goban

            Type alias GobanModes

            GobanModes: "play" | "puzzle" | "score estimation" | "analyze" | "conditional"
            \ No newline at end of file +GobanModes | goban

            Type alias GobanModes

            GobanModes: "play" | "puzzle" | "score estimation" | "analyze" | "conditional"
            \ No newline at end of file diff --git a/docs/types/GobanMoveErrorMessageId.html b/docs/types/GobanMoveErrorMessageId.html index fbd72c58..ff57dc7a 100644 --- a/docs/types/GobanMoveErrorMessageId.html +++ b/docs/types/GobanMoveErrorMessageId.html @@ -1 +1 @@ -GobanMoveErrorMessageId | goban

            Type alias GobanMoveErrorMessageId

            GobanMoveErrorMessageId: "stone_already_placed_here" | "illegal_self_capture" | "illegal_ko_move" | "illegal_board_repetition" | "move_error"
            \ No newline at end of file +GobanMoveErrorMessageId | goban

            Type alias GobanMoveErrorMessageId

            GobanMoveErrorMessageId: "stone_already_placed_here" | "illegal_self_capture" | "illegal_ko_move" | "illegal_board_repetition" | "move_error"
            \ No newline at end of file diff --git a/docs/types/GobanMovesArray.html b/docs/types/GobanMovesArray.html index 0df83a3c..036715f0 100644 --- a/docs/types/GobanMovesArray.html +++ b/docs/types/GobanMovesArray.html @@ -1 +1 @@ -GobanMovesArray | goban

            Type alias GobanMovesArray

            GobanMovesArray: AdHocPackedMove[] | JGOFMove[]
            \ No newline at end of file +GobanMovesArray | goban

            Type alias GobanMovesArray

            GobanMovesArray: AdHocPackedMove[] | JGOFMove[]
            \ No newline at end of file diff --git a/docs/types/GobanRenderer.html b/docs/types/GobanRenderer.html index 3a40aaa6..3542e8ca 100644 --- a/docs/types/GobanRenderer.html +++ b/docs/types/GobanRenderer.html @@ -1 +1 @@ -GobanRenderer | goban

            Type alias GobanRenderer

            GobanRenderer: GobanCanvas | SVGRenderer
            \ No newline at end of file +GobanRenderer | goban

            Type alias GobanRenderer

            GobanRenderer: GobanCanvas | SVGRenderer
            \ No newline at end of file diff --git a/docs/types/GobanRendererConfig.html b/docs/types/GobanRendererConfig.html index 77216457..dc4bf926 100644 --- a/docs/types/GobanRendererConfig.html +++ b/docs/types/GobanRendererConfig.html @@ -1 +1 @@ -GobanRendererConfig | goban

            Type alias GobanRendererConfig

            \ No newline at end of file +GobanRendererConfig | goban

            Type alias GobanRendererConfig

            \ No newline at end of file diff --git a/docs/types/JGOFTimeControl.html b/docs/types/JGOFTimeControl.html index 0a62dcff..bbf6b71f 100644 --- a/docs/types/JGOFTimeControl.html +++ b/docs/types/JGOFTimeControl.html @@ -1 +1 @@ -JGOFTimeControl | goban
            \ No newline at end of file +JGOFTimeControl | goban
            \ No newline at end of file diff --git a/docs/types/JGOFTimeControlSpeed.html b/docs/types/JGOFTimeControlSpeed.html index 53f65947..b3945343 100644 --- a/docs/types/JGOFTimeControlSpeed.html +++ b/docs/types/JGOFTimeControlSpeed.html @@ -1 +1 @@ -JGOFTimeControlSpeed | goban

            Type alias JGOFTimeControlSpeed

            JGOFTimeControlSpeed: "blitz" | "live" | "correspondence"
            \ No newline at end of file +JGOFTimeControlSpeed | goban

            Type alias JGOFTimeControlSpeed

            JGOFTimeControlSpeed: "blitz" | "live" | "correspondence"
            \ No newline at end of file diff --git a/docs/types/JGOFTimeControlSystem.html b/docs/types/JGOFTimeControlSystem.html index e002f98e..c724c6e1 100644 --- a/docs/types/JGOFTimeControlSystem.html +++ b/docs/types/JGOFTimeControlSystem.html @@ -1 +1 @@ -JGOFTimeControlSystem | goban

            Type alias JGOFTimeControlSystem

            JGOFTimeControlSystem: "fischer" | "byoyomi" | "canadian" | "simple" | "absolute" | "none"
            \ No newline at end of file +JGOFTimeControlSystem | goban

            Type alias JGOFTimeControlSystem

            JGOFTimeControlSystem: "fischer" | "byoyomi" | "canadian" | "simple" | "absolute" | "none"
            \ No newline at end of file diff --git a/docs/types/LabelPosition.html b/docs/types/LabelPosition.html index 9d19ec52..dde25132 100644 --- a/docs/types/LabelPosition.html +++ b/docs/types/LabelPosition.html @@ -1 +1 @@ -LabelPosition | goban

            Type alias LabelPosition

            LabelPosition: "all" | "none" | "top-left" | "top-right" | "bottom-right" | "bottom-left"
            \ No newline at end of file +LabelPosition | goban

            Type alias LabelPosition

            LabelPosition: "all" | "none" | "top-left" | "top-right" | "bottom-right" | "bottom-left"
            \ No newline at end of file diff --git a/docs/types/Matrix.html b/docs/types/Matrix.html index f685922d..dc0037cf 100644 --- a/docs/types/Matrix.html +++ b/docs/types/Matrix.html @@ -1 +1 @@ -Matrix | goban

            Type alias Matrix<T>

            Matrix<T>: T[][]

            Type Parameters

            • T
            \ No newline at end of file +Matrix | goban

            Type alias Matrix<T>

            Matrix<T>: T[][]

            Type Parameters

            • T
            \ No newline at end of file diff --git a/docs/types/MoveTreePenMarks.html b/docs/types/MoveTreePenMarks.html index 501b38da..1b8024e7 100644 --- a/docs/types/MoveTreePenMarks.html +++ b/docs/types/MoveTreePenMarks.html @@ -1 +1 @@ -MoveTreePenMarks | goban

            Type alias MoveTreePenMarks

            MoveTreePenMarks: {
                color: string;
                points: number[];
            }[]

            Type declaration

            • color: string
            • points: number[]
            \ No newline at end of file +MoveTreePenMarks | goban

            Type alias MoveTreePenMarks

            MoveTreePenMarks: {
                color: string;
                points: number[];
            }[]

            Type declaration

            • color: string
            • points: number[]
            \ No newline at end of file diff --git a/docs/types/NumberMatrix.html b/docs/types/NumberMatrix.html index e6c534f1..87aabfdf 100644 --- a/docs/types/NumberMatrix.html +++ b/docs/types/NumberMatrix.html @@ -1 +1 @@ -NumberMatrix | goban

            Type alias NumberMatrix

            NumberMatrix: Matrix<number>
            \ No newline at end of file +NumberMatrix | goban

            Type alias NumberMatrix

            NumberMatrix: Matrix<number>
            \ No newline at end of file diff --git a/docs/types/PlayerColor.html b/docs/types/PlayerColor.html index 09c2a9e6..f84a00a1 100644 --- a/docs/types/PlayerColor.html +++ b/docs/types/PlayerColor.html @@ -1 +1 @@ -PlayerColor | goban

            Type alias PlayerColor

            PlayerColor: "black" | "white"
            \ No newline at end of file +PlayerColor | goban

            Type alias PlayerColor

            PlayerColor: "black" | "white"
            \ No newline at end of file diff --git a/docs/types/ProtocolResponseType.html b/docs/types/ProtocolResponseType.html index 5e11cd68..3ed58545 100644 --- a/docs/types/ProtocolResponseType.html +++ b/docs/types/ProtocolResponseType.html @@ -1 +1 @@ -ProtocolResponseType | goban

            Type alias ProtocolResponseType<Entry>

            ProtocolResponseType<Entry>: Entry extends ((...args) => infer R)
                ? R
                : never

            Type Parameters

            • Entry
            \ No newline at end of file +ProtocolResponseType | goban

            Type alias ProtocolResponseType<Entry>

            ProtocolResponseType<Entry>: Entry extends ((...args) => infer R)
                ? R
                : never

            Type Parameters

            • Entry
            \ No newline at end of file diff --git a/docs/types/PuzzleOpponentMoveMode.html b/docs/types/PuzzleOpponentMoveMode.html index 6fdc1eab..b7fdcfb6 100644 --- a/docs/types/PuzzleOpponentMoveMode.html +++ b/docs/types/PuzzleOpponentMoveMode.html @@ -1 +1 @@ -PuzzleOpponentMoveMode | goban

            Type alias PuzzleOpponentMoveMode

            PuzzleOpponentMoveMode: "manual" | "automatic"
            \ No newline at end of file +PuzzleOpponentMoveMode | goban

            Type alias PuzzleOpponentMoveMode

            PuzzleOpponentMoveMode: "manual" | "automatic"
            \ No newline at end of file diff --git a/docs/types/PuzzlePlacementSetting.html b/docs/types/PuzzlePlacementSetting.html index b53a4688..843fd583 100644 --- a/docs/types/PuzzlePlacementSetting.html +++ b/docs/types/PuzzlePlacementSetting.html @@ -1 +1 @@ -PuzzlePlacementSetting | goban

            Type alias PuzzlePlacementSetting

            PuzzlePlacementSetting: {
                mode: "play";
            } | {
                color: JGOFNumericPlayerColor;
                mode: "setup";
            } | {
                color: 0;
                mode: "place";
            }

            Type declaration

            • mode: "play"

            Type declaration

            Type declaration

            • color: 0
            • mode: "place"
            \ No newline at end of file +PuzzlePlacementSetting | goban

            Type alias PuzzlePlacementSetting

            PuzzlePlacementSetting: {
                mode: "play";
            } | {
                color: JGOFNumericPlayerColor;
                mode: "setup";
            } | {
                color: 0;
                mode: "place";
            }

            Type declaration

            • mode: "play"

            Type declaration

            Type declaration

            • color: 0
            • mode: "place"
            \ No newline at end of file diff --git a/docs/types/PuzzlePlayerMoveMode.html b/docs/types/PuzzlePlayerMoveMode.html index 98be9cc6..1d60ff00 100644 --- a/docs/types/PuzzlePlayerMoveMode.html +++ b/docs/types/PuzzlePlayerMoveMode.html @@ -1 +1 @@ -PuzzlePlayerMoveMode | goban

            Type alias PuzzlePlayerMoveMode

            PuzzlePlayerMoveMode: "free" | "fixed"
            \ No newline at end of file +PuzzlePlayerMoveMode | goban

            Type alias PuzzlePlayerMoveMode

            PuzzlePlayerMoveMode: "free" | "fixed"
            \ No newline at end of file diff --git a/docs/types/RawStoneString.html b/docs/types/RawStoneString.html index f0d846e8..a5df632d 100644 --- a/docs/types/RawStoneString.html +++ b/docs/types/RawStoneString.html @@ -1,2 +1,2 @@ RawStoneString | goban

            Type alias RawStoneString

            RawStoneString: JGOFIntersection[]

            A raw stone string is simply an array of intersections

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/docs/types/StringMatrix.html b/docs/types/StringMatrix.html index 5829a6a2..444f660f 100644 --- a/docs/types/StringMatrix.html +++ b/docs/types/StringMatrix.html @@ -1 +1 @@ -StringMatrix | goban

            Type alias StringMatrix

            StringMatrix: Matrix<string>
            \ No newline at end of file +StringMatrix | goban

            Type alias StringMatrix

            StringMatrix: Matrix<string>
            \ No newline at end of file diff --git a/docs/types/_internal_.ClockTime.html b/docs/types/_internal_.ClockTime.html index bcfa5d8a..cda3701a 100644 --- a/docs/types/_internal_.ClockTime.html +++ b/docs/types/_internal_.ClockTime.html @@ -1 +1 @@ -ClockTime | goban
            \ No newline at end of file +ClockTime | goban
            \ No newline at end of file diff --git a/docs/types/_internal_.DebugOutput.html b/docs/types/_internal_.DebugOutput.html index 8181234c..58bd782e 100644 --- a/docs/types/_internal_.DebugOutput.html +++ b/docs/types/_internal_.DebugOutput.html @@ -1,2 +1,2 @@ DebugOutput | goban

            Type alias DebugOutput

            DebugOutput: string

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/docs/types/_internal_.LocalEstimator.html b/docs/types/_internal_.LocalEstimator.html index a50ef3c4..9b1d4744 100644 --- a/docs/types/_internal_.LocalEstimator.html +++ b/docs/types/_internal_.LocalEstimator.html @@ -5,4 +5,4 @@
          • trials: number

            number of playouts. Not applicable to all estimators, but higher generally means higher accuracy and higher compute cost

          • tolerance: number

            (0.0-1.0) confidence required to mark an intersection not neutral.

            -
          • Returns NumberMatrix

            \ No newline at end of file +

            Returns NumberMatrix

            \ No newline at end of file diff --git a/docs/types/_internal_.MessageID.html b/docs/types/_internal_.MessageID.html index fefff112..ed3c757c 100644 --- a/docs/types/_internal_.MessageID.html +++ b/docs/types/_internal_.MessageID.html @@ -1 +1 @@ -MessageID | goban

            Type alias MessageID

            MessageID: GobanMoveErrorMessageId | "error" | "error_submitting_move" | "loading" | "processing" | "self_capture_not_allowed" | "server_message" | "illegal_ko_move" | "synchronization_error"
            \ No newline at end of file +MessageID | goban

            Type alias MessageID

            MessageID: GobanMoveErrorMessageId | "error" | "error_submitting_move" | "loading" | "processing" | "self_capture_not_allowed" | "server_message" | "illegal_ko_move" | "synchronization_error"
            \ No newline at end of file diff --git a/docs/types/_internal_.NoneClock.html b/docs/types/_internal_.NoneClock.html index 06700093..2a5cb502 100644 --- a/docs/types/_internal_.NoneClock.html +++ b/docs/types/_internal_.NoneClock.html @@ -1 +1 @@ -NoneClock | goban

            Type alias NoneClock

            NoneClock: undefined
            \ No newline at end of file +NoneClock | goban

            Type alias NoneClock

            NoneClock: undefined
            \ No newline at end of file diff --git a/docs/types/_internal_.SimpleClock.html b/docs/types/_internal_.SimpleClock.html index b093077c..1ead432e 100644 --- a/docs/types/_internal_.SimpleClock.html +++ b/docs/types/_internal_.SimpleClock.html @@ -1 +1 @@ -SimpleClock | goban

            Type alias SimpleClock

            SimpleClock: number
            \ No newline at end of file +SimpleClock | goban

            Type alias SimpleClock

            SimpleClock: number
            \ No newline at end of file diff --git a/docs/types/_internal_.StoneType.html b/docs/types/_internal_.StoneType.html index 1d8e54a9..8521c4de 100644 --- a/docs/types/_internal_.StoneType.html +++ b/docs/types/_internal_.StoneType.html @@ -1 +1 @@ -StoneType | goban

            Type alias StoneType

            StoneType: {
                shadow: HTMLCanvasElement;
                stone: HTMLCanvasElement;
            }

            Type declaration

            • shadow: HTMLCanvasElement
            • stone: HTMLCanvasElement
            \ No newline at end of file +StoneType | goban

            Type alias StoneType

            StoneType: {
                shadow: HTMLCanvasElement;
                stone: HTMLCanvasElement;
            }

            Type declaration

            • shadow: HTMLCanvasElement
            • stone: HTMLCanvasElement
            \ No newline at end of file diff --git a/docs/types/_internal_.StoneTypeArray.html b/docs/types/_internal_.StoneTypeArray.html index 4549c39d..508bd0b6 100644 --- a/docs/types/_internal_.StoneTypeArray.html +++ b/docs/types/_internal_.StoneTypeArray.html @@ -1 +1 @@ -StoneTypeArray | goban

            Type alias StoneTypeArray

            StoneTypeArray: StoneType[]
            \ No newline at end of file +StoneTypeArray | goban

            Type alias StoneTypeArray

            StoneTypeArray: StoneType[]
            \ No newline at end of file diff --git a/docs/types/protocol.AutomatchCondition.html b/docs/types/protocol.AutomatchCondition.html index 794e3cca..93e91c8b 100644 --- a/docs/types/protocol.AutomatchCondition.html +++ b/docs/types/protocol.AutomatchCondition.html @@ -1 +1 @@ -AutomatchCondition | goban

            Type alias AutomatchCondition

            AutomatchCondition: "required" | "preferred" | "no-preference"
            \ No newline at end of file +AutomatchCondition | goban

            Type alias AutomatchCondition

            AutomatchCondition: "required" | "preferred" | "no-preference"
            \ No newline at end of file diff --git a/docs/types/protocol.RuleSet.html b/docs/types/protocol.RuleSet.html index 7c9768c1..8880210f 100644 --- a/docs/types/protocol.RuleSet.html +++ b/docs/types/protocol.RuleSet.html @@ -1 +1 @@ -RuleSet | goban

            Type alias RuleSet

            RuleSet: "japanese" | "chinese" | "aga" | "korean" | "nz" | "ing"
            \ No newline at end of file +RuleSet | goban

            Type alias RuleSet

            RuleSet: "japanese" | "chinese" | "aga" | "korean" | "nz" | "ing"
            \ No newline at end of file diff --git a/docs/types/protocol.Size.html b/docs/types/protocol.Size.html index 0b47ef14..2f772725 100644 --- a/docs/types/protocol.Size.html +++ b/docs/types/protocol.Size.html @@ -1 +1 @@ -Size | goban

            Type alias Size

            Size: "9x9" | "13x13" | "19x19"
            \ No newline at end of file +Size | goban

            Type alias Size

            Size: "9x9" | "13x13" | "19x19"
            \ No newline at end of file diff --git a/docs/types/protocol.Speed.html b/docs/types/protocol.Speed.html index cb7f2f7a..1d928f3f 100644 --- a/docs/types/protocol.Speed.html +++ b/docs/types/protocol.Speed.html @@ -1 +1 @@ -Speed | goban

            Type alias Speed

            Speed: "blitz" | "live" | "correspondence"
            \ No newline at end of file +Speed | goban

            Type alias Speed

            Speed: "blitz" | "live" | "correspondence"
            \ No newline at end of file diff --git a/docs/variables/AUTOSCORE_TOLERANCE.html b/docs/variables/AUTOSCORE_TOLERANCE.html index ae7294c1..16a81815 100644 --- a/docs/variables/AUTOSCORE_TOLERANCE.html +++ b/docs/variables/AUTOSCORE_TOLERANCE.html @@ -1 +1 @@ -AUTOSCORE_TOLERANCE | goban

            Variable AUTOSCORE_TOLERANCEConst

            AUTOSCORE_TOLERANCE: 0.1 = 0.1
            \ No newline at end of file +AUTOSCORE_TOLERANCE | goban

            Variable AUTOSCORE_TOLERANCEConst

            AUTOSCORE_TOLERANCE: 0.1 = 0.1
            \ No newline at end of file diff --git a/docs/variables/AUTOSCORE_TRIALS.html b/docs/variables/AUTOSCORE_TRIALS.html index f7eb6704..ae0f69b0 100644 --- a/docs/variables/AUTOSCORE_TRIALS.html +++ b/docs/variables/AUTOSCORE_TRIALS.html @@ -1 +1 @@ -AUTOSCORE_TRIALS | goban

            Variable AUTOSCORE_TRIALSConst

            AUTOSCORE_TRIALS: 1000 = 1000
            \ No newline at end of file +AUTOSCORE_TRIALS | goban

            Variable AUTOSCORE_TRIALSConst

            AUTOSCORE_TRIALS: 1000 = 1000
            \ No newline at end of file diff --git a/docs/variables/GOBAN_FONT.html b/docs/variables/GOBAN_FONT.html index 8aae1ff4..b871af3b 100644 --- a/docs/variables/GOBAN_FONT.html +++ b/docs/variables/GOBAN_FONT.html @@ -1 +1 @@ -GOBAN_FONT | goban

            Variable GOBAN_FONTConst

            GOBAN_FONT: "Verdana,Arial,sans-serif" = "Verdana,Arial,sans-serif"
            \ No newline at end of file +GOBAN_FONT | goban

            Variable GOBAN_FONTConst

            GOBAN_FONT: "Verdana,Arial,sans-serif" = "Verdana,Arial,sans-serif"
            \ No newline at end of file diff --git a/docs/variables/MARK_TYPES.html b/docs/variables/MARK_TYPES.html index d9765ec8..bf96ff7b 100644 --- a/docs/variables/MARK_TYPES.html +++ b/docs/variables/MARK_TYPES.html @@ -1 +1 @@ -MARK_TYPES | goban

            Variable MARK_TYPESConst

            MARK_TYPES: (keyof MarkInterface)[] = ...
            \ No newline at end of file +MARK_TYPES | goban

            Variable MARK_TYPESConst

            MARK_TYPES: (keyof MarkInterface)[] = ...
            \ No newline at end of file diff --git a/docs/variables/SCORE_ESTIMATION_TOLERANCE.html b/docs/variables/SCORE_ESTIMATION_TOLERANCE.html index 37e43ad7..36ff87ad 100644 --- a/docs/variables/SCORE_ESTIMATION_TOLERANCE.html +++ b/docs/variables/SCORE_ESTIMATION_TOLERANCE.html @@ -1 +1 @@ -SCORE_ESTIMATION_TOLERANCE | goban

            Variable SCORE_ESTIMATION_TOLERANCEConst

            SCORE_ESTIMATION_TOLERANCE: 0.3 = 0.3
            \ No newline at end of file +SCORE_ESTIMATION_TOLERANCE | goban

            Variable SCORE_ESTIMATION_TOLERANCEConst

            SCORE_ESTIMATION_TOLERANCE: 0.3 = 0.3
            \ No newline at end of file diff --git a/docs/variables/SCORE_ESTIMATION_TRIALS.html b/docs/variables/SCORE_ESTIMATION_TRIALS.html index 7a37b9fe..a720e8bf 100644 --- a/docs/variables/SCORE_ESTIMATION_TRIALS.html +++ b/docs/variables/SCORE_ESTIMATION_TRIALS.html @@ -1 +1 @@ -SCORE_ESTIMATION_TRIALS | goban

            Variable SCORE_ESTIMATION_TRIALSConst

            SCORE_ESTIMATION_TRIALS: 1000 = 1000
            \ No newline at end of file +SCORE_ESTIMATION_TRIALS | goban

            Variable SCORE_ESTIMATION_TRIALSConst

            SCORE_ESTIMATION_TRIALS: 1000 = 1000
            \ No newline at end of file diff --git a/docs/variables/THEMES.html b/docs/variables/THEMES.html index 491b1f99..29057028 100644 --- a/docs/variables/THEMES.html +++ b/docs/variables/THEMES.html @@ -1 +1 @@ -THEMES | goban

            Variable THEMESConst

            THEMES: ThemesInterface = ...
            \ No newline at end of file +THEMES | goban

            Variable THEMESConst

            THEMES: ThemesInterface = ...
            \ No newline at end of file diff --git a/docs/variables/THEMES_SORTED.html b/docs/variables/THEMES_SORTED.html index c0ccba33..b2c6082e 100644 --- a/docs/variables/THEMES_SORTED.html +++ b/docs/variables/THEMES_SORTED.html @@ -1 +1 @@ -THEMES_SORTED | goban

            Variable THEMES_SORTEDConst

            THEMES_SORTED: {
                black: GobanTheme[];
                board: GobanTheme[];
                white: GobanTheme[];
                [key: string]: GobanTheme[];
            } = ...

            Type declaration

            \ No newline at end of file +THEMES_SORTED | goban

            Variable THEMES_SORTEDConst

            THEMES_SORTED: {
                black: GobanTheme[];
                board: GobanTheme[];
                white: GobanTheme[];
                [key: string]: GobanTheme[];
            } = ...

            Type declaration

            \ No newline at end of file diff --git a/docs/variables/callbacks.html b/docs/variables/callbacks.html index eb3d6f43..b478fdd5 100644 --- a/docs/variables/callbacks.html +++ b/docs/variables/callbacks.html @@ -1 +1 @@ -callbacks | goban

            Variable callbacksConst

            callbacks: GobanCallbacks = ...
            \ No newline at end of file +callbacks | goban

            Variable callbacksConst

            callbacks: GobanCallbacks = ...
            \ No newline at end of file diff --git a/docs/variables/remote_estimate_ownership.html b/docs/variables/remote_estimate_ownership.html index 16625275..36c2b397 100644 --- a/docs/variables/remote_estimate_ownership.html +++ b/docs/variables/remote_estimate_ownership.html @@ -1 +1 @@ -remote_estimate_ownership | goban

            Variable remote_estimate_ownership

            remote_estimate_ownership: ((req) => Promise<ScoreEstimateResponse>) | undefined

            Type declaration

            \ No newline at end of file +remote_estimate_ownership | goban

            Variable remote_estimate_ownership

            remote_estimate_ownership: ((req) => Promise<ScoreEstimateResponse>) | undefined

            Type declaration

            \ No newline at end of file