From 28fe4b8c487dc63e671cc71bb1e5b981e148f670 Mon Sep 17 00:00:00 2001 From: Akita Noek Date: Thu, 8 Aug 2024 07:40:46 -0600 Subject: [PATCH] Update docs --- docs/classes/BoardState.html | 22 +-- docs/classes/ConditionalMoveTree.html | 4 +- docs/classes/Goban.html | 32 ++--- docs/classes/GobanBase.html | 22 +-- docs/classes/GobanCanvas.html | 32 ++--- docs/classes/GobanEngine.html | 48 +++---- docs/classes/GobanError.html | 4 +- docs/classes/GobanInteractive.html | 26 ++-- docs/classes/GobanMoveError.html | 4 +- docs/classes/GobanSocket.html | 4 +- docs/classes/GobanTheme.html | 6 +- docs/classes/MoveTree.html | 22 +-- docs/classes/SVGRenderer.html | 32 ++--- docs/classes/ScoreEstimator.html | 24 ++-- docs/classes/StoneString.html | 10 +- docs/classes/StoneStringBuilder.html | 4 +- docs/classes/TestGoban.html | 32 ++--- docs/classes/_internal_.OGSConnectivity.html | 28 ++-- docs/enums/JGOFNumericPlayerColor.html | 4 +- .../protocol.RemoteStorageReplication.html | 10 +- docs/functions/adjust_estimate.html | 2 +- docs/functions/allocateCanvasOrError.html | 2 +- docs/functions/autoscore.html | 2 +- docs/functions/char2num.html | 2 +- docs/functions/cloneMatrix.html | 2 +- docs/functions/closeErrorCodeToString.html | 2 +- docs/functions/color_blend.html | 2 +- docs/functions/computeAverageMoveTime.html | 2 +- docs/functions/createDeviceScaledCanvas.html | 2 +- docs/functions/createGoban.html | 2 +- docs/functions/decodeCoordinate.html | 2 +- docs/functions/decodeGTPCoordinates.html | 2 +- docs/functions/decodeMoves.html | 2 +- docs/functions/decodePrettyCoordinates.html | 2 +- docs/functions/decodePrettyXCoordinate.html | 2 +- docs/functions/deepClone.html | 2 +- docs/functions/deepEqual.html | 2 +- docs/functions/deviceCanvasScalingRatio.html | 2 +- docs/functions/elementOffset.html | 2 +- docs/functions/encodeCoordinate.html | 2 +- docs/functions/encodeMove.html | 2 +- docs/functions/encodeMoveToArray.html | 2 +- docs/functions/encodeMoves.html | 2 +- docs/functions/encodeMovesToArray.html | 2 +- docs/functions/encodePrettyXCoordinate.html | 2 +- docs/functions/escapeSGFText.html | 2 +- docs/functions/getRandomInt.html | 2 +- docs/functions/getRelativeEventPosition.html | 2 +- docs/functions/getWorstMoves.html | 2 +- .../init_remote_ownership_estimator.html | 2 +- .../init_wasm_ownership_estimator.html | 2 +- docs/functions/makeEmptyMatrix.html | 2 +- docs/functions/makeMatrix.html | 2 +- docs/functions/makeObjectMatrix.html | 2 +- docs/functions/matricesAreEqual.html | 2 +- docs/functions/newlines_to_spaces.html | 2 +- docs/functions/niceInterval.html | 2 +- docs/functions/num2char.html | 2 +- docs/functions/ojeSequenceToMoves.html | 2 +- docs/functions/placeRenderedImageStone.html | 2 +- docs/functions/positionId.html | 2 +- docs/functions/preRenderImageStone.html | 2 +- docs/functions/prettyCoordinates.html | 2 +- docs/functions/resizeDeviceScaledCanvas.html | 2 +- docs/functions/setGobanCallbacks.html | 2 +- docs/functions/setGobanRenderer.html | 2 +- .../set_local_ownership_estimator.html | 2 +- docs/functions/shortDurationString.html | 2 +- docs/functions/sortMoves.html | 2 +- docs/functions/translate._.html | 2 +- docs/functions/translate.interpolate.html | 2 +- .../translate.setGobanTranslations.html | 2 +- docs/functions/validateCanvas.html | 2 +- .../functions/voronoi_estimate_ownership.html | 2 +- docs/functions/wasm_estimate_ownership.html | 2 +- docs/interfaces/AIReviewWorstMoveEntry.html | 4 +- docs/interfaces/AdHocClock.html | 26 ++-- docs/interfaces/AdHocFormat.html | 4 +- docs/interfaces/AdHocPauseControl.html | 4 +- docs/interfaces/AdHocPlayer.html | 4 +- docs/interfaces/AdHocPlayerClock.html | 14 +- docs/interfaces/AudioClockEvent.html | 14 +- docs/interfaces/BoardConfig.html | 4 +- .../interfaces/CanvasRendererGobanConfig.html | 12 +- docs/interfaces/ColoredCircle.html | 4 +- .../ConditionalMoveResponseTree.html | 2 +- docs/interfaces/GobanBounds.html | 4 +- docs/interfaces/GobanCallbacks.html | 4 +- docs/interfaces/GobanCanvasInterface.html | 4 +- docs/interfaces/GobanConfig.html | 12 +- docs/interfaces/GobanEngineConfig.html | 12 +- docs/interfaces/GobanEngineInitialState.html | 4 +- docs/interfaces/GobanEnginePlayerEntry.html | 8 +- docs/interfaces/GobanEvents.html | 6 +- .../interfaces/GobanIOErrorMessageObject.html | 4 +- docs/interfaces/GobanMetrics.html | 4 +- .../GobanMoveErrorMessageObject.html | 4 +- docs/interfaces/GobanSelectedThemes.html | 4 +- docs/interfaces/GobanSocketEvents.html | 98 +++++++------- docs/interfaces/GobanThemeBackgroundCSS.html | 4 +- .../GobanThemeBackgroundReactStyles.html | 4 +- docs/interfaces/JGOF.html | 14 +- docs/interfaces/JGOFAIReview.html | 18 +-- docs/interfaces/JGOFAIReviewMove.html | 14 +- .../interfaces/JGOFAIReviewMoveVariation.html | 22 +-- docs/interfaces/JGOFAbsoluteTimeControl.html | 4 +- docs/interfaces/JGOFByoYomiTimeControl.html | 4 +- docs/interfaces/JGOFCanadianTimeControl.html | 4 +- docs/interfaces/JGOFClock.html | 22 +-- .../interfaces/JGOFClockWithTransmitting.html | 22 +-- docs/interfaces/JGOFFischerTimeControl.html | 4 +- docs/interfaces/JGOFIntersection.html | 6 +- docs/interfaces/JGOFMove.html | 10 +- docs/interfaces/JGOFNoneTimeControl.html | 4 +- docs/interfaces/JGOFPauseState.html | 14 +- docs/interfaces/JGOFPlayer.html | 6 +- docs/interfaces/JGOFPlayerClock.html | 12 +- docs/interfaces/JGOFPlayerSummary.html | 4 +- docs/interfaces/JGOFSealingIntersection.html | 8 +- docs/interfaces/JGOFSimpleTimeControl.html | 4 +- docs/interfaces/MarkInterface.html | 4 +- docs/interfaces/MoveCommand.html | 4 +- docs/interfaces/MoveTreeChatLine.html | 4 +- docs/interfaces/MoveTreeChatLineBody.html | 4 +- docs/interfaces/MoveTreeJson.html | 4 +- docs/interfaces/PlayerScore.html | 4 +- docs/interfaces/PuzzleConfig.html | 4 +- docs/interfaces/ReviewMessage.html | 40 +++--- docs/interfaces/SVGRendererGobanConfig.html | 12 +- docs/interfaces/SVGStoneParameters.html | 4 +- docs/interfaces/SVGStop.html | 4 +- docs/interfaces/Score.html | 4 +- docs/interfaces/ScoreEstimateRequest.html | 4 +- docs/interfaces/ScoreEstimateResponse.html | 14 +- docs/interfaces/ScoringLocations.html | 4 +- docs/interfaces/StateUpdateEvents.html | 4 +- docs/interfaces/ThemesInterface.html | 4 +- docs/interfaces/_internal_.AbsoluteClock.html | 4 +- .../_internal_.AnalysisComment.html | 4 +- .../_internal_.AutoscoreResults.html | 4 +- ...internal_.BoardStateWithIsobranchHash.html | 24 ++-- docs/interfaces/_internal_.ByoYomiClock.html | 4 +- docs/interfaces/_internal_.CanadianClock.html | 4 +- docs/interfaces/_internal_.ErrorResponse.html | 4 +- docs/interfaces/_internal_.FischerClock.html | 4 +- .../interfaces/_internal_.GameListPlayer.html | 4 +- .../_internal_.GobanSVGInterface.html | 4 +- .../_internal_.GobanSocketOptions.html | 6 +- ...internal_.JGOFPlayerClockWithTimedOut.html | 12 +- .../_internal_.MoveTreeViewPortInterface.html | 4 +- docs/interfaces/_internal_.ReviewComment.html | 4 +- .../_internal_.ViewPortInterface.html | 4 +- .../interfaces/protocol.AIServerToClient.html | 4 +- .../protocol.AutomatchPreferences.html | 4 +- .../interfaces/protocol.ClientToAIServer.html | 20 +-- docs/interfaces/protocol.ClientToServer.html | 126 +++++++++--------- .../protocol.ClientToServerBase.html | 6 +- .../protocol.GameChatAnalysisMessage.html | 4 +- docs/interfaces/protocol.GameChatLine.html | 4 +- docs/interfaces/protocol.GameChatMessage.html | 4 +- .../protocol.GameChatReviewMessage.html | 4 +- .../protocol.GameChatTranslatedMessage.html | 4 +- docs/interfaces/protocol.GameClock.html | 4 +- docs/interfaces/protocol.GameListEntry.html | 4 +- docs/interfaces/protocol.GameListWhere.html | 4 +- docs/interfaces/protocol.Glicko2.html | 4 +- .../protocol.SeekgraphChallengeMessage.html | 60 ++++----- .../protocol.SeekgraphDeleteMessage.html | 6 +- .../protocol.SeekgraphStartedMessage.html | 28 ++-- docs/interfaces/protocol.ServerToClient.html | 98 +++++++------- .../protocol.StallingScoreEstimate.html | 4 +- docs/interfaces/protocol.User.html | 4 +- docs/interfaces/translate.GobanStrings.html | 4 +- docs/modules/protocol.html | 2 +- docs/modules/translate.html | 2 +- docs/types/AdHocPackedMove.html | 2 +- docs/types/AnalysisSubTool.html | 2 +- docs/types/AnalysisTool.html | 2 +- docs/types/BoardTransform.html | 2 +- docs/types/ConditionalMoveResponse.html | 2 +- docs/types/DataArgument.html | 2 +- docs/types/GobanChatLog.html | 2 +- docs/types/GobanEnginePhase.html | 2 +- docs/types/GobanEngineRules.html | 2 +- docs/types/GobanEngineSuperKoAlgorithm.html | 2 +- docs/types/GobanErrorMessageId.html | 2 +- docs/types/GobanErrorMessageObject.html | 2 +- docs/types/GobanIOErrorMessageId.html | 2 +- docs/types/GobanModes.html | 2 +- docs/types/GobanMoveErrorMessageId.html | 2 +- docs/types/GobanMovesArray.html | 2 +- docs/types/GobanRenderer.html | 2 +- docs/types/GobanRendererConfig.html | 2 +- docs/types/JGOFTimeControl.html | 2 +- docs/types/JGOFTimeControlSpeed.html | 2 +- docs/types/JGOFTimeControlSystem.html | 2 +- docs/types/LabelPosition.html | 2 +- docs/types/Matrix.html | 2 +- docs/types/MoveTreePenMarks.html | 2 +- docs/types/NumberMatrix.html | 2 +- docs/types/PlayerColor.html | 2 +- docs/types/ProtocolResponseType.html | 2 +- docs/types/PuzzleOpponentMoveMode.html | 2 +- docs/types/PuzzlePlacementSetting.html | 2 +- docs/types/PuzzlePlayerMoveMode.html | 2 +- docs/types/RawStoneString.html | 2 +- docs/types/StringMatrix.html | 2 +- docs/types/_internal_.ClockTime.html | 2 +- docs/types/_internal_.DebugOutput.html | 2 +- docs/types/_internal_.LocalEstimator.html | 2 +- docs/types/_internal_.MessageID.html | 2 +- docs/types/_internal_.NoneClock.html | 2 +- docs/types/_internal_.SimpleClock.html | 2 +- docs/types/_internal_.StoneType.html | 2 +- docs/types/_internal_.StoneTypeArray.html | 2 +- docs/types/protocol.AutomatchCondition.html | 2 +- docs/types/protocol.RuleSet.html | 2 +- docs/types/protocol.Size.html | 2 +- docs/types/protocol.Speed.html | 2 +- docs/variables/AUTOSCORE_TOLERANCE.html | 2 +- docs/variables/AUTOSCORE_TRIALS.html | 2 +- docs/variables/GOBAN_FONT.html | 2 +- docs/variables/MARK_TYPES.html | 2 +- .../variables/SCORE_ESTIMATION_TOLERANCE.html | 2 +- docs/variables/SCORE_ESTIMATION_TRIALS.html | 2 +- docs/variables/THEMES.html | 2 +- docs/variables/THEMES_SORTED.html | 2 +- docs/variables/callbacks.html | 2 +- docs/variables/remote_estimate_ownership.html | 2 +- 229 files changed, 834 insertions(+), 834 deletions(-) diff --git a/docs/classes/BoardState.html b/docs/classes/BoardState.html index 8938f8d2..4820d7e3 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

constructor

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

black_prisoners: number

board

board: JGOFNumericPlayerColor[][]

board_is_repeating

board_is_repeating: boolean

Protected Optional goban_callback

goban_callback?: GobanBase

Readonly height

height: number = 19

player

player: JGOFNumericPlayerColor

removal

removal: boolean[][]

white_prisoners

white_prisoners: number

Readonly width

width: number = 19

Methods

Private _floodFillMarkFilled

boardEquals

  • boardEquals(other): boolean

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

    -

    Parameters

    Returns boolean

clearRemoved

cloneBoard

cloneBoardState

computeScoringLocations

Properties

black_prisoners

black_prisoners: number

board

board: JGOFNumericPlayerColor[][]

board_is_repeating

board_is_repeating: boolean

Protected Optional goban_callback

goban_callback?: GobanBase

Readonly height

height: number = 19

player

player: JGOFNumericPlayerColor

removal

removal: boolean[][]

white_prisoners

white_prisoners: number

Readonly width

width: number = 19

Methods

Private _floodFillMarkFilled

boardEquals

  • boardEquals(other): boolean

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

    +

    Parameters

    Returns boolean

clearRemoved

cloneBoard

cloneBoardState

computeScoringLocations

  • computeScoringLocations(area_scoring): ScoringLocations

  • Computes scoring locations for the board. If area_scoring is true, we will use area scoring rules, otherwise we will use territory scoring rules (which implies omitting territory in seki).

    -

    Parameters

    • area_scoring: boolean

    Returns ScoringLocations

countLiberties

foreachNeighbor

getNeighboringRawStoneStrings

countLiberties

foreachNeighbor

getNeighboringRawStoneStrings

getRawStoneString

setRemoved

getRawStoneString

setRemoved

  • setRemoved(x, y, removed, emit_stone_removal_updated?): void

  • Sets a position as being removed or not removed. If emit_stone_removal_updated is set to false, the "stone-removal.updated" event will not be emitted, and it is up to the caller to emit this event appropriately.

    -

    Parameters

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

    Returns void

toggleSingleGroupRemoval

  • toggleSingleGroupRemoval(x, y, force_removal?): {
        group: RawStoneString;
        removed: boolean;
    }

  • Toggles a group of stones for removal or restoration.

    +

    Parameters

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

    Returns void

toggleSingleGroupRemoval

  • toggleSingleGroupRemoval(x, y, force_removal?): {
        group: RawStoneString;
        removed: boolean;
    }

  • Toggles a group of stones for removal or restoration.

    By default, if we are marking a group for removal but the group is almost certainly alive (two eyes, etc), this will result in a no-op, unless force_removal is set to true.

    -

    Parameters

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

    Returns {
        group: RawStoneString;
        removed: boolean;
    }

Settings

Member Visibility

Theme

On This Page

constructorblack_prisonersboardboard_is_repeatinggoban_callbackheightplayerremovalwhite_prisonerswidth_floodFillMarkFilledboardEqualsclearRemovedcloneBoardcloneBoardStatecomputeScoringLocationscountLibertiesforeachNeighborgetNeighboringRawStoneStringsgetRawStoneStringsetRemovedtoggleSingleGroupRemoval
\ No newline at end of file +

Parameters

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

Returns {
    group: RawStoneString;
    removed: boolean;
}

Settings

Member Visibility

Theme

On This Page

constructorblack_prisonersboardboard_is_repeatinggoban_callbackheightplayerremovalwhite_prisonerswidth_floodFillMarkFilledboardEqualsclearRemovedcloneBoardcloneBoardStatecomputeScoringLocationscountLibertiesforeachNeighborgetNeighboringRawStoneStringsgetRawStoneStringsetRemovedtoggleSingleGroupRemoval
\ No newline at end of file diff --git a/docs/classes/ConditionalMoveTree.html b/docs/classes/ConditionalMoveTree.html index 5164938d..babe9b84 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

constructor

Properties

children move parent? @@ -6,4 +6,4 @@ encode getChild decode -

Constructors

constructor

Properties

children

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

Type declaration

move

move: null | string

Optional parent

parent?: ConditionalMoveTree

Methods

duplicate

encode

getChild

Static decode

Settings

Member Visibility

Theme

On This Page

constructorchildrenmoveparentduplicateencodegetChilddecode
\ No newline at end of file +

Constructors

constructor

Properties

children

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

Type declaration

move

move: null | string

Optional parent

parent?: ConditionalMoveTree

Methods

duplicate

encode

getChild

Static decode

Settings

Member Visibility

Theme

On This Page

constructorchildrenmoveparentduplicateencodegetChilddecode
\ No newline at end of file diff --git a/docs/classes/Goban.html b/docs/classes/Goban.html index ffa36637..e06e30ea 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

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

__board_redraw_pen_layer_timer __clock_timer? __draw_state @@ -255,31 +255,31 @@ getMoveTreeNumbering getSoundEnabled getSoundVolume -

Constructors

constructor

Properties

Protected __board_redraw_pen_layer_timer

__board_redraw_pen_layer_timer: any = null

Protected Optional __clock_timer

__clock_timer?: Timeout

Protected __draw_state

__draw_state: string[][]

Protected __last_pt

__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean

Protected __update_move_tree

__update_move_tree: any = null

Protected analysis_move_counter

analysis_move_counter: number

Protected analysis_removal_last_position

analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected Optional analysis_removal_state

analysis_removal_state?: boolean

Private Optional analysis_scoring_color

analysis_scoring_color?: string

Private analysis_scoring_last_position

analysis_scoring_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected bounded_height

bounded_height: number

Protected bounded_width

bounded_width: number

Protected bounds

bounds: GobanBounds

chat_log

chat_log: GobanChatLog = []

Protected circle_radius

circle_radius: number

clock_should_be_paused_for_move_submission

clock_should_be_paused_for_move_submission: boolean = false

Protected Optional colored_circles

colored_circles?: (undefined | ColoredCircle)[][]

Protected conditional_path

conditional_path: string = ""

conditional_starting_color

conditional_starting_color: "black" | "white" | "invalid" = "invalid"

conditional_tree

conditional_tree: ConditionalMoveTree = ...

config

config: GobanConfig

Protected Optional connectToReviewSent

connectToReviewSent?: boolean

Protected Optional current_cmove

current_cmove?: ConditionalMoveTree

Protected currently_my_cmove

currently_my_cmove: boolean = false

Protected dirty_redraw

dirty_redraw: any = null

Protected disconnectedFromGame

disconnectedFromGame: boolean = true

Protected Optional display_width

display_width?: number

Protected done_loading_review

done_loading_review: boolean = false

Protected dont_draw_last_move

dont_draw_last_move: boolean

double_click_submit

double_click_submit: boolean

draw_bottom_labels

draw_bottom_labels: boolean

draw_left_labels

draw_left_labels: boolean

draw_right_labels

draw_right_labels: boolean

draw_top_labels

draw_top_labels: boolean

Protected Optional edit_color

edit_color?: "black" | "white"

Abstract engine

engine: GobanEngine

Protected errorHandler

errorHandler: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: Error

      Returns void

Readonly game_id

game_id: number

Protected game_type

game_type: string

Protected Optional getPuzzlePlacementSetting

getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

Type declaration

Readonly goban_id

goban_id: number = ++last_goban_id

Base fields *

-

Protected Optional heatmap

heatmap?: NumberMatrix

height

height: number

Protected highlight_movetree_moves

highlight_movetree_moves: boolean

Protected interactive

interactive: boolean

Protected isInPushedAnalysis

isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerController

isPlayerController: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerOwner

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected label_character

label_character: string

Protected label_mark

label_mark: string = "[UNSET]"

Optional last_clock

last_clock?: AdHocClock

Optional last_emitted_clock

last_emitted_clock?: JGOFClockWithTransmitting

Protected Optional last_hover_square

last_hover_square?: JGOFIntersection

Protected Optional last_move

last_move?: MoveTree

Protected last_move_radius

last_move_radius: number

Protected last_paused_by_player_state

last_paused_by_player_state: null | boolean = null

Protected last_paused_state

last_paused_state: null | boolean = null

Protected Optional last_phase

last_phase?: GobanEnginePhase

Protected last_review_message

last_review_message: ReviewMessage

Protected Optional last_sound_played_for_a_stone_placement

last_sound_played_for_a_stone_placement?: string

Protected last_stone_sound

last_stone_sound: number

Protected leavePushedAnalysis

leavePushedAnalysis: (() => void)

Type declaration

    • (): void

    • Returns void

Protected Optional marked_analysis_score

marked_analysis_score?: boolean[][]

Protected Optional move_selected

move_selected?: JGOFIntersection

Protected no_display

no_display: boolean

Protected Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Protected on_game_screen

on_game_screen: boolean

one_click_submit

one_click_submit: boolean

Protected original_square_size

original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number

    • Parameters

      Returns number

Protected parent

parent: HTMLElement

Optional pause_control

pause_control?: AdHocPauseControl

Optional paused_since

paused_since?: number

pen_marks

pen_marks: any[]

Protected player_id

player_id: number

Protected Optional preloaded_data

preloaded_data?: GobanConfig

previous_mode

previous_mode: string

Protected puzzle_autoplace_delay

puzzle_autoplace_delay: number

Protected restrict_moves_to_movetree

restrict_moves_to_movetree: boolean

Protected review_had_gamedata

review_had_gamedata: boolean

Readonly review_id

review_id: number

Protected scoring_mode

scoring_mode: boolean | "stalling-scoring-mode"

Protected Optional sendLatencyTimer

sendLatencyTimer?: Timeout

sent_timed_out_message

sent_timed_out_message: boolean = false

Protected shift_key_is_down

shift_key_is_down: boolean

Protected show_move_numbers

show_move_numbers: boolean

Protected show_variation_move_numbers

show_variation_move_numbers: boolean

showing_scores

showing_scores: boolean = false

Protected socket

socket: GobanSocket<ClientToServer, ServerToClient>

Protected socket_event_bindings

socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

Protected square_size

square_size: number = 10

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Protected stone_placement_enabled

stone_placement_enabled: boolean

Protected Optional stone_removal_auto_scoring_done

stone_removal_auto_scoring_done?: boolean = false

variation_stone_opacity

variation_stone_opacity: number

visual_undo_request_indicator

visual_undo_request_indicator: boolean

width

width: number

Static THEMES

THEMES: ThemesInterface = THEMES

Static THEMES_SORTED

THEMES_SORTED: {
    black: GobanTheme[];
    board: GobanTheme[];
    white: GobanTheme[];
    [key: string]: GobanTheme[];
} = THEMES_SORTED

Type declaration

Static setCallbacks

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

Type declaration

    • (newCallbacks): void

    • Set's callback functions to be called in various situations. You can set any +

Constructors

constructor

Properties

Protected __board_redraw_pen_layer_timer

__board_redraw_pen_layer_timer: any = null

Protected Optional __clock_timer

__clock_timer?: Timeout

Protected __draw_state

__draw_state: string[][]

Protected __last_pt

__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean

Protected __update_move_tree

__update_move_tree: any = null

Protected analysis_move_counter

analysis_move_counter: number

Protected analysis_removal_last_position

analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected Optional analysis_removal_state

analysis_removal_state?: boolean

Private Optional analysis_scoring_color

analysis_scoring_color?: string

Private analysis_scoring_last_position

analysis_scoring_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected bounded_height

bounded_height: number

Protected bounded_width

bounded_width: number

Protected bounds

bounds: GobanBounds

chat_log

chat_log: GobanChatLog = []

Protected circle_radius

circle_radius: number

clock_should_be_paused_for_move_submission

clock_should_be_paused_for_move_submission: boolean = false

Protected Optional colored_circles

colored_circles?: (undefined | ColoredCircle)[][]

Protected conditional_path

conditional_path: string = ""

conditional_starting_color

conditional_starting_color: "black" | "white" | "invalid" = "invalid"

conditional_tree

conditional_tree: ConditionalMoveTree = ...

config

config: GobanConfig

Protected Optional connectToReviewSent

connectToReviewSent?: boolean

Protected Optional current_cmove

current_cmove?: ConditionalMoveTree

Protected currently_my_cmove

currently_my_cmove: boolean = false

Protected dirty_redraw

dirty_redraw: any = null

Protected disconnectedFromGame

disconnectedFromGame: boolean = true

Protected Optional display_width

display_width?: number

Protected done_loading_review

done_loading_review: boolean = false

Protected dont_draw_last_move

dont_draw_last_move: boolean

double_click_submit

double_click_submit: boolean

draw_bottom_labels

draw_bottom_labels: boolean

draw_left_labels

draw_left_labels: boolean

draw_right_labels

draw_right_labels: boolean

draw_top_labels

draw_top_labels: boolean

Protected Optional edit_color

edit_color?: "black" | "white"

Abstract engine

engine: GobanEngine

Protected errorHandler

errorHandler: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: Error

      Returns void

Readonly game_id

game_id: number

Protected game_type

game_type: string

Protected Optional getPuzzlePlacementSetting

getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

Type declaration

Readonly goban_id

goban_id: number = ++last_goban_id

Base fields *

+

Protected Optional heatmap

heatmap?: NumberMatrix

height

height: number

Protected highlight_movetree_moves

highlight_movetree_moves: boolean

Protected interactive

interactive: boolean

Protected isInPushedAnalysis

isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerController

isPlayerController: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerOwner

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected label_character

label_character: string

Protected label_mark

label_mark: string = "[UNSET]"

Optional last_clock

last_clock?: AdHocClock

Optional last_emitted_clock

last_emitted_clock?: JGOFClockWithTransmitting

Protected Optional last_hover_square

last_hover_square?: JGOFIntersection

Protected Optional last_move

last_move?: MoveTree

Protected last_move_radius

last_move_radius: number

Protected last_paused_by_player_state

last_paused_by_player_state: null | boolean = null

Protected last_paused_state

last_paused_state: null | boolean = null

Protected Optional last_phase

last_phase?: GobanEnginePhase

Protected last_review_message

last_review_message: ReviewMessage

Protected Optional last_sound_played_for_a_stone_placement

last_sound_played_for_a_stone_placement?: string

Protected last_stone_sound

last_stone_sound: number

Protected leavePushedAnalysis

leavePushedAnalysis: (() => void)

Type declaration

    • (): void

    • Returns void

Protected Optional marked_analysis_score

marked_analysis_score?: boolean[][]

Protected Optional move_selected

move_selected?: JGOFIntersection

Protected no_display

no_display: boolean

Protected Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Protected on_game_screen

on_game_screen: boolean

one_click_submit

one_click_submit: boolean

Protected original_square_size

original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number

    • Parameters

      Returns number

Protected parent

parent: HTMLElement

Optional pause_control

pause_control?: AdHocPauseControl

Optional paused_since

paused_since?: number

pen_marks

pen_marks: any[]

Protected player_id

player_id: number

Protected Optional preloaded_data

preloaded_data?: GobanConfig

previous_mode

previous_mode: string

Protected puzzle_autoplace_delay

puzzle_autoplace_delay: number

Protected restrict_moves_to_movetree

restrict_moves_to_movetree: boolean

Protected review_had_gamedata

review_had_gamedata: boolean

Readonly review_id

review_id: number

Protected scoring_mode

scoring_mode: boolean | "stalling-scoring-mode"

Protected Optional sendLatencyTimer

sendLatencyTimer?: Timeout

sent_timed_out_message

sent_timed_out_message: boolean = false

Protected shift_key_is_down

shift_key_is_down: boolean

Protected show_move_numbers

show_move_numbers: boolean

Protected show_variation_move_numbers

show_variation_move_numbers: boolean

showing_scores

showing_scores: boolean = false

Protected socket

socket: GobanSocket<ClientToServer, ServerToClient>

Protected socket_event_bindings

socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

Protected square_size

square_size: number = 10

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Protected stone_placement_enabled

stone_placement_enabled: boolean

Protected Optional stone_removal_auto_scoring_done

stone_removal_auto_scoring_done?: boolean = false

variation_stone_opacity

variation_stone_opacity: number

visual_undo_request_indicator

visual_undo_request_indicator: boolean

width

width: number

Static THEMES

THEMES: ThemesInterface = THEMES

Static THEMES_SORTED

THEMES_SORTED: {
    black: GobanTheme[];
    board: GobanTheme[];
    white: GobanTheme[];
    [key: string]: GobanTheme[];
} = THEMES_SORTED

Type declaration

Static setCallbacks

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

Static setTranslations

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

Type declaration

    • (_catalog, _debug_mode?): void

    • Parameters

      Returns void

Accessors

analyze_subtool

  • get analyze_subtool(): string

  • Returns string

  • set analyze_subtool(analyze_subtool): void

  • Parameters

    • analyze_subtool: string

    Returns void

analyze_tool

destroyed

  • get destroyed(): boolean

  • Returns boolean

is_game_record

  • get is_game_record(): boolean

  • True if the game is a game record of a real life game

    -

    Returns boolean

mode

review_controller_id

  • 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

review_owner_id

  • 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

score_estimator

submit_move

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

  • Returns undefined | (() => void)

  • set submit_move(submit_move): void

  • Parameters

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

    Returns void

title

Methods

Protected _socket_on

acceptRemovedStones

acceptUndo

Protected annul

cancelGame

cancelUndo

Abstract clearAnalysisDrawing

clearAnalysisScores

  • clearAnalysisScores(): void

  • Clears any analysis scores on the board

    -

    Returns void

clearMark

Abstract clearMessage

Protected clearPendingResignation

Protected clearTransientMark

computeMetrics

Protected computeNewPlayerClock

Protected connect

debouncedEmitCapturedStones

decodeMoves

  • decodeMoves(move_obj): JGOFMove[]

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

    Parameters

    Returns void

Static setTranslations

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

Type declaration

    • (_catalog, _debug_mode?): void

    • Parameters

      Returns void

Accessors

analyze_subtool

  • get analyze_subtool(): string

  • Returns string

  • set analyze_subtool(analyze_subtool): void

  • Parameters

    • analyze_subtool: string

    Returns void

analyze_tool

destroyed

  • get destroyed(): boolean

  • Returns boolean

is_game_record

  • get is_game_record(): boolean

  • True if the game is a game record of a real life game

    +

    Returns boolean

mode

review_controller_id

  • 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

review_owner_id

  • 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

score_estimator

submit_move

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

  • Returns undefined | (() => void)

  • set submit_move(submit_move): void

  • Parameters

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

    Returns void

title

Methods

Protected _socket_on

acceptRemovedStones

acceptUndo

Protected annul

cancelGame

cancelUndo

Abstract clearAnalysisDrawing

clearAnalysisScores

  • clearAnalysisScores(): void

  • Clears any analysis scores on the board

    +

    Returns void

clearMark

Abstract clearMessage

Protected clearPendingResignation

Protected clearTransientMark

computeMetrics

Protected computeNewPlayerClock

Protected connect

debouncedEmitCapturedStones

decodeMoves

decodePrettyCoordinates

decodePrettyCoordinates

Protected defaultConfig

deleteBranch

deleteConditionalPath

deleteCustomMark

destroy

Protected Abstract disableDrawing

Abstract disablePen

disableStonePlacement

Protected disconnect

Abstract drawPenMarks

Abstract drawSquare

editPlaceByPrettyCoordinates

Protected Abstract enableDrawing

Abstract enablePen

enableStonePlacement

encodeMove

encodeMoves

followConditionalPath

Protected followConditionalSegment

Protected getAnalysisScoreColorAtLocation

  • getAnalysisScoreColorAtLocation(x, y): undefined | string

  • Parameters

    • x: number
    • y: number

    Returns undefined | string

Protected getClockDrift

Protected getCoordinateDisplaySystem

getCurrentConditionalPath

getLastReviewMessage

Protected getLocation

getMarks

Protected getNetworkLatency

getPlayerRelativeLatency

Protected getSelectedThemes

Protected getShowMoveNumbers

Protected getShowVariationMoveNumbers

Protected getWidthForSquareSize

giveReviewControl

hideScores

Protected incrementLabelCharacter

isAnalysisDisabled

isCurrentUserAPlayer

Protected isLastOfficialMove

jumpToLastOfficialMove

load

markAnalysisScores

Protected defaultConfig

deleteBranch

deleteConditionalPath

deleteCustomMark

destroy

Protected Abstract disableDrawing

Abstract disablePen

disableStonePlacement

Protected disconnect

Abstract drawPenMarks

Abstract drawSquare

editPlaceByPrettyCoordinates

Protected Abstract enableDrawing

Abstract enablePen

enableStonePlacement

encodeMove

encodeMoves

followConditionalPath

Protected followConditionalSegment

Protected getAnalysisScoreColorAtLocation

  • getAnalysisScoreColorAtLocation(x, y): undefined | string

  • Parameters

    • x: number
    • y: number

    Returns undefined | string

Protected getClockDrift

Protected getCoordinateDisplaySystem

getCurrentConditionalPath

getLastReviewMessage

Protected getLocation

getMarks

Protected getNetworkLatency

getPlayerRelativeLatency

Protected getSelectedThemes

Protected getShowMoveNumbers

Protected getShowVariationMoveNumbers

Protected getWidthForSquareSize

giveReviewControl

hideScores

Protected incrementLabelCharacter

isAnalysisDisabled

isCurrentUserAPlayer

Protected isLastOfficialMove

jumpToLastOfficialMove

load

markAnalysisScores

  • markAnalysisScores(): void

  • 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

markDirty

Abstract move_tree_redraw

nextSibling

Protected onAnalysisScoringMove

  • onAnalysisScoringMove(ev): void

  • Parameters

    • ev: TouchEvent | MouseEvent

    Returns void

Protected onAnalysisScoringStart

  • onAnalysisScoringStart(ev): void

  • Parameters

    • ev: TouchEvent | MouseEvent

    Returns void

Protected onAnalysisToggleStoneRemoval

  • onAnalysisToggleStoneRemoval(ev): void

  • Parameters

    • ev: TouchEvent | MouseEvent

    Returns void

pass

pauseGame

performStoneRemovalAutoScoring

placeByPrettyCoordinates

Protected playMovementSound

Protected post_config_constructor

markDirty

Abstract move_tree_redraw

nextSibling

Protected onAnalysisScoringMove

  • onAnalysisScoringMove(ev): void

  • Parameters

    • ev: TouchEvent | MouseEvent

    Returns void

Protected onAnalysisScoringStart

  • onAnalysisScoringStart(ev): void

  • Parameters

    • ev: TouchEvent | MouseEvent

    Returns void

Protected onAnalysisToggleStoneRemoval

  • onAnalysisToggleStoneRemoval(ev): void

  • Parameters

    • ev: TouchEvent | MouseEvent

    Returns void

pass

pauseGame

performStoneRemovalAutoScoring

placeByPrettyCoordinates

Protected playMovementSound

Protected post_config_constructor

prettyCoordinates

prevSibling

Protected putAnalysisRemovalAtLocation

  • putAnalysisRemovalAtLocation(x, y, removal?): void

  • Parameters

    • x: number
    • y: number
    • Optional removal: boolean

    Returns void

Protected putAnalysisScoreColorAtLocation

  • putAnalysisScoreColorAtLocation(x, y, color?, sync_review_move?): void

  • Parameters

    • x: number
    • y: number
    • Optional color: string
    • sync_review_move: boolean = true

    Returns void

Protected putOrClearLabel

  • putOrClearLabel(x, y, mode?): boolean

  • Parameters

    • x: number
    • y: number
    • Optional mode: "put" | "clear"

    Returns boolean

Abstract redraw

rejectRemovedStones

requestUndo

resign

resumeGame

saveConditionalMoves

Protected scheduleRedrawPenLayer

sendChat

Protected sendMove

Protected sendPendingResignation

sendPreventEscaping

sendPreventStalling

sendTimedOut

prettyCoordinates

prevSibling

Protected putAnalysisRemovalAtLocation

  • putAnalysisRemovalAtLocation(x, y, removal?): void

  • Parameters

    • x: number
    • y: number
    • Optional removal: boolean

    Returns void

Protected putAnalysisScoreColorAtLocation

  • putAnalysisScoreColorAtLocation(x, y, color?, sync_review_move?): void

  • Parameters

    • x: number
    • y: number
    • Optional color: string
    • sync_review_move: boolean = true

    Returns void

Protected putOrClearLabel

  • putOrClearLabel(x, y, mode?): boolean

  • Parameters

    • x: number
    • y: number
    • Optional mode: "put" | "clear"

    Returns boolean

Abstract redraw

rejectRemovedStones

requestUndo

resign

resumeGame

saveConditionalMoves

Protected scheduleRedrawPenLayer

sendChat

Protected sendMove

Protected sendPendingResignation

sendPreventEscaping

sendPreventStalling

sendTimedOut

  • sendTimedOut(): void

  • 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

set

setAnalyzeTool

setBounds

setColoredCircles

setColoredMarks

  • setColoredMarks(colored_marks): void

  • Parameters

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

    Returns void

setConditionalTree

setCustomMark

setEditColor

setForRemoval

  • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

setGameClock

setHeatmap

setLabelCharacter

Protected setLabelCharacterFromMarks

setLabelPosition

Protected setLastOfficialMove

setLastReviewMessage

Protected setLetterMark

setMark

setMarkByPrettyCoordinates

Protected setMarkColor

setMarks

set

setAnalyzeTool

setBounds

setColoredCircles

setColoredMarks

  • setColoredMarks(colored_marks): void

  • Parameters

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

    Returns void

setConditionalTree

setCustomMark

setEditColor

setForRemoval

  • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

setGameClock

setHeatmap

setLabelCharacter

Protected setLabelCharacterFromMarks

setLabelPosition

Protected setLastOfficialMove

setLastReviewMessage

Protected setLetterMark

setMark

setMarkByPrettyCoordinates

Protected setMarkColor

setMarks

  • setMarks(marks, dont_draw?): 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

setMode

setModeDeferred

Abstract setMoveTreeContainer

setScoringMode

setSquareSize

  • setSquareSize(new_ss, suppress_redraw?): void

  • Parameters

    • new_ss: number
    • suppress_redraw: boolean = false

    Returns void

setSquareSizeBasedOnDisplayWidth

  • setSquareSizeBasedOnDisplayWidth(display_width, suppress_redraw?): void

  • Parameters

    • display_width: number
    • suppress_redraw: boolean = false

    Returns void

setState

  • setState(): 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

setMode

setModeDeferred

Abstract setMoveTreeContainer

setScoringMode

setSquareSize

  • setSquareSize(new_ss, suppress_redraw?): void

  • Parameters

    • new_ss: number
    • suppress_redraw: boolean = false

    Returns void

setSquareSizeBasedOnDisplayWidth

  • setSquareSizeBasedOnDisplayWidth(display_width, suppress_redraw?): void

  • Parameters

    • display_width: number
    • suppress_redraw: boolean = false

    Returns void

setState

setStrictSekiMode

Protected setSubmit

setSubscriptMark

Protected Abstract setTheme

Protected Abstract setTitle

setToPreviousMode

Protected setTransientMark

showFirst

Abstract showMessage

showNext

showPrevious

showScores

showStallingScoreEstimate

syncReviewMove

Protected toggleMark

Protected updateMoveTree

Protected updateOrRedrawMoveTree

updatePlayerToMoveTitle

updateScoreEstimation

updateTitleAndStonePlacement

Protected xy2ij

  • xy2ij(x, y, anti_slip?): {
        i: number;
        j: number;
        valid: boolean;
    }

  • Parameters

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

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

    • i: number
    • j: number
    • valid: boolean

Static getCDNReleaseBase

Static getMoveTreeNumbering

Static getSoundEnabled

Static getSoundVolume

Settings

Member Visibility

Theme

On This Page

constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_stateanalysis_scoring_coloranalysis_scoring_last_positionbounded_heightbounded_widthboundschat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentcurrent_cmovecurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsedit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklast_clocklast_emitted_clocklast_hover_squarelast_movelast_move_radiuslast_paused_by_player_statelast_paused_statelast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremove_selectedno_displayonErroron_game_screenone_click_submitoriginal_square_sizeparentpause_controlpaused_sincepen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donevariation_stone_opacityvisual_undo_request_indicatorwidthTHEMESTHEMES_SORTEDsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle_socket_onacceptRemovedStonesacceptUndoannulcancelGamecancelUndoclearAnalysisDrawingclearAnalysisScoresclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeMetricscomputeNewPlayerClockconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydisableDrawingdisablePendisableStonePlacementdisconnectdrawPenMarksdrawSquareeditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetAnalysisScoreColorAtLocationgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkAnalysisScoresmarkDirtymove_tree_redrawnextSiblingonAnalysisScoringMoveonAnalysisScoringStartonAnalysisToggleStoneRemovalpasspauseGameperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingputAnalysisRemovalAtLocationputAnalysisScoreColorAtLocationputOrClearLabelredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLabelPositionsetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetScoringModesetSquareSizesetSquareSizeBasedOnDisplayWidthsetStatesetStrictSekiModesetSubmitsetSubscriptMarksetThemesetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementxy2ijgetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
\ No newline at end of file +

Returns void

setStrictSekiMode

Protected setSubmit

setSubscriptMark

Protected Abstract setTheme

Protected Abstract setTitle

setToPreviousMode

Protected setTransientMark

showFirst

Abstract showMessage

showNext

showPrevious

showScores

showStallingScoreEstimate

syncReviewMove

Protected toggleMark

Protected updateMoveTree

Protected updateOrRedrawMoveTree

updatePlayerToMoveTitle

updateScoreEstimation

updateTitleAndStonePlacement

Protected xy2ij

Static getCDNReleaseBase

Static getMoveTreeNumbering

Static getSoundEnabled

Static getSoundVolume

Settings

Member Visibility

Theme

On This Page

constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_stateanalysis_scoring_coloranalysis_scoring_last_positionbounded_heightbounded_widthboundschat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentcurrent_cmovecurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsedit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklast_clocklast_emitted_clocklast_hover_squarelast_movelast_move_radiuslast_paused_by_player_statelast_paused_statelast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremove_selectedno_displayonErroron_game_screenone_click_submitoriginal_square_sizeparentpause_controlpaused_sincepen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donevariation_stone_opacityvisual_undo_request_indicatorwidthTHEMESTHEMES_SORTEDsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle_socket_onacceptRemovedStonesacceptUndoannulcancelGamecancelUndoclearAnalysisDrawingclearAnalysisScoresclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeMetricscomputeNewPlayerClockconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydisableDrawingdisablePendisableStonePlacementdisconnectdrawPenMarksdrawSquareeditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetAnalysisScoreColorAtLocationgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkAnalysisScoresmarkDirtymove_tree_redrawnextSiblingonAnalysisScoringMoveonAnalysisScoringStartonAnalysisToggleStoneRemovalpasspauseGameperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingputAnalysisRemovalAtLocationputAnalysisScoreColorAtLocationputOrClearLabelredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLabelPositionsetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetScoringModesetSquareSizesetSquareSizeBasedOnDisplayWidthsetStatesetStrictSekiModesetSubmitsetSubscriptMarksetThemesetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementxy2ijgetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
\ No newline at end of file diff --git a/docs/classes/GobanBase.html b/docs/classes/GobanBase.html index 67fad06b..577c5994 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

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

_destroyed engine goban_id @@ -30,16 +30,16 @@ setState showMessage updateScoreEstimation -

Constructors

constructor

Properties

Private _destroyed

_destroyed: boolean = false

Abstract engine

engine: GobanEngine

Readonly goban_id

goban_id: number = ++last_goban_id

Base fields *

-

Static setCallbacks

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

Type declaration

    • (newCallbacks): void

    • Set's callback functions to be called in various situations. You can set any +

Constructors

constructor

Properties

Private _destroyed

_destroyed: boolean = false

Abstract engine

engine: GobanEngine

Readonly goban_id

goban_id: number = ++last_goban_id

Base fields *

+

Static setCallbacks

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

Static setTranslations

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

Type declaration

    • (_catalog, _debug_mode?): void

    • Parameters

      Returns void

Accessors

destroyed

is_game_record

  • get is_game_record(): boolean

  • True if the game is a game record of a real life game

    -

    Returns boolean

Methods

Abstract clearAnalysisDrawing

Abstract clearMessage

decodeMoves

  • decodeMoves(move_obj): JGOFMove[]

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

    Parameters

    Returns void

Static setTranslations

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

Type declaration

    • (_catalog, _debug_mode?): void

    • Parameters

      Returns void

Accessors

destroyed

is_game_record

  • get is_game_record(): boolean

  • True if the game is a game record of a real life game

    +

    Returns boolean

Methods

Abstract clearAnalysisDrawing

Abstract clearMessage

decodeMoves

decodePrettyCoordinates

decodePrettyCoordinates

  • decodePrettyCoordinates(coordinates): JGOFMove

  • Decodes a move string like "A11" into a move object like {x: 0, y: 10}. Also handles the special cases like ".." and "pass" which map to {x: -1, y: -1}.

    -

    Parameters

    • coordinates: string

    Returns JGOFMove

destroy

Abstract disablePen

Abstract drawPenMarks

Abstract drawSquare

  • drawSquare(i, j): void

  • Parameters

    • i: number
    • j: number

    Returns void

Abstract enablePen

encodeMove

encodeMoves

Abstract move_tree_redraw

  • move_tree_redraw(no_warp?): void

  • Parameters

    • Optional no_warp: boolean

    Returns void

prettyCoordinates

  • prettyCoordinates(x): string

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

    -

    Parameters

    Returns string

  • prettyCoordinates(x, y): string

  • Parameters

    • x: number
    • y: number

    Returns string

Abstract redraw

  • redraw(force_clear?): void

  • Parameters

    • Optional force_clear: boolean

    Returns void

Abstract set

Abstract setForRemoval

  • setForRemoval(x, y, removed, emit_stone_removal_updated): void

  • Called when a location is marked or unmarked for removal

    -

    Parameters

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

    Returns void

Abstract setMoveTreeContainer

  • setMoveTreeContainer(container): void

  • Parameters

    • container: any

    Returns void

Abstract setState

  • setState(): void

  • Called when Engine.setState loads a previously saved board state.

    -

    Returns void

Abstract showMessage

  • showMessage(msg_id, parameters?, timeout?): void

  • Parameters

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

    Returns void

Abstract updateScoreEstimation

Settings

Member Visibility

Theme

On This Page

constructor_destroyedenginegoban_idsetCallbackssetTranslationsdestroyedis_game_recordclearAnalysisDrawingclearMessagedecodeMovesdecodePrettyCoordinatesdestroydisablePendrawPenMarksdrawSquareenablePenencodeMoveencodeMovesmove_tree_redrawprettyCoordinatesredrawsetsetForRemovalsetMoveTreeContainersetStateshowMessageupdateScoreEstimation
\ No newline at end of file +

Parameters

Returns JGOFMove

destroy

Abstract disablePen

Abstract drawPenMarks

Abstract drawSquare

Abstract enablePen

encodeMove

encodeMoves

Abstract move_tree_redraw

prettyCoordinates

Abstract redraw

Abstract set

Abstract setForRemoval

Abstract setMoveTreeContainer

Abstract setState

Abstract showMessage

Abstract updateScoreEstimation

Settings

Member Visibility

Theme

On This Page

constructor_destroyedenginegoban_idsetCallbackssetTranslationsdestroyedis_game_recordclearAnalysisDrawingclearMessagedecodeMovesdecodePrettyCoordinatesdestroydisablePendrawPenMarksdrawSquareenablePenencodeMoveencodeMovesmove_tree_redrawprettyCoordinatesredrawsetsetForRemovalsetMoveTreeContainersetStateshowMessageupdateScoreEstimation
\ No newline at end of file diff --git a/docs/classes/GobanCanvas.html b/docs/classes/GobanCanvas.html index 5fbc96f5..2ba2e04d 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

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

__board_redraw_pen_layer_timer __borders_initialized __clock_timer? @@ -323,31 +323,31 @@ getMoveTreeNumbering getSoundEnabled getSoundVolume -

Constructors

constructor

Properties

Protected __board_redraw_pen_layer_timer

__board_redraw_pen_layer_timer: any = null

Private __borders_initialized

__borders_initialized: boolean = false

Protected Optional __clock_timer

__clock_timer?: Timeout

Protected __draw_state

__draw_state: string[][]

Protected __last_pt

__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean

Private __set_board_height

__set_board_height: number = -1

Private __set_board_width

__set_board_width: number = -1

Protected __update_move_tree

__update_move_tree: any = null

Protected analysis_move_counter

analysis_move_counter: number

Protected analysis_removal_last_position

analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected Optional analysis_removal_state

analysis_removal_state?: boolean

Private autoplaying_puzzle_move

autoplaying_puzzle_move: boolean = false

Private board

board: HTMLCanvasElement

Protected bounded_height

bounded_height: number

Protected bounded_width

bounded_width: number

Protected bounds

bounds: GobanBounds

Private byoyomi_label

byoyomi_label: string = ""

chat_log

chat_log: GobanChatLog = []

Protected circle_radius

circle_radius: number

clock_should_be_paused_for_move_submission

clock_should_be_paused_for_move_submission: boolean = false

Protected Optional colored_circles

colored_circles?: (undefined | ColoredCircle)[][]

Protected conditional_path

conditional_path: string = ""

conditional_starting_color

conditional_starting_color: "black" | "white" | "invalid" = "invalid"

conditional_tree

conditional_tree: ConditionalMoveTree = ...

config

config: GobanConfig

Protected Optional connectToReviewSent

connectToReviewSent?: boolean

Private ctx

ctx: CanvasRenderingContext2D

Protected Optional current_cmove

current_cmove?: ConditionalMoveTree

Private Optional current_pen_mark

current_pen_mark?: {
    color: string;
    points: [number, number];
}

Type declaration

  • color: string
  • points: [number, number]

Protected currently_my_cmove

currently_my_cmove: boolean = false

Protected dirty_redraw

dirty_redraw: any = null

Protected disconnectedFromGame

disconnectedFromGame: boolean = true

Protected Optional display_width

display_width?: number

Protected done_loading_review

done_loading_review: boolean = false

Protected dont_draw_last_move

dont_draw_last_move: boolean

double_click_submit

double_click_submit: boolean

draw_bottom_labels

draw_bottom_labels: boolean

draw_left_labels

draw_left_labels: boolean

draw_right_labels

draw_right_labels: boolean

draw_top_labels

draw_top_labels: boolean

Private drawing_enabled

drawing_enabled: boolean = true

Protected Optional edit_color

edit_color?: "black" | "white"

engine

engine: GobanEngine

Protected errorHandler

errorHandler: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: Error

      Returns void

Readonly game_id

game_id: number

Protected game_type

game_type: string

Protected Optional getPuzzlePlacementSetting

getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

Type declaration

Readonly goban_id

goban_id: number = ++last_goban_id

Base fields *

-

Private handleShiftKey

handleShiftKey: ((ev) => void)

Type declaration

    • (ev): void

    • Parameters

      • ev: KeyboardEvent

      Returns void

Protected Optional heatmap

heatmap?: NumberMatrix

height

height: number

Protected highlight_movetree_moves

highlight_movetree_moves: boolean

Protected interactive

interactive: boolean

Protected isInPushedAnalysis

isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerController

isPlayerController: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerOwner

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected label_character

label_character: string

Protected label_mark

label_mark: string = "[UNSET]"

Private Optional labeling_mode

labeling_mode?: "put" | "clear"

Optional last_clock

last_clock?: AdHocClock

Optional last_emitted_clock

last_emitted_clock?: JGOFClockWithTransmitting

Protected Optional last_hover_square

last_hover_square?: JGOFIntersection

Private last_label_position

last_label_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected Optional last_move

last_move?: MoveTree

Private last_move_opacity

last_move_opacity: number = 1

Protected last_move_radius

last_move_radius: number

Protected last_paused_by_player_state

last_paused_by_player_state: null | boolean = null

Protected last_paused_state

last_paused_state: null | boolean = null

Private Optional last_pen_position

last_pen_position?: [number, number]

Protected Optional last_phase

last_phase?: GobanEnginePhase

Protected last_review_message

last_review_message: ReviewMessage

Protected Optional last_sound_played_for_a_stone_placement

last_sound_played_for_a_stone_placement?: string

Protected last_stone_sound

last_stone_sound: number

Protected leavePushedAnalysis

leavePushedAnalysis: (() => void)

Type declaration

    • (): void

    • Returns void

Protected Optional marked_analysis_score

marked_analysis_score?: boolean[][]

Private Optional message_div

message_div?: HTMLDivElement

Private Optional message_td

message_td?: HTMLElement

Private Optional message_text

message_text?: HTMLDivElement

Private Optional message_timeout

message_timeout?: number

Protected metrics

metrics: GobanMetrics = ...

Protected Optional move_selected

move_selected?: JGOFIntersection

Private Optional move_tree_canvas

move_tree_canvas?: HTMLCanvasElement

Optional move_tree_container

move_tree_container?: HTMLElement

Private Optional move_tree_inner_container

move_tree_inner_container?: HTMLDivElement

Protected no_display

no_display: boolean

Protected Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Protected on_game_screen

on_game_screen: boolean

one_click_submit

one_click_submit: boolean

Protected original_square_size

original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number

    • Parameters

      Returns number

Protected parent

parent: HTMLElement

Optional pause_control

pause_control?: AdHocPauseControl

Optional paused_since

paused_since?: number

Private Optional pen_ctx

pen_ctx?: CanvasRenderingContext2D

Private Optional pen_layer

pen_layer?: HTMLCanvasElement

pen_marks

pen_marks: any[]

Protected player_id

player_id: number

Protected Optional preloaded_data

preloaded_data?: GobanConfig

previous_mode

previous_mode: string

Protected puzzle_autoplace_delay

puzzle_autoplace_delay: number

Private ready_to_draw

ready_to_draw: boolean = false

Protected restrict_moves_to_movetree

restrict_moves_to_movetree: boolean

Protected review_had_gamedata

review_had_gamedata: boolean

Readonly review_id

review_id: number

Protected scoring_mode

scoring_mode: boolean | "stalling-scoring-mode"

Protected Optional sendLatencyTimer

sendLatencyTimer?: Timeout

sent_timed_out_message

sent_timed_out_message: boolean = false

Private Optional shadow_ctx

shadow_ctx?: CanvasRenderingContext2D

Private Optional shadow_layer

shadow_layer?: HTMLCanvasElement

Protected shift_key_is_down

shift_key_is_down: boolean

Protected show_move_numbers

show_move_numbers: boolean

Protected show_variation_move_numbers

show_variation_move_numbers: boolean

showing_scores

showing_scores: boolean = false

Protected socket

socket: GobanSocket<ClientToServer, ServerToClient>

Protected socket_event_bindings

socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

Protected square_size

square_size: number = 10

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Protected stone_placement_enabled

stone_placement_enabled: boolean

Protected Optional stone_removal_auto_scoring_done

stone_removal_auto_scoring_done?: boolean = false

Private theme_black

theme_black: GobanTheme

Private theme_black_stones

theme_black_stones: any[] = []

Private theme_black_text_color

theme_black_text_color: string = HOT_PINK

Private theme_blank_text_color

theme_blank_text_color: string = HOT_PINK

Private theme_board

theme_board: GobanTheme

Private theme_faded_line_color

theme_faded_line_color: string = HOT_PINK

Private theme_faded_star_color

theme_faded_star_color: string = HOT_PINK

Private theme_line_color

theme_line_color: string = ""

Private theme_star_color

theme_star_color: string = ""

Private theme_stone_radius

theme_stone_radius: number = 10

Private theme_white

theme_white: GobanTheme

Private theme_white_stones

theme_white_stones: any[] = []

Private theme_white_text_color

theme_white_text_color: string = HOT_PINK

Private themes

themes: GobanSelectedThemes = ...

Protected Optional title_div

title_div?: HTMLElement

variation_stone_opacity

variation_stone_opacity: number

visual_undo_request_indicator

visual_undo_request_indicator: boolean

width

width: number

Static THEMES

THEMES: ThemesInterface = THEMES

Static THEMES_SORTED

THEMES_SORTED: {
    black: GobanTheme[];
    board: GobanTheme[];
    white: GobanTheme[];
    [key: string]: GobanTheme[];
} = THEMES_SORTED

Type declaration

Static setCallbacks

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

Type declaration

    • (newCallbacks): void

    • Set's callback functions to be called in various situations. You can set any +

Constructors

constructor

Properties

Protected __board_redraw_pen_layer_timer

__board_redraw_pen_layer_timer: any = null

Private __borders_initialized

__borders_initialized: boolean = false

Protected Optional __clock_timer

__clock_timer?: Timeout

Protected __draw_state

__draw_state: string[][]

Protected __last_pt

__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean

Private __set_board_height

__set_board_height: number = -1

Private __set_board_width

__set_board_width: number = -1

Protected __update_move_tree

__update_move_tree: any = null

Protected analysis_move_counter

analysis_move_counter: number

Protected analysis_removal_last_position

analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected Optional analysis_removal_state

analysis_removal_state?: boolean

Private autoplaying_puzzle_move

autoplaying_puzzle_move: boolean = false

Private board

board: HTMLCanvasElement

Protected bounded_height

bounded_height: number

Protected bounded_width

bounded_width: number

Protected bounds

bounds: GobanBounds

Private byoyomi_label

byoyomi_label: string = ""

chat_log

chat_log: GobanChatLog = []

Protected circle_radius

circle_radius: number

clock_should_be_paused_for_move_submission

clock_should_be_paused_for_move_submission: boolean = false

Protected Optional colored_circles

colored_circles?: (undefined | ColoredCircle)[][]

Protected conditional_path

conditional_path: string = ""

conditional_starting_color

conditional_starting_color: "black" | "white" | "invalid" = "invalid"

conditional_tree

conditional_tree: ConditionalMoveTree = ...

config

config: GobanConfig

Protected Optional connectToReviewSent

connectToReviewSent?: boolean

Private ctx

ctx: CanvasRenderingContext2D

Protected Optional current_cmove

current_cmove?: ConditionalMoveTree

Private Optional current_pen_mark

current_pen_mark?: {
    color: string;
    points: [number, number];
}

Type declaration

  • color: string
  • points: [number, number]

Protected currently_my_cmove

currently_my_cmove: boolean = false

Protected dirty_redraw

dirty_redraw: any = null

Protected disconnectedFromGame

disconnectedFromGame: boolean = true

Protected Optional display_width

display_width?: number

Protected done_loading_review

done_loading_review: boolean = false

Protected dont_draw_last_move

dont_draw_last_move: boolean

double_click_submit

double_click_submit: boolean

draw_bottom_labels

draw_bottom_labels: boolean

draw_left_labels

draw_left_labels: boolean

draw_right_labels

draw_right_labels: boolean

draw_top_labels

draw_top_labels: boolean

Private drawing_enabled

drawing_enabled: boolean = true

Protected Optional edit_color

edit_color?: "black" | "white"

engine

engine: GobanEngine

Protected errorHandler

errorHandler: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: Error

      Returns void

Readonly game_id

game_id: number

Protected game_type

game_type: string

Protected Optional getPuzzlePlacementSetting

getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

Type declaration

Readonly goban_id

goban_id: number = ++last_goban_id

Base fields *

+

Private handleShiftKey

handleShiftKey: ((ev) => void)

Type declaration

    • (ev): void

    • Parameters

      • ev: KeyboardEvent

      Returns void

Protected Optional heatmap

heatmap?: NumberMatrix

height

height: number

Protected highlight_movetree_moves

highlight_movetree_moves: boolean

Protected interactive

interactive: boolean

Protected isInPushedAnalysis

isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerController

isPlayerController: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerOwner

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected label_character

label_character: string

Protected label_mark

label_mark: string = "[UNSET]"

Private Optional labeling_mode

labeling_mode?: "put" | "clear"

Optional last_clock

last_clock?: AdHocClock

Optional last_emitted_clock

last_emitted_clock?: JGOFClockWithTransmitting

Protected Optional last_hover_square

last_hover_square?: JGOFIntersection

Private last_label_position

last_label_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected Optional last_move

last_move?: MoveTree

Private last_move_opacity

last_move_opacity: number = 1

Protected last_move_radius

last_move_radius: number

Protected last_paused_by_player_state

last_paused_by_player_state: null | boolean = null

Protected last_paused_state

last_paused_state: null | boolean = null

Private Optional last_pen_position

last_pen_position?: [number, number]

Protected Optional last_phase

last_phase?: GobanEnginePhase

Protected last_review_message

last_review_message: ReviewMessage

Protected Optional last_sound_played_for_a_stone_placement

last_sound_played_for_a_stone_placement?: string

Protected last_stone_sound

last_stone_sound: number

Protected leavePushedAnalysis

leavePushedAnalysis: (() => void)

Type declaration

    • (): void

    • Returns void

Protected Optional marked_analysis_score

marked_analysis_score?: boolean[][]

Private Optional message_div

message_div?: HTMLDivElement

Private Optional message_td

message_td?: HTMLElement

Private Optional message_text

message_text?: HTMLDivElement

Private Optional message_timeout

message_timeout?: number

Protected metrics

metrics: GobanMetrics = ...

Protected Optional move_selected

move_selected?: JGOFIntersection

Private Optional move_tree_canvas

move_tree_canvas?: HTMLCanvasElement

Optional move_tree_container

move_tree_container?: HTMLElement

Private Optional move_tree_inner_container

move_tree_inner_container?: HTMLDivElement

Protected no_display

no_display: boolean

Protected Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Protected on_game_screen

on_game_screen: boolean

one_click_submit

one_click_submit: boolean

Protected original_square_size

original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number

    • Parameters

      Returns number

Protected parent

parent: HTMLElement

Optional pause_control

pause_control?: AdHocPauseControl

Optional paused_since

paused_since?: number

Private Optional pen_ctx

pen_ctx?: CanvasRenderingContext2D

Private Optional pen_layer

pen_layer?: HTMLCanvasElement

pen_marks

pen_marks: any[]

Protected player_id

player_id: number

Protected Optional preloaded_data

preloaded_data?: GobanConfig

previous_mode

previous_mode: string

Protected puzzle_autoplace_delay

puzzle_autoplace_delay: number

Private ready_to_draw

ready_to_draw: boolean = false

Protected restrict_moves_to_movetree

restrict_moves_to_movetree: boolean

Protected review_had_gamedata

review_had_gamedata: boolean

Readonly review_id

review_id: number

Protected scoring_mode

scoring_mode: boolean | "stalling-scoring-mode"

Protected Optional sendLatencyTimer

sendLatencyTimer?: Timeout

sent_timed_out_message

sent_timed_out_message: boolean = false

Private Optional shadow_ctx

shadow_ctx?: CanvasRenderingContext2D

Private Optional shadow_layer

shadow_layer?: HTMLCanvasElement

Protected shift_key_is_down

shift_key_is_down: boolean

Protected show_move_numbers

show_move_numbers: boolean

Protected show_variation_move_numbers

show_variation_move_numbers: boolean

showing_scores

showing_scores: boolean = false

Protected socket

socket: GobanSocket<ClientToServer, ServerToClient>

Protected socket_event_bindings

socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

Protected square_size

square_size: number = 10

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Protected stone_placement_enabled

stone_placement_enabled: boolean

Protected Optional stone_removal_auto_scoring_done

stone_removal_auto_scoring_done?: boolean = false

Private theme_black

theme_black: GobanTheme

Private theme_black_stones

theme_black_stones: any[] = []

Private theme_black_text_color

theme_black_text_color: string = HOT_PINK

Private theme_blank_text_color

theme_blank_text_color: string = HOT_PINK

Private theme_board

theme_board: GobanTheme

Private theme_faded_line_color

theme_faded_line_color: string = HOT_PINK

Private theme_faded_star_color

theme_faded_star_color: string = HOT_PINK

Private theme_line_color

theme_line_color: string = ""

Private theme_star_color

theme_star_color: string = ""

Private theme_stone_radius

theme_stone_radius: number = 10

Private theme_white

theme_white: GobanTheme

Private theme_white_stones

theme_white_stones: any[] = []

Private theme_white_text_color

theme_white_text_color: string = HOT_PINK

Private themes

themes: GobanSelectedThemes = ...

Protected Optional title_div

title_div?: HTMLElement

variation_stone_opacity

variation_stone_opacity: number

visual_undo_request_indicator

visual_undo_request_indicator: boolean

width

width: number

Static THEMES

THEMES: ThemesInterface = THEMES

Static THEMES_SORTED

THEMES_SORTED: {
    black: GobanTheme[];
    board: GobanTheme[];
    white: GobanTheme[];
    [key: string]: GobanTheme[];
} = THEMES_SORTED

Type declaration

Static setCallbacks

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

Static setTranslations

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

Type declaration

    • (_catalog, _debug_mode?): void

    • Parameters

      Returns void

Accessors

analyze_subtool

  • get analyze_subtool(): string

  • Returns string

  • set analyze_subtool(analyze_subtool): void

  • Parameters

    • analyze_subtool: string

    Returns void

analyze_tool

destroyed

  • get destroyed(): boolean

  • Returns boolean

is_game_record

  • get is_game_record(): boolean

  • True if the game is a game record of a real life game

    -

    Returns boolean

mode

review_controller_id

  • 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

review_owner_id

  • 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

score_estimator

submit_move

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

  • Returns undefined | (() => void)

  • set submit_move(submit_move): void

  • Parameters

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

    Returns void

title

Methods

Private __drawSquare

Protected _socket_on

acceptRemovedStones

acceptUndo

Protected annul

Private attachPenCanvas

Private attachShadowLayer

Private bindPointerBindings

cancelGame

cancelUndo

clearAnalysisDrawing

clearAnalysisScores

clearMark

clearMessage

Protected clearPendingResignation

Protected clearTransientMark

computeMetrics

Protected computeNewPlayerClock

Protected computeThemeStoneRadius

Protected connect

debouncedEmitCapturedStones

decodeMoves

  • decodeMoves(move_obj): JGOFMove[]

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

    Parameters

    Returns void

Static setTranslations

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

Type declaration

    • (_catalog, _debug_mode?): void

    • Parameters

      Returns void

Accessors

analyze_subtool

  • get analyze_subtool(): string

  • Returns string

  • set analyze_subtool(analyze_subtool): void

  • Parameters

    • analyze_subtool: string

    Returns void

analyze_tool

destroyed

  • get destroyed(): boolean

  • Returns boolean

is_game_record

  • get is_game_record(): boolean

  • True if the game is a game record of a real life game

    +

    Returns boolean

mode

review_controller_id

  • 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

review_owner_id

  • 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

score_estimator

submit_move

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

  • Returns undefined | (() => void)

  • set submit_move(submit_move): void

  • Parameters

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

    Returns void

title

Methods

Private __drawSquare

Protected _socket_on

acceptRemovedStones

acceptUndo

Protected annul

Private attachPenCanvas

Private attachShadowLayer

Private bindPointerBindings

cancelGame

cancelUndo

clearAnalysisDrawing

clearAnalysisScores

clearMark

clearMessage

Protected clearPendingResignation

Protected clearTransientMark

computeMetrics

Protected computeNewPlayerClock

Protected computeThemeStoneRadius

Protected connect

debouncedEmitCapturedStones

decodeMoves

decodePrettyCoordinates

decodePrettyCoordinates

  • decodePrettyCoordinates(coordinates): JGOFMove

  • Decodes a move string like "A11" into a move object like {x: 0, y: 10}. Also handles the special cases like ".." and "pass" which map to {x: -1, y: -1}.

    -

    Parameters

    • coordinates: string

    Returns JGOFMove

Protected defaultConfig

deleteBranch

deleteConditionalPath

deleteCustomMark

destroy

Private detachPenCanvas

Private detachShadowLayer

Protected disableDrawing

disablePen

disableStonePlacement

Protected disconnect

drawPenMarks

drawSquare

Private drawingHash

editPlaceByPrettyCoordinates

Protected enableDrawing

enablePen

enableStonePlacement

encodeMove

encodeMoves

followConditionalPath

Protected followConditionalSegment

Protected getAnalysisScoreColorAtLocation

Protected getClockDrift

Protected getCoordinateDisplaySystem

getCurrentConditionalPath

getLastReviewMessage

Protected getLocation

getMarks

Protected getNetworkLatency

getPlayerRelativeLatency

Protected getSelectedThemes

Protected getShowMoveNumbers

Protected getShowVariationMoveNumbers

Protected getWidthForSquareSize

giveReviewControl

hideScores

Protected incrementLabelCharacter

isAnalysisDisabled

isCurrentUserAPlayer

Protected isLastOfficialMove

jumpToLastOfficialMove

load

markAnalysisScores

Protected defaultConfig

deleteBranch

deleteConditionalPath

deleteCustomMark

destroy

Private detachPenCanvas

Private detachShadowLayer

Protected disableDrawing

disablePen

disableStonePlacement

Protected disconnect

drawPenMarks

drawSquare

Private drawingHash

editPlaceByPrettyCoordinates

Protected enableDrawing

enablePen

enableStonePlacement

encodeMove

encodeMoves

followConditionalPath

Protected followConditionalSegment

Protected getAnalysisScoreColorAtLocation

Protected getClockDrift

Protected getCoordinateDisplaySystem

getCurrentConditionalPath

getLastReviewMessage

Protected getLocation

getMarks

Protected getNetworkLatency

getPlayerRelativeLatency

Protected getSelectedThemes

Protected getShowMoveNumbers

Protected getShowVariationMoveNumbers

Protected getWidthForSquareSize

giveReviewControl

hideScores

Protected incrementLabelCharacter

isAnalysisDisabled

isCurrentUserAPlayer

Protected isLastOfficialMove

jumpToLastOfficialMove

load

markAnalysisScores

  • markAnalysisScores(): void

  • 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

markDirty

move_tree_bindCanvasEvents

move_tree_drawIsoBranchTo

move_tree_drawPath

move_tree_drawRecursive

move_tree_drawStone

move_tree_hilightNode

move_tree_recursiveDrawPath

move_tree_redraw

nextSibling

Protected onAnalysisScoringMove

Protected onAnalysisScoringStart

Protected onAnalysisToggleStoneRemoval

Private onLabelingMove

Private onLabelingStart

Private onMouseMove

Private onMouseOut

Private onPenMove

Private onPenStart

Private onTap

  • onTap(event, double_tap, right_click, press_duration_ms): void

  • Parameters

    • event: TouchEvent | MouseEvent
    • double_tap: boolean
    • right_click: boolean
    • press_duration_ms: number

    Returns void

pass

pauseGame

Private pen2xy

performStoneRemovalAutoScoring

placeByPrettyCoordinates

Protected playMovementSound

Protected post_config_constructor

markDirty

move_tree_bindCanvasEvents

move_tree_drawIsoBranchTo

move_tree_drawPath

move_tree_drawRecursive

move_tree_drawStone

move_tree_hilightNode

move_tree_recursiveDrawPath

move_tree_redraw

nextSibling

Protected onAnalysisScoringMove

Protected onAnalysisScoringStart

Protected onAnalysisToggleStoneRemoval

Private onLabelingMove

Private onLabelingStart

Private onMouseMove

Private onMouseOut

Private onPenMove

Private onPenStart

Private onTap

  • onTap(event, double_tap, right_click, press_duration_ms): void

  • Parameters

    • event: TouchEvent | MouseEvent
    • double_tap: boolean
    • right_click: boolean
    • press_duration_ms: number

    Returns void

pass

pauseGame

Private pen2xy

performStoneRemovalAutoScoring

placeByPrettyCoordinates

Protected playMovementSound

Protected post_config_constructor

  • post_config_constructor(): GobanEngine

  • 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

prettyCoordinates

prevSibling

Protected putAnalysisRemovalAtLocation

Protected putAnalysisScoreColorAtLocation

Protected putOrClearLabel

redraw

rejectRemovedStones

requestUndo

resign

resumeGame

saveConditionalMoves

Protected scheduleRedrawPenLayer

sendChat

Protected sendMove

Protected sendPendingResignation

sendPreventEscaping

sendPreventStalling

sendTimedOut

prettyCoordinates

prevSibling

Protected putAnalysisRemovalAtLocation

Protected putAnalysisScoreColorAtLocation

Protected putOrClearLabel

redraw

rejectRemovedStones

requestUndo

resign

resumeGame

saveConditionalMoves

Protected scheduleRedrawPenLayer

sendChat

Protected sendMove

Protected sendPendingResignation

sendPreventEscaping

sendPreventStalling

sendTimedOut

  • sendTimedOut(): void

  • 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

set

setAnalyzeTool

setBounds

setByoYomiLabel

setColoredCircles

setColoredMarks

  • setColoredMarks(colored_marks): void

  • Parameters

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

    Returns void

setConditionalTree

setCustomMark

setEditColor

setForRemoval

  • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

setGameClock

setHeatmap

setLabelCharacter

Protected setLabelCharacterFromMarks

setLabelPosition

setLastMoveOpacity

Protected setLastOfficialMove

setLastReviewMessage

Protected setLetterMark

setMark

setMarkByPrettyCoordinates

Protected setMarkColor

setMarks

set

setAnalyzeTool

setBounds

setByoYomiLabel

setColoredCircles

setColoredMarks

  • setColoredMarks(colored_marks): void

  • Parameters

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

    Returns void

setConditionalTree

setCustomMark

setEditColor

setForRemoval

  • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

setGameClock

setHeatmap

setLabelCharacter

Protected setLabelCharacterFromMarks

setLabelPosition

setLastMoveOpacity

Protected setLastOfficialMove

setLastReviewMessage

Protected setLetterMark

setMark

setMarkByPrettyCoordinates

Protected setMarkColor

setMarks

  • setMarks(marks, dont_draw?): 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

setMode

setModeDeferred

setMoveTreeContainer

Private setPenStyle

setScoringMode

setSquareSize

setSquareSizeBasedOnDisplayWidth

setState

  • setState(): 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

setMode

setModeDeferred

setMoveTreeContainer

Private setPenStyle

setScoringMode

setSquareSize

setSquareSizeBasedOnDisplayWidth

setState

setStrictSekiMode

Protected setSubmit

setSubscriptMark

Protected setTheme

Protected setTitle

setToPreviousMode

Protected setTransientMark

showFirst

showMessage

showNext

showPrevious

showScores

showStallingScoreEstimate

syncReviewMove

Protected toggleMark

  • toggleMark(x, y, mark, force_label?, force_put?): boolean

  • Parameters

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

    Returns boolean

Protected updateMoveTree

Protected updateOrRedrawMoveTree

updatePlayerToMoveTitle

updateScoreEstimation

updateTitleAndStonePlacement

Protected watchSelectedThemes

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

  • Parameters

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

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

        • Returns any

Protected xy2ij

  • xy2ij(x, y, anti_slip?): {
        i: number;
        j: number;
        valid: boolean;
    }

  • Parameters

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

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

    • i: number
    • j: number
    • valid: boolean

Private xy2pen

Static getCDNReleaseBase

Static getMoveTreeNumbering

Static getSoundEnabled

Static getSoundVolume

Settings

Member Visibility

Theme

On This Page

constructor__board_redraw_pen_layer_timer__borders_initialized__clock_timer__draw_state__last_pt__set_board_height__set_board_width__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_stateautoplaying_puzzle_moveboardbounded_heightbounded_widthboundsbyoyomi_labelchat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentctxcurrent_cmovecurrent_pen_markcurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsdrawing_enablededit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idhandleShiftKeyheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklabeling_modelast_clocklast_emitted_clocklast_hover_squarelast_label_positionlast_movelast_move_opacitylast_move_radiuslast_paused_by_player_statelast_paused_statelast_pen_positionlast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremessage_divmessage_tdmessage_textmessage_timeoutmetricsmove_selectedmove_tree_canvasmove_tree_containermove_tree_inner_containerno_displayonErroron_game_screenone_click_submitoriginal_square_sizeparentpause_controlpaused_sincepen_ctxpen_layerpen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayready_to_drawrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshadow_ctxshadow_layershift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donetheme_blacktheme_black_stonestheme_black_text_colortheme_blank_text_colortheme_boardtheme_faded_line_colortheme_faded_star_colortheme_line_colortheme_star_colortheme_stone_radiustheme_whitetheme_white_stonestheme_white_text_colorthemestitle_divvariation_stone_opacityvisual_undo_request_indicatorwidthTHEMESTHEMES_SORTEDsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle__drawSquare_socket_onacceptRemovedStonesacceptUndoannulattachPenCanvasattachShadowLayerbindPointerBindingscancelGamecancelUndoclearAnalysisDrawingclearAnalysisScoresclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeMetricscomputeNewPlayerClockcomputeThemeStoneRadiusconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydetachPenCanvasdetachShadowLayerdisableDrawingdisablePendisableStonePlacementdisconnectdrawPenMarksdrawSquaredrawingHasheditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetAnalysisScoreColorAtLocationgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkAnalysisScoresmarkDirtymove_tree_bindCanvasEventsmove_tree_drawIsoBranchTomove_tree_drawPathmove_tree_drawRecursivemove_tree_drawStonemove_tree_hilightNodemove_tree_recursiveDrawPathmove_tree_redrawnextSiblingonAnalysisScoringMoveonAnalysisScoringStartonAnalysisToggleStoneRemovalonLabelingMoveonLabelingStartonMouseMoveonMouseOutonPenMoveonPenStartonTappasspauseGamepen2xyperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingputAnalysisRemovalAtLocationputAnalysisScoreColorAtLocationputOrClearLabelredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetByoYomiLabelsetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLabelPositionsetLastMoveOpacitysetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetPenStylesetScoringModesetSquareSizesetSquareSizeBasedOnDisplayWidthsetStatesetStrictSekiModesetSubmitsetSubscriptMarksetThemesetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementwatchSelectedThemesxy2ijxy2pengetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
\ No newline at end of file +

Returns void

setStrictSekiMode

Protected setSubmit

setSubscriptMark

Protected setTheme

Protected setTitle

setToPreviousMode

Protected setTransientMark

showFirst

showMessage

showNext

showPrevious

showScores

showStallingScoreEstimate

syncReviewMove

Protected toggleMark

Protected updateMoveTree

Protected updateOrRedrawMoveTree

updatePlayerToMoveTitle

updateScoreEstimation

updateTitleAndStonePlacement

Protected watchSelectedThemes

Protected xy2ij

Private xy2pen

Static getCDNReleaseBase

Static getMoveTreeNumbering

Static getSoundEnabled

Static getSoundVolume

Settings

Member Visibility

Theme

On This Page

constructor__board_redraw_pen_layer_timer__borders_initialized__clock_timer__draw_state__last_pt__set_board_height__set_board_width__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_stateautoplaying_puzzle_moveboardbounded_heightbounded_widthboundsbyoyomi_labelchat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentctxcurrent_cmovecurrent_pen_markcurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsdrawing_enablededit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idhandleShiftKeyheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklabeling_modelast_clocklast_emitted_clocklast_hover_squarelast_label_positionlast_movelast_move_opacitylast_move_radiuslast_paused_by_player_statelast_paused_statelast_pen_positionlast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremessage_divmessage_tdmessage_textmessage_timeoutmetricsmove_selectedmove_tree_canvasmove_tree_containermove_tree_inner_containerno_displayonErroron_game_screenone_click_submitoriginal_square_sizeparentpause_controlpaused_sincepen_ctxpen_layerpen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayready_to_drawrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshadow_ctxshadow_layershift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donetheme_blacktheme_black_stonestheme_black_text_colortheme_blank_text_colortheme_boardtheme_faded_line_colortheme_faded_star_colortheme_line_colortheme_star_colortheme_stone_radiustheme_whitetheme_white_stonestheme_white_text_colorthemestitle_divvariation_stone_opacityvisual_undo_request_indicatorwidthTHEMESTHEMES_SORTEDsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle__drawSquare_socket_onacceptRemovedStonesacceptUndoannulattachPenCanvasattachShadowLayerbindPointerBindingscancelGamecancelUndoclearAnalysisDrawingclearAnalysisScoresclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeMetricscomputeNewPlayerClockcomputeThemeStoneRadiusconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydetachPenCanvasdetachShadowLayerdisableDrawingdisablePendisableStonePlacementdisconnectdrawPenMarksdrawSquaredrawingHasheditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetAnalysisScoreColorAtLocationgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkAnalysisScoresmarkDirtymove_tree_bindCanvasEventsmove_tree_drawIsoBranchTomove_tree_drawPathmove_tree_drawRecursivemove_tree_drawStonemove_tree_hilightNodemove_tree_recursiveDrawPathmove_tree_redrawnextSiblingonAnalysisScoringMoveonAnalysisScoringStartonAnalysisToggleStoneRemovalonLabelingMoveonLabelingStartonMouseMoveonMouseOutonPenMoveonPenStartonTappasspauseGamepen2xyperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingputAnalysisRemovalAtLocationputAnalysisScoreColorAtLocationputOrClearLabelredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetByoYomiLabelsetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLabelPositionsetLastMoveOpacitysetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetPenStylesetScoringModesetSquareSizesetSquareSizeBasedOnDisplayWidthsetStatesetStrictSekiModesetSubmitsetSubscriptMarksetThemesetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementwatchSelectedThemesxy2ijxy2pengetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
\ No newline at end of file diff --git a/docs/classes/GobanEngine.html b/docs/classes/GobanEngine.html index abd4634c..bb437e96 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

constructor

Properties

_cur_move _cur_review_move _last_official_move @@ -143,44 +143,44 @@ clearRuleSettings fillDefaults migrateConfig -

Constructors

constructor

Properties

Private _cur_move

_cur_move: MoveTree

Private _cur_review_move

_cur_review_move: undefined | MoveTree

Private _last_official_move

_last_official_move: MoveTree

Private _outcome

_outcome: string = ""

Private _phase

_phase: GobanEnginePhase = "play"

Private _rules

_rules: GobanEngineRules = "japanese"

Private _strict_seki_mode

_strict_seki_mode: boolean = false

Private Optional _undo_requested

_undo_requested?: number

Private Optional _winner

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

Private aga_handicap_scoring

aga_handicap_scoring: boolean = false

Private allow_ko

allow_ko: boolean = false

Private allow_self_capture

allow_self_capture: boolean = false

Private allow_superko

allow_superko: boolean = false

automatic_stone_removal

automatic_stone_removal: boolean = false

black_prisoners

black_prisoners: number

board

board: JGOFNumericPlayerColor[][]

board_is_repeating

board_is_repeating: boolean

Readonly config

config: GobanEngineConfig

decoded_moves

decoded_moves: JGOFMove[] = []

Readonly disable_analysis

disable_analysis: boolean = false

Private dontStoreBoardHistory

dontStoreBoardHistory: boolean

free_handicap_placement

free_handicap_placement: boolean = false

game_id

game_id: number = NaN

Protected Optional goban_callback

goban_callback?: GobanBase

Optional group_ids

group_ids?: number[]

handicap

handicap: number = NaN

Optional handicap_rank_difference

handicap_rank_difference?: number

Readonly height

height: number = 19

initial_state

initial_state: GobanEngineInitialState = ...

Readonly is_game_record

is_game_record: boolean = false

komi

komi: number = NaN

Optional latencies

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

Type declaration

  • [player_id: string]: number

Private loading_sgf

loading_sgf: boolean = false

Private Optional move_before_jump

move_before_jump?: MoveTree

move_tree

move_tree: MoveTree

move_tree_layout_dirty

move_tree_layout_dirty: boolean = false

move_tree_layout_hash

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

Type declaration

move_tree_layout_vector

move_tree_layout_vector: number[] = []

Readonly name

name: string = ""

Optional needs_sealing

needs_sealing?: JGOFSealingIntersection[]

Optional parentEventEmitter

parentEventEmitter?: EventEmitter<GobanEvents, any>

player

player: JGOFNumericPlayerColor

player_pool

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

Type declaration

players

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

Type declaration

puzzle_collection

puzzle_collection: number = NaN

puzzle_description

puzzle_description: string = "[missing puzzle description]"

puzzle_opponent_move_mode

puzzle_opponent_move_mode: PuzzleOpponentMoveMode = "manual"

puzzle_player_move_mode

puzzle_player_move_mode: PuzzlePlayerMoveMode = "free"

puzzle_rank

puzzle_rank: number = NaN

puzzle_type

puzzle_type: string = "[missing puzzle type]"

removal

removal: boolean[][]

Optional rengo

rengo?: boolean

rengo_casual_mode

rengo_casual_mode: boolean

Optional rengo_teams

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

Type declaration

Optional review_id

review_id?: number

score_handicap

score_handicap: boolean = false

score_prisoners

score_prisoners: boolean = false

score_stones

score_stones: boolean = false

score_territory

score_territory: boolean = false

score_territory_in_seki

score_territory_in_seki: boolean = false

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Private superko_algorithm

superko_algorithm: GobanEngineSuperKoAlgorithm = "psk"

territory_included_in_sgf

territory_included_in_sgf: boolean = false

Optional throw_all_errors

throw_all_errors?: boolean

time_control

time_control: JGOFTimeControl = ...

white_prisoners

white_prisoners: number

Readonly width

width: number = 19

Accessors

cur_move

cur_review_move

last_official_move

outcome

phase

rules

strict_seki_mode

undo_requested

winner

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

  • Returns undefined | number | "black" | "white"

  • set winner(winner): void

  • Parameters

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

    Returns void

Methods

boardEquals

Private captureGroup

clearRemoved

cloneBoard

cloneBoardState

colorNotToMove

colorToMove

computeInitialStateForForkedGame

  • computeInitialStateForForkedGame(): {
        black: string;
        white: string;
    }

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

    • black: string
    • white: string

computeScore

  • computeScore(only_prisoners?): Score

  • Computes the score of the current board state.

    +

Constructors

constructor

Properties

Private _cur_move

_cur_move: MoveTree

Private _cur_review_move

_cur_review_move: undefined | MoveTree

Private _last_official_move

_last_official_move: MoveTree

Private _outcome

_outcome: string = ""

Private _phase

_phase: GobanEnginePhase = "play"

Private _rules

_rules: GobanEngineRules = "japanese"

Private _strict_seki_mode

_strict_seki_mode: boolean = false

Private Optional _undo_requested

_undo_requested?: number

Private Optional _winner

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

Private aga_handicap_scoring

aga_handicap_scoring: boolean = false

Private allow_ko

allow_ko: boolean = false

Private allow_self_capture

allow_self_capture: boolean = false

Private allow_superko

allow_superko: boolean = false

automatic_stone_removal

automatic_stone_removal: boolean = false

black_prisoners

black_prisoners: number

board

board: JGOFNumericPlayerColor[][]

board_is_repeating

board_is_repeating: boolean

Readonly config

config: GobanEngineConfig

decoded_moves

decoded_moves: JGOFMove[] = []

Readonly disable_analysis

disable_analysis: boolean = false

Private dontStoreBoardHistory

dontStoreBoardHistory: boolean

free_handicap_placement

free_handicap_placement: boolean = false

game_id

game_id: number = NaN

Protected Optional goban_callback

goban_callback?: GobanBase

Optional group_ids

group_ids?: number[]

handicap

handicap: number = NaN

Optional handicap_rank_difference

handicap_rank_difference?: number

Readonly height

height: number = 19

initial_state

initial_state: GobanEngineInitialState = ...

Readonly is_game_record

is_game_record: boolean = false

komi

komi: number = NaN

Optional latencies

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

Type declaration

  • [player_id: string]: number

Private loading_sgf

loading_sgf: boolean = false

Private Optional move_before_jump

move_before_jump?: MoveTree

move_tree

move_tree: MoveTree

move_tree_layout_dirty

move_tree_layout_dirty: boolean = false

move_tree_layout_hash

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

Type declaration

move_tree_layout_vector

move_tree_layout_vector: number[] = []

Readonly name

name: string = ""

Optional needs_sealing

needs_sealing?: JGOFSealingIntersection[]

Optional parentEventEmitter

parentEventEmitter?: EventEmitter<GobanEvents, any>

player

player: JGOFNumericPlayerColor

player_pool

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

Type declaration

players

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

Type declaration

puzzle_collection

puzzle_collection: number = NaN

puzzle_description

puzzle_description: string = "[missing puzzle description]"

puzzle_opponent_move_mode

puzzle_opponent_move_mode: PuzzleOpponentMoveMode = "manual"

puzzle_player_move_mode

puzzle_player_move_mode: PuzzlePlayerMoveMode = "free"

puzzle_rank

puzzle_rank: number = NaN

puzzle_type

puzzle_type: string = "[missing puzzle type]"

removal

removal: boolean[][]

Optional rengo

rengo?: boolean

rengo_casual_mode

rengo_casual_mode: boolean

Optional rengo_teams

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

Type declaration

Optional review_id

review_id?: number

score_handicap

score_handicap: boolean = false

score_prisoners

score_prisoners: boolean = false

score_stones

score_stones: boolean = false

score_territory

score_territory: boolean = false

score_territory_in_seki

score_territory_in_seki: boolean = false

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Private superko_algorithm

superko_algorithm: GobanEngineSuperKoAlgorithm = "psk"

territory_included_in_sgf

territory_included_in_sgf: boolean = false

Optional throw_all_errors

throw_all_errors?: boolean

time_control

time_control: JGOFTimeControl = ...

white_prisoners

white_prisoners: number

Readonly width

width: number = 19

Accessors

cur_move

cur_review_move

last_official_move

outcome

phase

rules

strict_seki_mode

undo_requested

winner

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

  • Returns undefined | number | "black" | "white"

  • set winner(winner): void

  • Parameters

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

    Returns void

Methods

boardEquals

Private captureGroup

clearRemoved

cloneBoard

cloneBoardState

colorNotToMove

colorToMove

computeInitialStateForForkedGame

  • computeInitialStateForForkedGame(): {
        black: string;
        white: string;
    }

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

    • black: string
    • white: string

computeScore

  • computeScore(only_prisoners?): Score

  • Computes the score of the current board state.

    If only_prisoners is true, we return the same data structure for convenience, but only the prisoners will be counted, other sources of points will be zero.

    -

    Parameters

    • Optional only_prisoners: boolean

    Returns Score

computeScoringLocations

computeScoringLocations

countLiberties

currentPositionId

decodeMoves

countLiberties

currentPositionId

decodeMoves

decodePrettyCoordinates

decodePrettyCoordinates

  • decodePrettyCoordinates(coordinates): JGOFMove

  • Decodes a move string like "A11" into a move object like {x: 0, y: 10}. Also handles the special cases like ".." and "pass" which map to {x: -1, y: -1}.

    -

    Parameters

    • coordinates: string

    Returns JGOFMove

deleteCurMove

editPlace

emit

encodeMove

encodeMoves

estimateScore

exportAsPuzzle

followPath

  • followPath(from_turn, moves, cb?): MoveTree[]

  • Parameters

    • from_turn: number
    • moves: string | AdHocPackedMove
    • Optional cb: ((x, y, edited, color) => void)
        • (x, y, edited, color): void

        • Parameters

          • x: number
          • y: number
          • edited: boolean
          • color: number

          Returns void

    Returns MoveTree[]

foreachNeighbor

gameCanBeCancelled

getBlackPrisoners

getCurrentMoveNumber

getHandicapPointAdjustmentForWhite

getMoveByLocation

getMoveDiff

  • getMoveDiff(): {
        from: number;
        moves: string;
    }

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

    -

    Returns {
        from: number;
        moves: string;
    }

    • from: number
    • moves: string

getMoveNumber

getNeighboringRawStoneStrings

deleteCurMove

editPlace

emit

encodeMove

encodeMoves

estimateScore

exportAsPuzzle

followPath

  • followPath(from_turn, moves, cb?): MoveTree[]

  • Parameters

    • from_turn: number
    • moves: string | AdHocPackedMove
    • Optional cb: ((x, y, edited, color) => void)
        • (x, y, edited, color): void

        • Parameters

          • x: number
          • y: number
          • edited: boolean
          • color: number

          Returns void

    Returns MoveTree[]

foreachNeighbor

gameCanBeCancelled

getBlackPrisoners

getCurrentMoveNumber

getHandicapPointAdjustmentForWhite

getMoveByLocation

getMoveDiff

  • getMoveDiff(): {
        from: number;
        moves: string;
    }

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

    +

    Returns {
        from: number;
        moves: string;
    }

    • from: number
    • moves: string

getMoveNumber

getNeighboringRawStoneStrings

getRawStoneString

Private getState

getStoneRemovalString

getWhitePrisoners

handicapMovesLeft

initialStatePlace

isActivePlayer

isBoardRepeating

isLastOfficialMove

  • isLastOfficialMove(): boolean

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

    -

    Returns boolean

isParticipant

jumpTo

jumpToLastOfficialMove

jumpToOfficialMoveNumber

Private opponent

otherPlayer

Private parseSGF

place

getRawStoneString

Private getState

getStoneRemovalString

getWhitePrisoners

handicapMovesLeft

initialStatePlace

isActivePlayer

isBoardRepeating

isLastOfficialMove

  • isLastOfficialMove(): boolean

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

    +

    Returns boolean

isParticipant

jumpTo

jumpToLastOfficialMove

jumpToOfficialMoveNumber

Private opponent

otherPlayer

Private parseSGF

place

  • place(x, y, checkForKo?, errorOnSuperKo?, dontCheckForSuperKo?, dontCheckForSelfCapture?, isTrunkMove?, removed_stones?): number

  • Returns the number of stones removed. If you want the coordinates of the stones removed, pass in a removed_stones array to append the moves to.

    -

    Parameters

    • x: number
    • y: number
    • Optional checkForKo: boolean
    • Optional errorOnSuperKo: boolean
    • Optional dontCheckForSuperKo: boolean
    • Optional dontCheckForSelfCapture: boolean
    • Optional isTrunkMove: boolean
    • Optional removed_stones: JGOFIntersection[]

    Returns number

playerByColor

playerColor

  • playerColor(player_id?): "black" | "white" | "invalid"

  • Parameters

    • Optional player_id: number

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

playerNotToMove

playerToMove

playerToMoveOnOfficialBranch

prettyCoordinates

  • prettyCoordinates(x): string

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

    -

    Parameters

    Returns string

  • prettyCoordinates(x, y): string

  • Parameters

    • x: number
    • y: number

    Returns string

resetMoveTree

setAsCurrentReviewMove

setLastOfficialMove

  • setLastOfficialMove(): void

  • Saves our current move as our last official move

    -

    Returns void

setNeedsSealing

  • setNeedsSealing(x, y, needs_sealing?): void

  • Parameters

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

    Returns void

setRemoved

  • setRemoved(x, y, removed, emit_stone_removal_updated?): 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

playerByColor

playerColor

  • playerColor(player_id?): "black" | "white" | "invalid"

  • Parameters

    • Optional player_id: number

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

playerNotToMove

playerToMove

playerToMoveOnOfficialBranch

prettyCoordinates

  • prettyCoordinates(x): string

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

    +

    Parameters

    Returns string

  • prettyCoordinates(x, y): string

  • Parameters

    • x: number
    • y: number

    Returns string

resetMoveTree

setAsCurrentReviewMove

setLastOfficialMove

  • setLastOfficialMove(): void

  • Saves our current move as our last official move

    +

    Returns void

setNeedsSealing

  • setNeedsSealing(x, y, needs_sealing?): void

  • Parameters

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

    Returns void

setRemoved

  • setRemoved(x, y, removed, emit_stone_removal_updated?): void

  • Sets a position as being removed or not removed. If emit_stone_removal_updated is set to false, the "stone-removal.updated" event will not be emitted, and it is up to the caller to emit this event appropriately.

    -

    Parameters

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

    Returns void

Private setState

showNext

showNextTrunk

showPrevious

toggleSingleGroupRemoval

  • toggleSingleGroupRemoval(x, y, force_removal?): {
        group: RawStoneString;
        removed: boolean;
    }

  • Toggles a group of stones for removal or restoration.

    +

    Parameters

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

    Returns void

Private setState

showNext

showNextTrunk

showPrevious

toggleSingleGroupRemoval

  • toggleSingleGroupRemoval(x, y, force_removal?): {
        group: RawStoneString;
        removed: boolean;
    }

  • Toggles a group of stones for removal or restoration.

    By default, if we are marking a group for removal but the group is almost certainly alive (two eyes, etc), this will result in a no-op, unless force_removal is set to true.

    -

    Parameters

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

    Returns {
        group: RawStoneString;
        removed: boolean;
    }

updatePlayers

Static clearRuleSettings

Static fillDefaults

updatePlayers

Static clearRuleSettings

Static fillDefaults

Static Private migrateConfig

Static Private migrateConfig

Settings

Member Visibility

Theme

On This Page

constructor_cur_move_cur_review_move_last_official_move_outcome_phase_rules_strict_seki_mode_undo_requested_winneraga_handicap_scoringallow_koallow_self_captureallow_superkoautomatic_stone_removalblack_prisonersboardboard_is_repeatingconfigdecoded_movesdisable_analysisdontStoreBoardHistoryfree_handicap_placementgame_idgoban_callbackgroup_idshandicaphandicap_rank_differenceheightinitial_stateis_game_recordkomilatenciesloading_sgfmove_before_jumpmove_treemove_tree_layout_dirtymove_tree_layout_hashmove_tree_layout_vectornameneeds_sealingparentEventEmitterplayerplayer_poolplayerspuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typeremovalrengorengo_casual_moderengo_teamsreview_idscore_handicapscore_prisonersscore_stonesscore_territoryscore_territory_in_sekistalling_score_estimatesuperko_algorithmterritory_included_in_sgfthrow_all_errorstime_controlwhite_prisonerswidthcur_movecur_review_movelast_official_moveoutcomephaserulesstrict_seki_modeundo_requestedwinnerboardEqualscaptureGroupclearRemovedcloneBoardcloneBoardStatecolorNotToMovecolorToMovecomputeInitialStateForForkedGamecomputeScorecomputeScoringLocationscountLibertiescurrentPositionIddecodeMovesdecodePrettyCoordinatesdeleteCurMoveeditPlaceemitencodeMoveencodeMovesestimateScoreexportAsPuzzlefollowPathforeachNeighborgameCanBeCancelledgetBlackPrisonersgetCurrentMoveNumbergetHandicapPointAdjustmentForWhitegetMoveByLocationgetMoveDiffgetMoveNumbergetNeighboringRawStoneStringsgetRawStoneStringgetStategetStoneRemovalStringgetWhitePrisonershandicapMovesLeftinitialStatePlaceisActivePlayerisBoardRepeatingisLastOfficialMoveisParticipantjumpTojumpToLastOfficialMovejumpToOfficialMoveNumberopponentotherPlayerparseSGFplaceplayerByColorplayerColorplayerNotToMoveplayerToMoveplayerToMoveOnOfficialBranchprettyCoordinatesresetMoveTreesetAsCurrentReviewMovesetLastOfficialMovesetNeedsSealingsetRemovedsetStateshowNextshowNextTrunkshowPrevioustoggleSingleGroupRemovalupdatePlayersclearRuleSettingsfillDefaultsmigrateConfig
\ No newline at end of file +

Parameters

Returns GobanEngineConfig

Settings

Member Visibility

Theme

On This Page

constructor_cur_move_cur_review_move_last_official_move_outcome_phase_rules_strict_seki_mode_undo_requested_winneraga_handicap_scoringallow_koallow_self_captureallow_superkoautomatic_stone_removalblack_prisonersboardboard_is_repeatingconfigdecoded_movesdisable_analysisdontStoreBoardHistoryfree_handicap_placementgame_idgoban_callbackgroup_idshandicaphandicap_rank_differenceheightinitial_stateis_game_recordkomilatenciesloading_sgfmove_before_jumpmove_treemove_tree_layout_dirtymove_tree_layout_hashmove_tree_layout_vectornameneeds_sealingparentEventEmitterplayerplayer_poolplayerspuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typeremovalrengorengo_casual_moderengo_teamsreview_idscore_handicapscore_prisonersscore_stonesscore_territoryscore_territory_in_sekistalling_score_estimatesuperko_algorithmterritory_included_in_sgfthrow_all_errorstime_controlwhite_prisonerswidthcur_movecur_review_movelast_official_moveoutcomephaserulesstrict_seki_modeundo_requestedwinnerboardEqualscaptureGroupclearRemovedcloneBoardcloneBoardStatecolorNotToMovecolorToMovecomputeInitialStateForForkedGamecomputeScorecomputeScoringLocationscountLibertiescurrentPositionIddecodeMovesdecodePrettyCoordinatesdeleteCurMoveeditPlaceemitencodeMoveencodeMovesestimateScoreexportAsPuzzlefollowPathforeachNeighborgameCanBeCancelledgetBlackPrisonersgetCurrentMoveNumbergetHandicapPointAdjustmentForWhitegetMoveByLocationgetMoveDiffgetMoveNumbergetNeighboringRawStoneStringsgetRawStoneStringgetStategetStoneRemovalStringgetWhitePrisonershandicapMovesLeftinitialStatePlaceisActivePlayerisBoardRepeatingisLastOfficialMoveisParticipantjumpTojumpToLastOfficialMovejumpToOfficialMoveNumberopponentotherPlayerparseSGFplaceplayerByColorplayerColorplayerNotToMoveplayerToMoveplayerToMoveOnOfficialBranchprettyCoordinatesresetMoveTreesetAsCurrentReviewMovesetLastOfficialMovesetNeedsSealingsetRemovedsetStateshowNextshowNextTrunkshowPrevioustoggleSingleGroupRemovalupdatePlayersclearRuleSettingsfillDefaultsmigrateConfig
\ No newline at end of file diff --git a/docs/classes/GobanError.html b/docs/classes/GobanError.html index 6e0312b7..bb1b9a1e 100644 --- a/docs/classes/GobanError.html +++ b/docs/classes/GobanError.html @@ -1,2 +1,2 @@ -GobanError | goban

Class GobanError

Hierarchy (view full)

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file +GobanError | goban

Class GobanError

Hierarchy (view full)

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file diff --git a/docs/classes/GobanInteractive.html b/docs/classes/GobanInteractive.html index 9433b3d1..699b9f07 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

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

__board_redraw_pen_layer_timer __clock_timer? __draw_state @@ -209,23 +209,23 @@ getMoveTreeNumbering getSoundEnabled getSoundVolume -

Constructors

constructor

Properties

Protected __board_redraw_pen_layer_timer

__board_redraw_pen_layer_timer: any = null

Protected Optional __clock_timer

__clock_timer?: Timeout

Protected __draw_state

__draw_state: string[][]

Protected __last_pt

__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean

Protected __update_move_tree

__update_move_tree: any = null

Private _analyze_subtool

_analyze_subtool: string = "alternate"

Private _analyze_tool

_analyze_tool: AnalysisTool = "stone"

Private _mode

_mode: GobanModes = "play"

Private Optional _review_controller_id

_review_controller_id?: number

Private Optional _review_owner_id

_review_owner_id?: number

Private _score_estimator

_score_estimator: null | ScoreEstimator = null

Private Optional _submit_move

_submit_move?: (() => void)

Type declaration

    • (): void

    • Returns void

Private _title

_title: string = "play"

Protected analysis_move_counter

analysis_move_counter: number

Protected analysis_removal_last_position

analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected Optional analysis_removal_state

analysis_removal_state?: boolean

Protected bounded_height

bounded_height: number

Protected bounded_width

bounded_width: number

Protected bounds

bounds: GobanBounds

chat_log

chat_log: GobanChatLog = []

Protected circle_radius

circle_radius: number

clock_should_be_paused_for_move_submission

clock_should_be_paused_for_move_submission: boolean = false

Protected Optional colored_circles

colored_circles?: (undefined | ColoredCircle)[][]

Protected conditional_path

conditional_path: string = ""

conditional_starting_color

conditional_starting_color: "black" | "white" | "invalid" = "invalid"

conditional_tree

conditional_tree: ConditionalMoveTree = ...

config

config: GobanConfig

Protected Optional current_cmove

current_cmove?: ConditionalMoveTree

Protected currently_my_cmove

currently_my_cmove: boolean = false

Protected dirty_redraw

dirty_redraw: any = null

Protected disconnectedFromGame

disconnectedFromGame: boolean = true

Protected Optional display_width

display_width?: number

Protected done_loading_review

done_loading_review: boolean = false

Protected dont_draw_last_move

dont_draw_last_move: boolean

double_click_submit

double_click_submit: boolean

draw_bottom_labels

draw_bottom_labels: boolean

draw_left_labels

draw_left_labels: boolean

draw_right_labels

draw_right_labels: boolean

draw_top_labels

draw_top_labels: boolean

Protected Optional edit_color

edit_color?: "black" | "white"

Abstract engine

engine: GobanEngine

Protected errorHandler

errorHandler: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: Error

      Returns void

Readonly game_id

game_id: number

Protected game_type

game_type: string

Protected Optional getPuzzlePlacementSetting

getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

Type declaration

Readonly goban_id

goban_id: number = ++last_goban_id

Base fields *

-

Protected Optional heatmap

heatmap?: NumberMatrix

height

height: number

Protected highlight_movetree_moves

highlight_movetree_moves: boolean

Protected interactive

interactive: boolean

Protected isInPushedAnalysis

isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerController

isPlayerController: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerOwner

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected label_character

label_character: string

Protected label_mark

label_mark: string = "[UNSET]"

Optional last_clock

last_clock?: AdHocClock

Private last_emitted_captured_stones

last_emitted_captured_stones: JGOFIntersection[] = []

Optional last_emitted_clock

last_emitted_clock?: JGOFClockWithTransmitting

Protected Optional last_hover_square

last_hover_square?: JGOFIntersection

Protected Optional last_move

last_move?: MoveTree

Protected last_move_radius

last_move_radius: number

Protected last_paused_by_player_state

last_paused_by_player_state: null | boolean = null

Protected last_paused_state

last_paused_state: null | boolean = null

Protected Optional last_phase

last_phase?: GobanEnginePhase

Protected last_review_message

last_review_message: ReviewMessage

Protected Optional last_sound_played_for_a_stone_placement

last_sound_played_for_a_stone_placement?: string

Protected last_stone_sound

last_stone_sound: number

Protected leavePushedAnalysis

leavePushedAnalysis: (() => void)

Type declaration

    • (): void

    • Returns void

Protected Optional marked_analysis_score

marked_analysis_score?: boolean[][]

Protected Optional move_selected

move_selected?: JGOFIntersection

Protected no_display

no_display: boolean

Protected Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Protected on_game_screen

on_game_screen: boolean

one_click_submit

one_click_submit: boolean

Protected original_square_size

original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number

    • Parameters

      Returns number

Optional pause_control

pause_control?: AdHocPauseControl

Optional paused_since

paused_since?: number

pen_marks

pen_marks: any[]

Protected player_id

player_id: number

Protected Optional preloaded_data

preloaded_data?: GobanConfig

previous_mode

previous_mode: string

Protected puzzle_autoplace_delay

puzzle_autoplace_delay: number

Protected restrict_moves_to_movetree

restrict_moves_to_movetree: boolean

Protected review_had_gamedata

review_had_gamedata: boolean

Readonly review_id

review_id: number

Protected scoring_mode

scoring_mode: boolean | "stalling-scoring-mode"

Protected Optional sendLatencyTimer

sendLatencyTimer?: Timeout

Abstract sent_timed_out_message

sent_timed_out_message: boolean

Protected shift_key_is_down

shift_key_is_down: boolean

Protected show_move_numbers

show_move_numbers: boolean

Protected show_variation_move_numbers

show_variation_move_numbers: boolean

showing_scores

showing_scores: boolean = false

Protected square_size

square_size: number = 10

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Protected stone_placement_enabled

stone_placement_enabled: boolean

Protected Optional stone_removal_auto_scoring_done

stone_removal_auto_scoring_done?: boolean = false

variation_stone_opacity

variation_stone_opacity: number

visual_undo_request_indicator

visual_undo_request_indicator: boolean

width

width: number

Static setCallbacks

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

Type declaration

    • (newCallbacks): void

    • Set's callback functions to be called in various situations. You can set any +

Constructors

constructor

Properties

Protected __board_redraw_pen_layer_timer

__board_redraw_pen_layer_timer: any = null

Protected Optional __clock_timer

__clock_timer?: Timeout

Protected __draw_state

__draw_state: string[][]

Protected __last_pt

__last_pt: {
    i: number;
    j: number;
    valid: boolean;
} = ...

Type declaration

  • i: number
  • j: number
  • valid: boolean

Protected __update_move_tree

__update_move_tree: any = null

Private _analyze_subtool

_analyze_subtool: string = "alternate"

Private _analyze_tool

_analyze_tool: AnalysisTool = "stone"

Private _mode

_mode: GobanModes = "play"

Private Optional _review_controller_id

_review_controller_id?: number

Private Optional _review_owner_id

_review_owner_id?: number

Private _score_estimator

_score_estimator: null | ScoreEstimator = null

Private Optional _submit_move

_submit_move?: (() => void)

Type declaration

    • (): void

    • Returns void

Private _title

_title: string = "play"

Protected analysis_move_counter

analysis_move_counter: number

Protected analysis_removal_last_position

analysis_removal_last_position: {
    i: number;
    j: number;
} = ...

Type declaration

  • i: number
  • j: number

Protected Optional analysis_removal_state

analysis_removal_state?: boolean

Protected bounded_height

bounded_height: number

Protected bounded_width

bounded_width: number

Protected bounds

bounds: GobanBounds

chat_log

chat_log: GobanChatLog = []

Protected circle_radius

circle_radius: number

clock_should_be_paused_for_move_submission

clock_should_be_paused_for_move_submission: boolean = false

Protected Optional colored_circles

colored_circles?: (undefined | ColoredCircle)[][]

Protected conditional_path

conditional_path: string = ""

conditional_starting_color

conditional_starting_color: "black" | "white" | "invalid" = "invalid"

conditional_tree

conditional_tree: ConditionalMoveTree = ...

config

config: GobanConfig

Protected Optional current_cmove

current_cmove?: ConditionalMoveTree

Protected currently_my_cmove

currently_my_cmove: boolean = false

Protected dirty_redraw

dirty_redraw: any = null

Protected disconnectedFromGame

disconnectedFromGame: boolean = true

Protected Optional display_width

display_width?: number

Protected done_loading_review

done_loading_review: boolean = false

Protected dont_draw_last_move

dont_draw_last_move: boolean

double_click_submit

double_click_submit: boolean

draw_bottom_labels

draw_bottom_labels: boolean

draw_left_labels

draw_left_labels: boolean

draw_right_labels

draw_right_labels: boolean

draw_top_labels

draw_top_labels: boolean

Protected Optional edit_color

edit_color?: "black" | "white"

Abstract engine

engine: GobanEngine

Protected errorHandler

errorHandler: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: Error

      Returns void

Readonly game_id

game_id: number

Protected game_type

game_type: string

Protected Optional getPuzzlePlacementSetting

getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

Type declaration

Readonly goban_id

goban_id: number = ++last_goban_id

Base fields *

+

Protected Optional heatmap

heatmap?: NumberMatrix

height

height: number

Protected highlight_movetree_moves

highlight_movetree_moves: boolean

Protected interactive

interactive: boolean

Protected isInPushedAnalysis

isInPushedAnalysis: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerController

isPlayerController: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected isPlayerOwner

isPlayerOwner: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Protected label_character

label_character: string

Protected label_mark

label_mark: string = "[UNSET]"

Optional last_clock

last_clock?: AdHocClock

Private last_emitted_captured_stones

last_emitted_captured_stones: JGOFIntersection[] = []

Optional last_emitted_clock

last_emitted_clock?: JGOFClockWithTransmitting

Protected Optional last_hover_square

last_hover_square?: JGOFIntersection

Protected Optional last_move

last_move?: MoveTree

Protected last_move_radius

last_move_radius: number

Protected last_paused_by_player_state

last_paused_by_player_state: null | boolean = null

Protected last_paused_state

last_paused_state: null | boolean = null

Protected Optional last_phase

last_phase?: GobanEnginePhase

Protected last_review_message

last_review_message: ReviewMessage

Protected Optional last_sound_played_for_a_stone_placement

last_sound_played_for_a_stone_placement?: string

Protected last_stone_sound

last_stone_sound: number

Protected leavePushedAnalysis

leavePushedAnalysis: (() => void)

Type declaration

    • (): void

    • Returns void

Protected Optional marked_analysis_score

marked_analysis_score?: boolean[][]

Protected Optional move_selected

move_selected?: JGOFIntersection

Protected no_display

no_display: boolean

Protected Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Protected on_game_screen

on_game_screen: boolean

one_click_submit

one_click_submit: boolean

Protected original_square_size

original_square_size: number | ((goban) => number) | "auto"

Type declaration

    • (goban): number

    • Parameters

      Returns number

Optional pause_control

pause_control?: AdHocPauseControl

Optional paused_since

paused_since?: number

pen_marks

pen_marks: any[]

Protected player_id

player_id: number

Protected Optional preloaded_data

preloaded_data?: GobanConfig

previous_mode

previous_mode: string

Protected puzzle_autoplace_delay

puzzle_autoplace_delay: number

Protected restrict_moves_to_movetree

restrict_moves_to_movetree: boolean

Protected review_had_gamedata

review_had_gamedata: boolean

Readonly review_id

review_id: number

Protected scoring_mode

scoring_mode: boolean | "stalling-scoring-mode"

Protected Optional sendLatencyTimer

sendLatencyTimer?: Timeout

Abstract sent_timed_out_message

sent_timed_out_message: boolean

Protected shift_key_is_down

shift_key_is_down: boolean

Protected show_move_numbers

show_move_numbers: boolean

Protected show_variation_move_numbers

show_variation_move_numbers: boolean

showing_scores

showing_scores: boolean = false

Protected square_size

square_size: number = 10

Optional stalling_score_estimate

stalling_score_estimate?: StallingScoreEstimate

Protected stone_placement_enabled

stone_placement_enabled: boolean

Protected Optional stone_removal_auto_scoring_done

stone_removal_auto_scoring_done?: boolean = false

variation_stone_opacity

variation_stone_opacity: number

visual_undo_request_indicator

visual_undo_request_indicator: boolean

width

width: number

Static setCallbacks

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

Static setTranslations

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

Type declaration

    • (_catalog, _debug_mode?): void

    • Parameters

      Returns void

Accessors

analyze_subtool

analyze_tool

destroyed

  • get destroyed(): boolean

  • Returns boolean

is_game_record

  • get is_game_record(): boolean

  • True if the game is a game record of a real life game

    -

    Returns boolean

mode

review_controller_id

review_owner_id

score_estimator

submit_move

title

Methods

Abstract clearAnalysisDrawing

clearMark

Abstract clearMessage

Protected clearTransientMark

debouncedEmitCapturedStones

decodeMoves

  • decodeMoves(move_obj): JGOFMove[]

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

    Parameters

    Returns void

Static setTranslations

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

Type declaration

    • (_catalog, _debug_mode?): void

    • Parameters

      Returns void

Accessors

analyze_subtool

analyze_tool

destroyed

  • get destroyed(): boolean

  • Returns boolean

is_game_record

  • get is_game_record(): boolean

  • True if the game is a game record of a real life game

    +

    Returns boolean

mode

review_controller_id

review_owner_id

score_estimator

submit_move

title

Methods

Abstract clearAnalysisDrawing

clearMark

Abstract clearMessage

Protected clearTransientMark

debouncedEmitCapturedStones

decodeMoves

decodePrettyCoordinates

decodePrettyCoordinates

  • decodePrettyCoordinates(coordinates): JGOFMove

  • Decodes a move string like "A11" into a move object like {x: 0, y: 10}. Also handles the special cases like ".." and "pass" which map to {x: -1, y: -1}.

    -

    Parameters

    • coordinates: string

    Returns JGOFMove

Protected defaultConfig

deleteConditionalPath

Private deleteConditionalSegment

deleteCustomMark

  • deleteCustomMark(x, y, mark, drawSquare?): void

  • Parameters

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

    Returns void

destroy

Protected Abstract disableDrawing

Abstract disablePen

disableStonePlacement

Abstract drawPenMarks

Abstract drawSquare

editPlaceByPrettyCoordinates

Protected Abstract enableDrawing

Abstract enablePen

enableStonePlacement

encodeMove

encodeMoves

followConditionalPath

Protected followConditionalSegment

Protected getCoordinateDisplaySystem

getCurrentConditionalPath

Protected getLocation

getMarks

Protected getShowMoveNumbers

Protected getShowVariationMoveNumbers

Protected getWidthForSquareSize

hideScores

Protected incrementLabelCharacter

isAnalysisDisabled

  • isAnalysisDisabled(perGameSettingAppliesToNonPlayers?): boolean

  • Parameters

    • perGameSettingAppliesToNonPlayers: boolean = false

    Returns boolean

isCurrentUserAPlayer

Protected isLastOfficialMove

jumpToLastOfficialMove

load

markDirty

Abstract move_tree_redraw

nextSibling

placeByPrettyCoordinates

Protected playMovementSound

Protected post_config_constructor

Protected defaultConfig

deleteConditionalPath

Private deleteConditionalSegment

deleteCustomMark

  • deleteCustomMark(x, y, mark, drawSquare?): void

  • Parameters

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

    Returns void

destroy

Protected Abstract disableDrawing

Abstract disablePen

disableStonePlacement

Abstract drawPenMarks

Abstract drawSquare

editPlaceByPrettyCoordinates

Protected Abstract enableDrawing

Abstract enablePen

enableStonePlacement

encodeMove

encodeMoves

followConditionalPath

Protected followConditionalSegment

Protected getCoordinateDisplaySystem

getCurrentConditionalPath

Protected getLocation

getMarks

Protected getShowMoveNumbers

Protected getShowVariationMoveNumbers

Protected getWidthForSquareSize

hideScores

Protected incrementLabelCharacter

isAnalysisDisabled

  • isAnalysisDisabled(perGameSettingAppliesToNonPlayers?): boolean

  • Parameters

    • perGameSettingAppliesToNonPlayers: boolean = false

    Returns boolean

isCurrentUserAPlayer

Protected isLastOfficialMove

jumpToLastOfficialMove

load

markDirty

Abstract move_tree_redraw

nextSibling

placeByPrettyCoordinates

Protected playMovementSound

Protected post_config_constructor

  • post_config_constructor(): GobanEngine

  • 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

prettyCoordinates

prevSibling

Abstract redraw

Protected scheduleRedrawPenLayer

Protected Abstract sendMove

Abstract sendTimedOut

set

setAnalyzeTool

setBounds

setColoredCircles

setColoredMarks

  • setColoredMarks(colored_marks): void

  • Parameters

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

    Returns void

setConditionalTree

setCustomMark

  • setCustomMark(x, y, mark, drawSquare?): void

  • Parameters

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

    Returns void

setEditColor

setForRemoval

  • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

setHeatmap

setLabelCharacter

Protected setLabelCharacterFromMarks

  • setLabelCharacterFromMarks(set_override?): void

  • Parameters

    • Optional set_override: "letters" | "numbers"

    Returns void

Protected setLastOfficialMove

Protected setLetterMark

  • setLetterMark(x, y, mark, drawSquare?): void

  • Parameters

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

    Returns void

setMark

  • setMark(x, y, mark, dont_draw?): void

  • Parameters

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

    Returns void

setMarkByPrettyCoordinates

  • setMarkByPrettyCoordinates(coordinates, mark, dont_draw?): void

  • Parameters

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

    Returns void

Protected setMarkColor

setMarks

prettyCoordinates

prevSibling

Abstract redraw

Protected scheduleRedrawPenLayer

Protected Abstract sendMove

Abstract sendTimedOut

set

setAnalyzeTool

setBounds

setColoredCircles

setColoredMarks

  • setColoredMarks(colored_marks): void

  • Parameters

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

    Returns void

setConditionalTree

setCustomMark

  • setCustomMark(x, y, mark, drawSquare?): void

  • Parameters

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

    Returns void

setEditColor

setForRemoval

  • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

setHeatmap

setLabelCharacter

Protected setLabelCharacterFromMarks

  • setLabelCharacterFromMarks(set_override?): void

  • Parameters

    • Optional set_override: "letters" | "numbers"

    Returns void

Protected setLastOfficialMove

Protected setLetterMark

  • setLetterMark(x, y, mark, drawSquare?): void

  • Parameters

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

    Returns void

setMark

  • setMark(x, y, mark, dont_draw?): void

  • Parameters

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

    Returns void

setMarkByPrettyCoordinates

  • setMarkByPrettyCoordinates(coordinates, mark, dont_draw?): void

  • Parameters

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

    Returns void

Protected setMarkColor

setMarks

  • setMarks(marks, dont_draw?): 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

setMode

setModeDeferred

Abstract setMoveTreeContainer

setScoringMode

Abstract setState

Protected setSubmit

setSubscriptMark

  • setSubscriptMark(x, y, mark, drawSquare?): void

  • Parameters

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

    Returns void

Protected Abstract setTitle

setToPreviousMode

  • setToPreviousMode(dont_jump_to_official_move?): boolean

  • Parameters

    • Optional dont_jump_to_official_move: boolean

    Returns boolean

Protected setTransientMark

  • setTransientMark(x, y, mark, dont_draw?): void

  • Parameters

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

    Returns void

showFirst

Abstract showMessage

  • showMessage(msg_id, parameters?, timeout?): void

  • Parameters

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

    Returns void

showNext

showPrevious

showScores

showStallingScoreEstimate

Protected toggleMark

  • toggleMark(x, y, mark, force_label?, force_put?): boolean

  • Parameters

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

    Returns boolean

Protected updateMoveTree

Protected updateOrRedrawMoveTree

updatePlayerToMoveTitle

updateScoreEstimation

updateTitleAndStonePlacement

Protected xy2ij

  • xy2ij(x, y, anti_slip?): {
        i: number;
        j: number;
        valid: boolean;
    }

  • Parameters

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

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

    • i: number
    • j: number
    • valid: boolean

Static getCDNReleaseBase

Static getMoveTreeNumbering

Static getSoundEnabled

Static getSoundVolume

Settings

Member Visibility

Theme

On This Page

constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__update_move_tree_analyze_subtool_analyze_tool_mode_review_controller_id_review_owner_id_score_estimator_submit_move_titleanalysis_move_counteranalysis_removal_last_positionanalysis_removal_statebounded_heightbounded_widthboundschat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigcurrent_cmovecurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsedit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklast_clocklast_emitted_captured_stoneslast_emitted_clocklast_hover_squarelast_movelast_move_radiuslast_paused_by_player_statelast_paused_statelast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremove_selectedno_displayonErroron_game_screenone_click_submitoriginal_square_sizepause_controlpaused_sincepen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donevariation_stone_opacityvisual_undo_request_indicatorwidthsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitleclearAnalysisDrawingclearMarkclearMessageclearTransientMarkdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteConditionalPathdeleteConditionalSegmentdeleteCustomMarkdestroydisableDrawingdisablePendisableStonePlacementdrawPenMarksdrawSquareeditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetCoordinateDisplaySystemgetCurrentConditionalPathgetLocationgetMarksgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizehideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkDirtymove_tree_redrawnextSiblingplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingredrawscheduleRedrawPenLayersendMovesendTimedOutsetsetAnalyzeToolsetBoundssetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLastOfficialMovesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetScoringModesetStatesetSubmitsetSubscriptMarksetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementxy2ijgetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
\ No newline at end of file +

Parameters

Returns void

setMode

setModeDeferred

Abstract setMoveTreeContainer

setScoringMode

Abstract setState

Protected setSubmit

setSubscriptMark

Protected Abstract setTitle

setToPreviousMode

Protected setTransientMark

showFirst

Abstract showMessage

showNext

showPrevious

showScores

showStallingScoreEstimate

Protected toggleMark

Protected updateMoveTree

Protected updateOrRedrawMoveTree

updatePlayerToMoveTitle

updateScoreEstimation

updateTitleAndStonePlacement

Protected xy2ij

Static getCDNReleaseBase

Static getMoveTreeNumbering

Static getSoundEnabled

Static getSoundVolume

Settings

Member Visibility

Theme

On This Page

constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__update_move_tree_analyze_subtool_analyze_tool_mode_review_controller_id_review_owner_id_score_estimator_submit_move_titleanalysis_move_counteranalysis_removal_last_positionanalysis_removal_statebounded_heightbounded_widthboundschat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigcurrent_cmovecurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsedit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklast_clocklast_emitted_captured_stoneslast_emitted_clocklast_hover_squarelast_movelast_move_radiuslast_paused_by_player_statelast_paused_statelast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremove_selectedno_displayonErroron_game_screenone_click_submitoriginal_square_sizepause_controlpaused_sincepen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donevariation_stone_opacityvisual_undo_request_indicatorwidthsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitleclearAnalysisDrawingclearMarkclearMessageclearTransientMarkdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteConditionalPathdeleteConditionalSegmentdeleteCustomMarkdestroydisableDrawingdisablePendisableStonePlacementdrawPenMarksdrawSquareeditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetCoordinateDisplaySystemgetCurrentConditionalPathgetLocationgetMarksgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizehideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkDirtymove_tree_redrawnextSiblingplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingredrawscheduleRedrawPenLayersendMovesendTimedOutsetsetAnalyzeToolsetBoundssetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLastOfficialMovesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetScoringModesetStatesetSubmitsetSubscriptMarksetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementxy2ijgetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
\ No newline at end of file diff --git a/docs/classes/GobanMoveError.html b/docs/classes/GobanMoveError.html index b20e265d..21394c66 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

constructor

Properties

coords game_id message_id move_number -

Constructors

constructor

Properties

coords

coords: string

game_id

game_id: number

message_id

message_id: GobanMoveErrorMessageId

move_number

move_number: number

Settings

Member Visibility

Theme

On This Page

constructorcoordsgame_idmessage_idmove_number
\ No newline at end of file +

Constructors

constructor

Properties

coords

coords: string

game_id

game_id: number

message_id

message_id: GobanMoveErrorMessageId

move_number

move_number: number

Settings

Member Visibility

Theme

On This Page

constructorcoordsgame_idmessage_idmove_number
\ No newline at end of file diff --git a/docs/classes/GobanSocket.html b/docs/classes/GobanSocket.html index 60ac1107..9600caac 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

    constructor +

    Type Parameters

    Hierarchy

    Constructors

    constructor

    Properties

    authentication? callbacks clock_drift @@ -37,4 +37,4 @@ sendPromise signalTimeout startPing -

    Constructors

    constructor

    Properties

    Private Optional authentication

    authentication?: DataArgument<SendProtocol["authenticate"]>

    Private callbacks

    callbacks: Map<number, ((data?, error?) => void)> = ...

    Type declaration

      • (data?, error?): void

      • Parameters

        Returns void

    clock_drift

    clock_drift: number = 0.0

    Private current_ping_interval

    current_ping_interval: number

    Private last_request_id

    last_request_id: number = 0

    latency

    latency: number = 0.0

    Private manually_disconnected

    manually_disconnected: boolean = false

    options

    options: GobanSocketOptions

    Private Optional ping_timer

    ping_timer?: Timeout

    Private promises_in_flight

    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

    Private reconnect_tries

    reconnect_tries: number = 0

    Private reconnecting

    reconnecting: boolean = false

    Private send_queue

    send_queue: (() => void)[] = []

    Type declaration

      • (): void

      • Returns void

    Private socket

    socket: WebSocket

    Private Optional timeout_timer

    timeout_timer?: Timeout

    Readonly url

    url: string

    Accessors

    connected

    Methods

    authenticate

    Private connect

    disconnect

    ping

    Private reconnect

    Private rejectPromisesInFlight

    send

    Private sendAuthentication

    sendPromise

    signalTimeout

    Private startPing

    Settings

    Member Visibility

    Theme

    On This Page

    constructorauthenticationcallbacksclock_driftcurrent_ping_intervallast_request_idlatencymanually_disconnectedoptionsping_timerpromises_in_flightreconnect_triesreconnectingsend_queuesockettimeout_timerurlconnectedauthenticateconnectdisconnectpingreconnectrejectPromisesInFlightsendsendAuthenticationsendPromisesignalTimeoutstartPing
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional authentication

    authentication?: DataArgument<SendProtocol["authenticate"]>

    Private callbacks

    callbacks: Map<number, ((data?, error?) => void)> = ...

    Type declaration

      • (data?, error?): void

      • Parameters

        Returns void

    clock_drift

    clock_drift: number = 0.0

    Private current_ping_interval

    current_ping_interval: number

    Private last_request_id

    last_request_id: number = 0

    latency

    latency: number = 0.0

    Private manually_disconnected

    manually_disconnected: boolean = false

    options

    options: GobanSocketOptions

    Private Optional ping_timer

    ping_timer?: Timeout

    Private promises_in_flight

    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

    Private reconnect_tries

    reconnect_tries: number = 0

    Private reconnecting

    reconnecting: boolean = false

    Private send_queue

    send_queue: (() => void)[] = []

    Type declaration

      • (): void

      • Returns void

    Private socket

    socket: WebSocket

    Private Optional timeout_timer

    timeout_timer?: Timeout

    Readonly url

    url: string

    Accessors

    connected

    Methods

    authenticate

    Private connect

    disconnect

    ping

    Private reconnect

    Private rejectPromisesInFlight

    send

    Private sendAuthentication

    sendPromise

    signalTimeout

    Private startPing

    Settings

    Member Visibility

    Theme

    On This Page

    constructorauthenticationcallbacksclock_driftcurrent_ping_intervallast_request_idlatencymanually_disconnectedoptionsping_timerpromises_in_flightreconnect_triesreconnectingsend_queuesockettimeout_timerurlconnectedauthenticateconnectdisconnectpingreconnectrejectPromisesInFlightsendsendAuthenticationsendPromisesignalTimeoutstartPing
    \ No newline at end of file diff --git a/docs/classes/GobanTheme.html b/docs/classes/GobanTheme.html index 58606422..00d0e8c2 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

    constructor

    Properties

    name parent? styles @@ -31,5 +31,5 @@ renderSVG sort stoneCastsShadow -

    Constructors

    constructor

    Properties

    name

    name: string

    Protected Optional parent

    parent?: GobanTheme

    styles

    styles: {
        [style_name: string]: string;
    } = {}

    Type declaration

    • [style_name: string]: string

    Accessors

    theme_name

    Methods

    def_uid

    getBackgroundCSS

    getBlackStoneColor

    getBlackTextColor

    getBlankTextColor

    getFadedLineColor

    getFadedStarColor

    getLabelTextColor

    getLineColor

    getReactStyles

    getStarColor

    getStone

    getStoneHash

    getWhiteStoneColor

    getWhiteTextColor

    placeBlackStone

    • placeBlackStone(ctx, _shadow_ctx, _stone, cx, cy, radius): void

    • Parameters

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

      Returns void

    placeBlackStoneSVG

    • placeBlackStoneSVG(cell, shadow_cell, stone, cx, cy, radius): [SVGElement, undefined | SVGElement]

    • Parameters

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

      Returns [SVGElement, undefined | SVGElement]

    Private placeStoneSVG

    • placeStoneSVG(cell, shadow_cell, stone, cx, cy, radius, shadow_circle_color): [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]

    placeStoneShadowSVG

    • placeStoneShadowSVG(shadow_cell, cx, cy, radius, color): undefined | SVGElement

    • Parameters

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

      Returns undefined | SVGElement

    placeWhiteStone

    • placeWhiteStone(ctx, _shadow_ctx, _stone, cx, cy, radius): void

    • Parameters

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

      Returns void

    placeWhiteStoneSVG

    • placeWhiteStoneSVG(cell, shadow_cell, stone, cx, cy, radius): [SVGElement, undefined | SVGElement]

    • Parameters

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

      Returns [SVGElement, undefined | SVGElement]

    preRenderBlack

    • preRenderBlack(_radius, _seed, _deferredRenderCallback): any

    • Parameters

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

          • Returns void

      Returns any

    preRenderBlackSVG

    • preRenderBlackSVG(defs, radius, _seed, _deferredRenderCallback): string[]

    • Parameters

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

          • Returns void

      Returns string[]

    preRenderWhite

    • preRenderWhite(_radius, _seed, _deferredRenderCallback): any

    • Parameters

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

          • Returns void

      Returns any

    preRenderWhiteSVG

    • preRenderWhiteSVG(defs, radius, _seed, _deferredRenderCallback): string[]

    • Parameters

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

          • Returns void

      Returns string[]

    renderSVG

    sort

    stoneCastsShadow

    Settings

    Member Visibility

    Theme

    On This Page

    constructornameparentstylestheme_namedef_uidgetBackgroundCSSgetBlackStoneColorgetBlackTextColorgetBlankTextColorgetFadedLineColorgetFadedStarColorgetLabelTextColorgetLineColorgetReactStylesgetStarColorgetStonegetStoneHashgetWhiteStoneColorgetWhiteTextColorplaceBlackStoneplaceBlackStoneSVGplaceStoneSVGplaceStoneShadowSVGplaceWhiteStoneplaceWhiteStoneSVGpreRenderBlackpreRenderBlackSVGpreRenderWhitepreRenderWhiteSVGrenderSVGsortstoneCastsShadow
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    name

    name: string

    Protected Optional parent

    parent?: GobanTheme

    styles

    styles: {
        [style_name: string]: string;
    } = {}

    Type declaration

    • [style_name: string]: string

    Accessors

    theme_name

    Methods

    def_uid

    getBackgroundCSS

    getBlackStoneColor

    getBlackTextColor

    getBlankTextColor

    getFadedLineColor

    getFadedStarColor

    getLabelTextColor

    getLineColor

    getReactStyles

    getStarColor

    getStone

    getStoneHash

    getWhiteStoneColor

    getWhiteTextColor

    placeBlackStone

    • placeBlackStone(ctx, _shadow_ctx, _stone, cx, cy, radius): void

    • Parameters

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

      Returns void

    placeBlackStoneSVG

    • placeBlackStoneSVG(cell, shadow_cell, stone, cx, cy, radius): [SVGElement, undefined | SVGElement]

    • Parameters

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

      Returns [SVGElement, undefined | SVGElement]

    Private placeStoneSVG

    • placeStoneSVG(cell, shadow_cell, stone, cx, cy, radius, shadow_circle_color): [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]

    placeStoneShadowSVG

    • placeStoneShadowSVG(shadow_cell, cx, cy, radius, color): undefined | SVGElement

    • Parameters

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

      Returns undefined | SVGElement

    placeWhiteStone

    • placeWhiteStone(ctx, _shadow_ctx, _stone, cx, cy, radius): void

    • Parameters

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

      Returns void

    placeWhiteStoneSVG

    • placeWhiteStoneSVG(cell, shadow_cell, stone, cx, cy, radius): [SVGElement, undefined | SVGElement]

    • Parameters

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

      Returns [SVGElement, undefined | SVGElement]

    preRenderBlack

    • preRenderBlack(_radius, _seed, _deferredRenderCallback): any

    • Parameters

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

          • Returns void

      Returns any

    preRenderBlackSVG

    • preRenderBlackSVG(defs, radius, _seed, _deferredRenderCallback): string[]

    • Parameters

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

          • Returns void

      Returns string[]

    preRenderWhite

    • preRenderWhite(_radius, _seed, _deferredRenderCallback): any

    • Parameters

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

          • Returns void

      Returns any

    preRenderWhiteSVG

    • preRenderWhiteSVG(defs, radius, _seed, _deferredRenderCallback): string[]

    • Parameters

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

          • Returns void

      Returns string[]

    renderSVG

    sort

    stoneCastsShadow

    Settings

    Member Visibility

    Theme

    On This Page

    constructornameparentstylestheme_namedef_uidgetBackgroundCSSgetBlackStoneColorgetBlackTextColorgetBlankTextColorgetFadedLineColorgetFadedStarColorgetLabelTextColorgetLineColorgetReactStylesgetStarColorgetStonegetStoneHashgetWhiteStoneColorgetWhiteTextColorplaceBlackStoneplaceBlackStoneSVGplaceStoneSVGplaceStoneShadowSVGplaceWhiteStoneplaceWhiteStoneSVGpreRenderBlackpreRenderBlackSVGpreRenderWhitepreRenderWhiteSVGrenderSVGsortstoneCastsShadow
    \ No newline at end of file diff --git a/docs/classes/MoveTree.html b/docs/classes/MoveTree.html index 11234a49..78f278f8 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

    constructor

    Properties

    active_path_number branches chat_log? @@ -94,13 +94,13 @@ markupSGFChat markupSGFChatMessage markupSGFChatWithoutNode -

    Constructors

    constructor

    Properties

    active_path_number

    active_path_number: number = 0

    branches

    branches: MoveTree[]

    Private Optional chat_log

    chat_log?: MoveTreeChatLine[]

    correct_answer

    correct_answer: boolean = false

    edited

    edited: boolean

    Private Readonly engine

    engine: GobanEngine

    Private Optional hint_next

    hint_next?: MoveTree

    Readonly id

    id: number

    Private Optional isobranch_hash

    isobranch_hash?: string

    isobranches

    isobranches: any

    label

    label: string = "[unset]"

    Optional label_metrics

    label_metrics?: any

    layout_cx

    layout_cx: number = 0

    layout_cy

    layout_cy: number = 0

    layout_x

    layout_x: number = 0

    layout_y

    layout_y: number = 0

    line_color

    line_color: number

    Private Optional marks

    marks?: MarkInterface[][]

    move_number

    move_number: number

    parent

    parent: null | MoveTree

    pen_marks

    pen_marks: MoveTreePenMarks = []

    played_by

    played_by: undefined | number

    player

    player: JGOFNumericPlayerColor

    player_update

    player_update: undefined | JGOFPlayerSummary

    Readonly pretty_coordinates

    pretty_coordinates: string

    Private stashed_marks

    stashed_marks: MarkInterface[][][] = []

    state

    state: BoardStateWithIsobranchHash

    text

    text: string

    trunk

    trunk: boolean

    Optional trunk_next

    trunk_next?: MoveTree

    wrong_answer

    wrong_answer: boolean = false

    x

    x: number

    y

    y: number

    Static active_path_number

    active_path_number: number = 0

    ** Layout & Rendering ***

    -

    Static current_line_color

    current_line_color: number = 0

    Static isobranch_colors

    isobranch_colors: {
        strong: string;
        weak: string;
    } = ...

    Type declaration

    • strong: string
    • weak: string

    Static line_colors

    line_colors: string[] = ...

    Static Readonly stone_padding

    stone_padding: 3 = 3

    Static Readonly stone_radius

    stone_radius: 11 = 11

    Static Readonly stone_square_size

    stone_square_size: number = ...

    Accessors

    stoneColor

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

    • Returns "black" | "white" | "empty"

    Methods

    clearBranchesExceptFor

    clearMarks

    containsOtherTreeAsChild

    containsOtherTreeAsSubset

    debug

    findBranchesWithCorrectAnswer

    findChildWhich

    findStrongIsobranches

    fold

    foreachMarkedPosition

    • foreachMarkedPosition(fn): void

    • 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

    getAllMarks

    getBranchPoint

    getChatLog

    getDistance

    getMarks

    getMoveIndex

    getMoveNumberDifferenceFromTrunk

    getMoveStringToThisPoint

    getNodeAtLayoutPosition

    getPositionInParent

    getRoot

    hasAllChildrenOf

    hasMarks

    • hasMarks(): boolean

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

      -

      Returns boolean

    hasTheSameRootMoveAs

    hoistFirstBranchToTrunk

    index

    is

    isAncestorOf

    Private isBranchWithCorrectAnswer

    layout

    • layout(x, min_y, layout_hash, line_color): number

    • Parameters

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

      Returns number

    loadJsonForThisNode

    • loadJsonForThisNode(json): void

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

      -

      Parameters

      Returns void

    lookupMove

    move

    next

    nextSibling

    passed

    popStashedMarks

    prev

    prevSibling

    recomputeIsobranches

    • recomputeIsobranches(): void

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

      -

      Returns void

    remove

    removeIfNoChildren

    setActivePath

    setAllMarks

    size

    stashMarks

    • stashMarks(): void

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

      -

      Returns void

    toJson

    toSGF

    traverse

    Static escapedSGFChat

    Static fmtUsername

    Static markupSGFChat

    Static markupSGFChatMessage

    Static markupSGFChatWithoutNode

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractive_path_numberbrancheschat_logcorrect_answereditedenginehint_nextidisobranch_hashisobrancheslabellabel_metricslayout_cxlayout_cylayout_xlayout_yline_colormarksmove_numberparentpen_marksplayed_byplayerplayer_updatepretty_coordinatesstashed_marksstatetexttrunktrunk_nextwrong_answerxyactive_path_numbercurrent_line_colorisobranch_colorsline_colorsstone_paddingstone_radiusstone_square_sizestoneColorclearBranchesExceptForclearMarkscontainsOtherTreeAsChildcontainsOtherTreeAsSubsetdebugfindBranchesWithCorrectAnswerfindChildWhichfindStrongIsobranchesfoldforeachMarkedPositiongetAllMarksgetBranchPointgetChatLoggetDistancegetMarksgetMoveIndexgetMoveNumberDifferenceFromTrunkgetMoveStringToThisPointgetNodeAtLayoutPositiongetPositionInParentgetRoothasAllChildrenOfhasMarkshasTheSameRootMoveAshoistFirstBranchToTrunkindexisisAncestorOfisBranchWithCorrectAnswerlayoutloadJsonForThisNodelookupMovemovenextnextSiblingpassedpopStashedMarksprevprevSiblingrecomputeIsobranchesremoveremoveIfNoChildrensetActivePathsetAllMarkssizestashMarkstoJsontoSGFtraverseescapedSGFChatfmtUsernamemarkupSGFChatmarkupSGFChatMessagemarkupSGFChatWithoutNode
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    active_path_number

    active_path_number: number = 0

    branches

    branches: MoveTree[]

    Private Optional chat_log

    chat_log?: MoveTreeChatLine[]

    correct_answer

    correct_answer: boolean = false

    edited

    edited: boolean

    Private Readonly engine

    engine: GobanEngine

    Private Optional hint_next

    hint_next?: MoveTree

    Readonly id

    id: number

    Private Optional isobranch_hash

    isobranch_hash?: string

    isobranches

    isobranches: any

    label

    label: string = "[unset]"

    Optional label_metrics

    label_metrics?: any

    layout_cx

    layout_cx: number = 0

    layout_cy

    layout_cy: number = 0

    layout_x

    layout_x: number = 0

    layout_y

    layout_y: number = 0

    line_color

    line_color: number

    Private Optional marks

    marks?: MarkInterface[][]

    move_number

    move_number: number

    parent

    parent: null | MoveTree

    pen_marks

    pen_marks: MoveTreePenMarks = []

    played_by

    played_by: undefined | number

    player

    player: JGOFNumericPlayerColor

    player_update

    player_update: undefined | JGOFPlayerSummary

    Readonly pretty_coordinates

    pretty_coordinates: string

    Private stashed_marks

    stashed_marks: MarkInterface[][][] = []

    state

    state: BoardStateWithIsobranchHash

    text

    text: string

    trunk

    trunk: boolean

    Optional trunk_next

    trunk_next?: MoveTree

    wrong_answer

    wrong_answer: boolean = false

    x

    x: number

    y

    y: number

    Static active_path_number

    active_path_number: number = 0

    ** Layout & Rendering ***

    +

    Static current_line_color

    current_line_color: number = 0

    Static isobranch_colors

    isobranch_colors: {
        strong: string;
        weak: string;
    } = ...

    Type declaration

    • strong: string
    • weak: string

    Static line_colors

    line_colors: string[] = ...

    Static Readonly stone_padding

    stone_padding: 3 = 3

    Static Readonly stone_radius

    stone_radius: 11 = 11

    Static Readonly stone_square_size

    stone_square_size: number = ...

    Accessors

    stoneColor

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

    • Returns "black" | "white" | "empty"

    Methods

    clearBranchesExceptFor

    clearMarks

    containsOtherTreeAsChild

    containsOtherTreeAsSubset

    debug

    findBranchesWithCorrectAnswer

    findChildWhich

    findStrongIsobranches

    fold

    foreachMarkedPosition

    • foreachMarkedPosition(fn): void

    • 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

    getAllMarks

    getBranchPoint

    getChatLog

    getDistance

    getMarks

    getMoveIndex

    getMoveNumberDifferenceFromTrunk

    getMoveStringToThisPoint

    getNodeAtLayoutPosition

    getPositionInParent

    getRoot

    hasAllChildrenOf

    hasMarks

    • hasMarks(): boolean

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

      +

      Returns boolean

    hasTheSameRootMoveAs

    hoistFirstBranchToTrunk

    index

    is

    isAncestorOf

    Private isBranchWithCorrectAnswer

    layout

    • layout(x, min_y, layout_hash, line_color): number

    • Parameters

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

      Returns number

    loadJsonForThisNode

    • loadJsonForThisNode(json): void

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

      +

      Parameters

      Returns void

    lookupMove

    move

    next

    nextSibling

    passed

    popStashedMarks

    prev

    prevSibling

    recomputeIsobranches

    • recomputeIsobranches(): void

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

      +

      Returns void

    remove

    removeIfNoChildren

    setActivePath

    setAllMarks

    size

    stashMarks

    • stashMarks(): void

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

      +

      Returns void

    toJson

    toSGF

    traverse

    Static escapedSGFChat

    Static fmtUsername

    Static markupSGFChat

    Static markupSGFChatMessage

    Static markupSGFChatWithoutNode

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractive_path_numberbrancheschat_logcorrect_answereditedenginehint_nextidisobranch_hashisobrancheslabellabel_metricslayout_cxlayout_cylayout_xlayout_yline_colormarksmove_numberparentpen_marksplayed_byplayerplayer_updatepretty_coordinatesstashed_marksstatetexttrunktrunk_nextwrong_answerxyactive_path_numbercurrent_line_colorisobranch_colorsline_colorsstone_paddingstone_radiusstone_square_sizestoneColorclearBranchesExceptForclearMarkscontainsOtherTreeAsChildcontainsOtherTreeAsSubsetdebugfindBranchesWithCorrectAnswerfindChildWhichfindStrongIsobranchesfoldforeachMarkedPositiongetAllMarksgetBranchPointgetChatLoggetDistancegetMarksgetMoveIndexgetMoveNumberDifferenceFromTrunkgetMoveStringToThisPointgetNodeAtLayoutPositiongetPositionInParentgetRoothasAllChildrenOfhasMarkshasTheSameRootMoveAshoistFirstBranchToTrunkindexisisAncestorOfisBranchWithCorrectAnswerlayoutloadJsonForThisNodelookupMovemovenextnextSiblingpassedpopStashedMarksprevprevSiblingrecomputeIsobranchesremoveremoveIfNoChildrensetActivePathsetAllMarkssizestashMarkstoJsontoSGFtraverseescapedSGFChatfmtUsernamemarkupSGFChatmarkupSGFChatMessagemarkupSGFChatWithoutNode
    \ No newline at end of file diff --git a/docs/classes/SVGRenderer.html b/docs/classes/SVGRenderer.html index 198573da..4d43faeb 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

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    __board_redraw_pen_layer_timer __clock_timer? __draw_state @@ -326,31 +326,31 @@ getMoveTreeNumbering getSoundEnabled getSoundVolume -

    Constructors

    constructor

    Properties

    Protected __board_redraw_pen_layer_timer

    __board_redraw_pen_layer_timer: any = null

    Protected Optional __clock_timer

    __clock_timer?: Timeout

    Protected __draw_state

    __draw_state: string[][]

    Protected __last_pt

    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean

    Private __set_board_height

    __set_board_height: number = -1

    Private __set_board_width

    __set_board_width: number = -1

    Protected __update_move_tree

    __update_move_tree: any = null

    Protected analysis_move_counter

    analysis_move_counter: number

    Protected analysis_removal_last_position

    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number

    Protected Optional analysis_removal_state

    analysis_removal_state?: boolean

    Private autoplaying_puzzle_move

    autoplaying_puzzle_move: boolean = false

    Protected bounded_height

    bounded_height: number

    Protected bounded_width

    bounded_width: number

    Protected bounds

    bounds: GobanBounds

    Private byoyomi_label

    byoyomi_label: string = ""

    chat_log

    chat_log: GobanChatLog = []

    Protected circle_radius

    circle_radius: number

    clock_should_be_paused_for_move_submission

    clock_should_be_paused_for_move_submission: boolean = false

    Protected Optional colored_circles

    colored_circles?: (undefined | ColoredCircle)[][]

    Protected conditional_path

    conditional_path: string = ""

    conditional_starting_color

    conditional_starting_color: "black" | "white" | "invalid" = "invalid"

    conditional_tree

    conditional_tree: ConditionalMoveTree = ...

    config

    config: GobanConfig

    Protected Optional connectToReviewSent

    connectToReviewSent?: boolean

    Private Optional coordinate_labels_layer

    coordinate_labels_layer?: SVGGraphicsElement

    Protected Optional current_cmove

    current_cmove?: ConditionalMoveTree

    Private Optional current_pen_mark

    current_pen_mark?: {
        color: string;
        points: [number, number];
    }

    Type declaration

    • color: string
    • points: [number, number]

    Protected currently_my_cmove

    currently_my_cmove: boolean = false

    Protected dirty_redraw

    dirty_redraw: any = null

    Protected disconnectedFromGame

    disconnectedFromGame: boolean = true

    Protected Optional display_width

    display_width?: number

    Protected done_loading_review

    done_loading_review: boolean = false

    Protected dont_draw_last_move

    dont_draw_last_move: boolean

    double_click_submit

    double_click_submit: boolean

    draw_bottom_labels

    draw_bottom_labels: boolean

    draw_left_labels

    draw_left_labels: boolean

    draw_right_labels

    draw_right_labels: boolean

    draw_top_labels

    draw_top_labels: boolean

    Private drawing_enabled

    drawing_enabled: boolean = true

    Protected Optional edit_color

    edit_color?: "black" | "white"

    engine

    engine: GobanEngine

    Protected errorHandler

    errorHandler: ((e) => void)

    Type declaration

      • (e): void

      • Parameters

        • e: Error

        Returns void

    event_layer

    event_layer: HTMLDivElement

    Readonly game_id

    game_id: number

    Protected game_type

    game_type: string

    Protected Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Readonly goban_id

    goban_id: number = ++last_goban_id

    Base fields *

    -

    Private grid

    grid: SVGGraphicsElement[][] = []

    Private Optional grid_layer

    grid_layer?: SVGGraphicsElement

    Private handleShiftKey

    handleShiftKey: ((ev) => void)

    Type declaration

      • (ev): void

      • Parameters

        • ev: KeyboardEvent

        Returns void

    Protected Optional heatmap

    heatmap?: NumberMatrix

    height

    height: number

    Protected highlight_movetree_moves

    highlight_movetree_moves: boolean

    Protected interactive

    interactive: boolean

    Protected isInPushedAnalysis

    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerController

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerOwner

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected label_character

    label_character: string

    Protected label_mark

    label_mark: string = "[UNSET]"

    Private Optional labeling_mode

    labeling_mode?: "put" | "clear"

    Optional last_clock

    last_clock?: AdHocClock

    Optional last_emitted_clock

    last_emitted_clock?: JGOFClockWithTransmitting

    Protected Optional last_hover_square

    last_hover_square?: JGOFIntersection

    Private last_label_position

    last_label_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number

    Protected Optional last_move

    last_move?: MoveTree

    Private last_move_opacity

    last_move_opacity: number = 1

    Protected last_move_radius

    last_move_radius: number

    Protected last_paused_by_player_state

    last_paused_by_player_state: null | boolean = null

    Protected last_paused_state

    last_paused_state: null | boolean = null

    Private Optional last_pen_position

    last_pen_position?: [number, number]

    Protected Optional last_phase

    last_phase?: GobanEnginePhase

    Protected last_review_message

    last_review_message: ReviewMessage

    Protected Optional last_sound_played_for_a_stone_placement

    last_sound_played_for_a_stone_placement?: string

    Protected last_stone_sound

    last_stone_sound: number

    Protected leavePushedAnalysis

    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void

      • Returns void

    Private Optional lines_layer

    lines_layer?: SVGGraphicsElement

    Protected Optional marked_analysis_score

    marked_analysis_score?: boolean[][]

    Private Optional message_div

    message_div?: HTMLDivElement

    Private Optional message_td

    message_td?: HTMLElement

    Private Optional message_text

    message_text?: HTMLDivElement

    Private Optional message_timeout

    message_timeout?: number

    Protected metrics

    metrics: GobanMetrics = ...

    Protected Optional move_selected

    move_selected?: JGOFIntersection

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Private Optional move_tree_inner_container

    move_tree_inner_container?: HTMLDivElement

    Private Optional move_tree_svg

    move_tree_svg?: SVGElement

    Protected no_display

    no_display: boolean

    Protected Optional onError

    onError?: ((error) => void)

    Type declaration

      • (error): void

      • Parameters

        • error: Error

        Returns void

    Protected on_game_screen

    on_game_screen: boolean

    one_click_submit

    one_click_submit: boolean

    Protected original_square_size

    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Protected parent

    parent: HTMLElement

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    Private Optional pen_layer

    pen_layer?: SVGGraphicsElement

    pen_marks

    pen_marks: any[]

    Protected player_id

    player_id: number

    Protected Optional preloaded_data

    preloaded_data?: GobanConfig

    previous_mode

    previous_mode: string

    Protected puzzle_autoplace_delay

    puzzle_autoplace_delay: number

    Private ready_to_draw

    ready_to_draw: boolean = false

    Protected restrict_moves_to_movetree

    restrict_moves_to_movetree: boolean

    Protected review_had_gamedata

    review_had_gamedata: boolean

    Readonly review_id

    review_id: number

    Protected scoring_mode

    scoring_mode: boolean | "stalling-scoring-mode"

    Protected Optional sendLatencyTimer

    sendLatencyTimer?: Timeout

    sent_timed_out_message

    sent_timed_out_message: boolean = false

    Private shadow_grid

    shadow_grid: (undefined | SVGElement)[][] = []

    Private Optional shadow_layer

    shadow_layer?: SVGGraphicsElement

    Protected shift_key_is_down

    shift_key_is_down: boolean

    Protected show_move_numbers

    show_move_numbers: boolean

    Protected show_variation_move_numbers

    show_variation_move_numbers: boolean

    showing_scores

    showing_scores: boolean = false

    Protected socket

    socket: GobanSocket<ClientToServer, ServerToClient>

    Protected socket_event_bindings

    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

    Protected square_size

    square_size: number = 10

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Protected stone_placement_enabled

    stone_placement_enabled: boolean

    Protected Optional stone_removal_auto_scoring_done

    stone_removal_auto_scoring_done?: boolean = false

    Private svg

    svg: SVGElement

    Private svg_defs

    svg_defs: SVGDefsElement

    Private theme_black

    theme_black: GobanTheme

    Private theme_black_stones

    theme_black_stones: any[] = []

    Private theme_black_text_color

    theme_black_text_color: string = HOT_PINK

    Private theme_blank_text_color

    theme_blank_text_color: string = HOT_PINK

    Private theme_board

    theme_board: GobanTheme

    Private theme_faded_line_color

    theme_faded_line_color: string = HOT_PINK

    Private theme_faded_star_color

    theme_faded_star_color: string = HOT_PINK

    Private theme_line_color

    theme_line_color: string = ""

    Private theme_star_color

    theme_star_color: string = ""

    Private theme_stone_radius

    theme_stone_radius: number = 10

    Private theme_white

    theme_white: GobanTheme

    Private theme_white_stones

    theme_white_stones: any[] = []

    Private theme_white_text_color

    theme_white_text_color: string = HOT_PINK

    Private themes

    themes: GobanSelectedThemes = ...

    Protected Optional title_div

    title_div?: HTMLElement

    variation_stone_opacity

    variation_stone_opacity: number

    visual_undo_request_indicator

    visual_undo_request_indicator: boolean

    width

    width: number

    Static THEMES

    THEMES: ThemesInterface = THEMES

    Static THEMES_SORTED

    THEMES_SORTED: {
        black: GobanTheme[];
        board: GobanTheme[];
        white: GobanTheme[];
        [key: string]: GobanTheme[];
    } = THEMES_SORTED

    Type declaration

    Static setCallbacks

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

    Type declaration

      • (newCallbacks): void

      • Set's callback functions to be called in various situations. You can set any +

    Constructors

    constructor

    Properties

    Protected __board_redraw_pen_layer_timer

    __board_redraw_pen_layer_timer: any = null

    Protected Optional __clock_timer

    __clock_timer?: Timeout

    Protected __draw_state

    __draw_state: string[][]

    Protected __last_pt

    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean

    Private __set_board_height

    __set_board_height: number = -1

    Private __set_board_width

    __set_board_width: number = -1

    Protected __update_move_tree

    __update_move_tree: any = null

    Protected analysis_move_counter

    analysis_move_counter: number

    Protected analysis_removal_last_position

    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number

    Protected Optional analysis_removal_state

    analysis_removal_state?: boolean

    Private autoplaying_puzzle_move

    autoplaying_puzzle_move: boolean = false

    Protected bounded_height

    bounded_height: number

    Protected bounded_width

    bounded_width: number

    Protected bounds

    bounds: GobanBounds

    Private byoyomi_label

    byoyomi_label: string = ""

    chat_log

    chat_log: GobanChatLog = []

    Protected circle_radius

    circle_radius: number

    clock_should_be_paused_for_move_submission

    clock_should_be_paused_for_move_submission: boolean = false

    Protected Optional colored_circles

    colored_circles?: (undefined | ColoredCircle)[][]

    Protected conditional_path

    conditional_path: string = ""

    conditional_starting_color

    conditional_starting_color: "black" | "white" | "invalid" = "invalid"

    conditional_tree

    conditional_tree: ConditionalMoveTree = ...

    config

    config: GobanConfig

    Protected Optional connectToReviewSent

    connectToReviewSent?: boolean

    Private Optional coordinate_labels_layer

    coordinate_labels_layer?: SVGGraphicsElement

    Protected Optional current_cmove

    current_cmove?: ConditionalMoveTree

    Private Optional current_pen_mark

    current_pen_mark?: {
        color: string;
        points: [number, number];
    }

    Type declaration

    • color: string
    • points: [number, number]

    Protected currently_my_cmove

    currently_my_cmove: boolean = false

    Protected dirty_redraw

    dirty_redraw: any = null

    Protected disconnectedFromGame

    disconnectedFromGame: boolean = true

    Protected Optional display_width

    display_width?: number

    Protected done_loading_review

    done_loading_review: boolean = false

    Protected dont_draw_last_move

    dont_draw_last_move: boolean

    double_click_submit

    double_click_submit: boolean

    draw_bottom_labels

    draw_bottom_labels: boolean

    draw_left_labels

    draw_left_labels: boolean

    draw_right_labels

    draw_right_labels: boolean

    draw_top_labels

    draw_top_labels: boolean

    Private drawing_enabled

    drawing_enabled: boolean = true

    Protected Optional edit_color

    edit_color?: "black" | "white"

    engine

    engine: GobanEngine

    Protected errorHandler

    errorHandler: ((e) => void)

    Type declaration

      • (e): void

      • Parameters

        • e: Error

        Returns void

    event_layer

    event_layer: HTMLDivElement

    Readonly game_id

    game_id: number

    Protected game_type

    game_type: string

    Protected Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Readonly goban_id

    goban_id: number = ++last_goban_id

    Base fields *

    +

    Private grid

    grid: SVGGraphicsElement[][] = []

    Private Optional grid_layer

    grid_layer?: SVGGraphicsElement

    Private handleShiftKey

    handleShiftKey: ((ev) => void)

    Type declaration

      • (ev): void

      • Parameters

        • ev: KeyboardEvent

        Returns void

    Protected Optional heatmap

    heatmap?: NumberMatrix

    height

    height: number

    Protected highlight_movetree_moves

    highlight_movetree_moves: boolean

    Protected interactive

    interactive: boolean

    Protected isInPushedAnalysis

    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerController

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerOwner

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected label_character

    label_character: string

    Protected label_mark

    label_mark: string = "[UNSET]"

    Private Optional labeling_mode

    labeling_mode?: "put" | "clear"

    Optional last_clock

    last_clock?: AdHocClock

    Optional last_emitted_clock

    last_emitted_clock?: JGOFClockWithTransmitting

    Protected Optional last_hover_square

    last_hover_square?: JGOFIntersection

    Private last_label_position

    last_label_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number

    Protected Optional last_move

    last_move?: MoveTree

    Private last_move_opacity

    last_move_opacity: number = 1

    Protected last_move_radius

    last_move_radius: number

    Protected last_paused_by_player_state

    last_paused_by_player_state: null | boolean = null

    Protected last_paused_state

    last_paused_state: null | boolean = null

    Private Optional last_pen_position

    last_pen_position?: [number, number]

    Protected Optional last_phase

    last_phase?: GobanEnginePhase

    Protected last_review_message

    last_review_message: ReviewMessage

    Protected Optional last_sound_played_for_a_stone_placement

    last_sound_played_for_a_stone_placement?: string

    Protected last_stone_sound

    last_stone_sound: number

    Protected leavePushedAnalysis

    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void

      • Returns void

    Private Optional lines_layer

    lines_layer?: SVGGraphicsElement

    Protected Optional marked_analysis_score

    marked_analysis_score?: boolean[][]

    Private Optional message_div

    message_div?: HTMLDivElement

    Private Optional message_td

    message_td?: HTMLElement

    Private Optional message_text

    message_text?: HTMLDivElement

    Private Optional message_timeout

    message_timeout?: number

    Protected metrics

    metrics: GobanMetrics = ...

    Protected Optional move_selected

    move_selected?: JGOFIntersection

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Private Optional move_tree_inner_container

    move_tree_inner_container?: HTMLDivElement

    Private Optional move_tree_svg

    move_tree_svg?: SVGElement

    Protected no_display

    no_display: boolean

    Protected Optional onError

    onError?: ((error) => void)

    Type declaration

      • (error): void

      • Parameters

        • error: Error

        Returns void

    Protected on_game_screen

    on_game_screen: boolean

    one_click_submit

    one_click_submit: boolean

    Protected original_square_size

    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Protected parent

    parent: HTMLElement

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    Private Optional pen_layer

    pen_layer?: SVGGraphicsElement

    pen_marks

    pen_marks: any[]

    Protected player_id

    player_id: number

    Protected Optional preloaded_data

    preloaded_data?: GobanConfig

    previous_mode

    previous_mode: string

    Protected puzzle_autoplace_delay

    puzzle_autoplace_delay: number

    Private ready_to_draw

    ready_to_draw: boolean = false

    Protected restrict_moves_to_movetree

    restrict_moves_to_movetree: boolean

    Protected review_had_gamedata

    review_had_gamedata: boolean

    Readonly review_id

    review_id: number

    Protected scoring_mode

    scoring_mode: boolean | "stalling-scoring-mode"

    Protected Optional sendLatencyTimer

    sendLatencyTimer?: Timeout

    sent_timed_out_message

    sent_timed_out_message: boolean = false

    Private shadow_grid

    shadow_grid: (undefined | SVGElement)[][] = []

    Private Optional shadow_layer

    shadow_layer?: SVGGraphicsElement

    Protected shift_key_is_down

    shift_key_is_down: boolean

    Protected show_move_numbers

    show_move_numbers: boolean

    Protected show_variation_move_numbers

    show_variation_move_numbers: boolean

    showing_scores

    showing_scores: boolean = false

    Protected socket

    socket: GobanSocket<ClientToServer, ServerToClient>

    Protected socket_event_bindings

    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

    Protected square_size

    square_size: number = 10

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Protected stone_placement_enabled

    stone_placement_enabled: boolean

    Protected Optional stone_removal_auto_scoring_done

    stone_removal_auto_scoring_done?: boolean = false

    Private svg

    svg: SVGElement

    Private svg_defs

    svg_defs: SVGDefsElement

    Private theme_black

    theme_black: GobanTheme

    Private theme_black_stones

    theme_black_stones: any[] = []

    Private theme_black_text_color

    theme_black_text_color: string = HOT_PINK

    Private theme_blank_text_color

    theme_blank_text_color: string = HOT_PINK

    Private theme_board

    theme_board: GobanTheme

    Private theme_faded_line_color

    theme_faded_line_color: string = HOT_PINK

    Private theme_faded_star_color

    theme_faded_star_color: string = HOT_PINK

    Private theme_line_color

    theme_line_color: string = ""

    Private theme_star_color

    theme_star_color: string = ""

    Private theme_stone_radius

    theme_stone_radius: number = 10

    Private theme_white

    theme_white: GobanTheme

    Private theme_white_stones

    theme_white_stones: any[] = []

    Private theme_white_text_color

    theme_white_text_color: string = HOT_PINK

    Private themes

    themes: GobanSelectedThemes = ...

    Protected Optional title_div

    title_div?: HTMLElement

    variation_stone_opacity

    variation_stone_opacity: number

    visual_undo_request_indicator

    visual_undo_request_indicator: boolean

    width

    width: number

    Static THEMES

    THEMES: ThemesInterface = THEMES

    Static THEMES_SORTED

    THEMES_SORTED: {
        black: GobanTheme[];
        board: GobanTheme[];
        white: GobanTheme[];
        [key: string]: GobanTheme[];
    } = THEMES_SORTED

    Type declaration

    Static setCallbacks

    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

    Static setTranslations

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

    Type declaration

      • (_catalog, _debug_mode?): void

      • Parameters

        Returns void

    Accessors

    analyze_subtool

    • get analyze_subtool(): string

    • Returns string

    • set analyze_subtool(analyze_subtool): void

    • Parameters

      • analyze_subtool: string

      Returns void

    analyze_tool

    destroyed

    • get destroyed(): boolean

    • Returns boolean

    is_game_record

    • get is_game_record(): boolean

    • True if the game is a game record of a real life game

      -

      Returns boolean

    mode

    review_controller_id

    • 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

    review_owner_id

    • 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

    score_estimator

    submit_move

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

    • Returns undefined | (() => void)

    • set submit_move(submit_move): void

    • Parameters

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

      Returns void

    title

    Methods

    Private __drawSquare

    Protected _socket_on

    acceptRemovedStones

    acceptUndo

    Protected annul

    Private attachPenLayer

    Private bindPointerBindings

    cancelGame

    cancelUndo

    clearAnalysisDrawing

    clearAnalysisScores

    clearMark

    clearMessage

    Protected clearPendingResignation

    Protected clearTransientMark

    computeMetrics

    Protected computeNewPlayerClock

    Protected computeThemeStoneRadius

    Protected connect

    debouncedEmitCapturedStones

    decodeMoves

    • decodeMoves(move_obj): JGOFMove[]

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

      Parameters

      Returns void

    Static setTranslations

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

    Type declaration

      • (_catalog, _debug_mode?): void

      • Parameters

        Returns void

    Accessors

    analyze_subtool

    • get analyze_subtool(): string

    • Returns string

    • set analyze_subtool(analyze_subtool): void

    • Parameters

      • analyze_subtool: string

      Returns void

    analyze_tool

    destroyed

    • get destroyed(): boolean

    • Returns boolean

    is_game_record

    • get is_game_record(): boolean

    • True if the game is a game record of a real life game

      +

      Returns boolean

    mode

    review_controller_id

    • 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

    review_owner_id

    • 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

    score_estimator

    submit_move

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

    • Returns undefined | (() => void)

    • set submit_move(submit_move): void

    • Parameters

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

      Returns void

    title

    Methods

    Private __drawSquare

    Protected _socket_on

    acceptRemovedStones

    acceptUndo

    Protected annul

    Private attachPenLayer

    Private bindPointerBindings

    cancelGame

    cancelUndo

    clearAnalysisDrawing

    clearAnalysisScores

    clearMark

    clearMessage

    Protected clearPendingResignation

    Protected clearTransientMark

    computeMetrics

    Protected computeNewPlayerClock

    Protected computeThemeStoneRadius

    Protected connect

    debouncedEmitCapturedStones

    decodeMoves

    decodePrettyCoordinates

    decodePrettyCoordinates

    • decodePrettyCoordinates(coordinates): JGOFMove

    • Decodes a move string like "A11" into a move object like {x: 0, y: 10}. Also handles the special cases like ".." and "pass" which map to {x: -1, y: -1}.

      -

      Parameters

      • coordinates: string

      Returns JGOFMove

    Protected defaultConfig

    deleteBranch

    deleteConditionalPath

    deleteCustomMark

    destroy

    Private detachPenLayer

    Protected disableDrawing

    disablePen

    disableStonePlacement

    Protected disconnect

    Private drawCoordinateLabels

    • drawCoordinateLabels(force_clear?): void

    • Parameters

      • Optional force_clear: boolean

      Returns void

    Private drawLines

    drawPenMarks

    drawSquare

    Private drawingHash

    editPlaceByPrettyCoordinates

    Protected enableDrawing

    enablePen

    enableStonePlacement

    encodeMove

    encodeMoves

    followConditionalPath

    Protected followConditionalSegment

    Protected getAnalysisScoreColorAtLocation

    Protected getClockDrift

    Protected getCoordinateDisplaySystem

    getCurrentConditionalPath

    getLastReviewMessage

    Protected getLocation

    getMarks

    Protected getNetworkLatency

    getPlayerRelativeLatency

    Protected getSelectedThemes

    Protected getShowMoveNumbers

    Protected getShowVariationMoveNumbers

    Protected getWidthForSquareSize

    giveReviewControl

    hideScores

    Protected incrementLabelCharacter

    isAnalysisDisabled

    isCurrentUserAPlayer

    Protected isLastOfficialMove

    jumpToLastOfficialMove

    load

    markAnalysisScores

    Protected defaultConfig

    deleteBranch

    deleteConditionalPath

    deleteCustomMark

    destroy

    Private detachPenLayer

    Protected disableDrawing

    disablePen

    disableStonePlacement

    Protected disconnect

    Private drawCoordinateLabels

    • drawCoordinateLabels(force_clear?): void

    • Parameters

      • Optional force_clear: boolean

      Returns void

    Private drawLines

    drawPenMarks

    drawSquare

    Private drawingHash

    editPlaceByPrettyCoordinates

    Protected enableDrawing

    enablePen

    enableStonePlacement

    encodeMove

    encodeMoves

    followConditionalPath

    Protected followConditionalSegment

    Protected getAnalysisScoreColorAtLocation

    Protected getClockDrift

    Protected getCoordinateDisplaySystem

    getCurrentConditionalPath

    getLastReviewMessage

    Protected getLocation

    getMarks

    Protected getNetworkLatency

    getPlayerRelativeLatency

    Protected getSelectedThemes

    Protected getShowMoveNumbers

    Protected getShowVariationMoveNumbers

    Protected getWidthForSquareSize

    giveReviewControl

    hideScores

    Protected incrementLabelCharacter

    isAnalysisDisabled

    isCurrentUserAPlayer

    Protected isLastOfficialMove

    jumpToLastOfficialMove

    load

    markAnalysisScores

    • markAnalysisScores(): void

    • 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

    markDirty

    move_tree_bindEvents

    move_tree_drawIsoBranchTo

    move_tree_drawPath

    move_tree_drawRecursive

    move_tree_drawStone

    move_tree_hilightNode

    move_tree_recursiveDrawPath

    move_tree_redraw

    nextSibling

    Protected onAnalysisScoringMove

    Protected onAnalysisScoringStart

    Protected onAnalysisToggleStoneRemoval

    Private onLabelingMove

    Private onLabelingStart

    Private onMouseMove

    Private onMouseOut

    Private onPenMove

    Private onPenStart

    Private onTap

    • onTap(event, double_tap, right_click, press_duration_ms): void

    • Parameters

      • event: TouchEvent | MouseEvent
      • double_tap: boolean
      • right_click: boolean
      • press_duration_ms: number

      Returns void

    pass

    pauseGame

    Private pen2xy

    performStoneRemovalAutoScoring

    placeByPrettyCoordinates

    Protected playMovementSound

    Protected post_config_constructor

    markDirty

    move_tree_bindEvents

    move_tree_drawIsoBranchTo

    move_tree_drawPath

    move_tree_drawRecursive

    move_tree_drawStone

    move_tree_hilightNode

    move_tree_recursiveDrawPath

    move_tree_redraw

    nextSibling

    Protected onAnalysisScoringMove

    Protected onAnalysisScoringStart

    Protected onAnalysisToggleStoneRemoval

    Private onLabelingMove

    Private onLabelingStart

    Private onMouseMove

    Private onMouseOut

    Private onPenMove

    Private onPenStart

    Private onTap

    • onTap(event, double_tap, right_click, press_duration_ms): void

    • Parameters

      • event: TouchEvent | MouseEvent
      • double_tap: boolean
      • right_click: boolean
      • press_duration_ms: number

      Returns void

    pass

    pauseGame

    Private pen2xy

    performStoneRemovalAutoScoring

    placeByPrettyCoordinates

    Protected playMovementSound

    Protected post_config_constructor

    • post_config_constructor(): GobanEngine

    • 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

    prettyCoordinates

    prevSibling

    Protected putAnalysisRemovalAtLocation

    Protected putAnalysisScoreColorAtLocation

    Protected putOrClearLabel

    redraw

    rejectRemovedStones

    requestUndo

    resign

    resumeGame

    saveConditionalMoves

    Protected scheduleRedrawPenLayer

    sendChat

    Protected sendMove

    Protected sendPendingResignation

    sendPreventEscaping

    sendPreventStalling

    sendTimedOut

    prettyCoordinates

    prevSibling

    Protected putAnalysisRemovalAtLocation

    Protected putAnalysisScoreColorAtLocation

    Protected putOrClearLabel

    redraw

    rejectRemovedStones

    requestUndo

    resign

    resumeGame

    saveConditionalMoves

    Protected scheduleRedrawPenLayer

    sendChat

    Protected sendMove

    Protected sendPendingResignation

    sendPreventEscaping

    sendPreventStalling

    sendTimedOut

    • sendTimedOut(): void

    • 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

    set

    setAnalyzeTool

    setBounds

    setByoYomiLabel

    setColoredCircles

    setColoredMarks

    • setColoredMarks(colored_marks): void

    • Parameters

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

      Returns void

    setConditionalTree

    setCustomMark

    setEditColor

    setForRemoval

    • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

    setGameClock

    setHeatmap

    setLabelCharacter

    Protected setLabelCharacterFromMarks

    setLabelPosition

    setLastMoveOpacity

    Protected setLastOfficialMove

    setLastReviewMessage

    Protected setLetterMark

    setMark

    setMarkByPrettyCoordinates

    Protected setMarkColor

    setMarks

    set

    setAnalyzeTool

    setBounds

    setByoYomiLabel

    setColoredCircles

    setColoredMarks

    • setColoredMarks(colored_marks): void

    • Parameters

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

      Returns void

    setConditionalTree

    setCustomMark

    setEditColor

    setForRemoval

    • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

    setGameClock

    setHeatmap

    setLabelCharacter

    Protected setLabelCharacterFromMarks

    setLabelPosition

    setLastMoveOpacity

    Protected setLastOfficialMove

    setLastReviewMessage

    Protected setLetterMark

    setMark

    setMarkByPrettyCoordinates

    Protected setMarkColor

    setMarks

    • setMarks(marks, dont_draw?): 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

    setMode

    setModeDeferred

    setMoveTreeContainer

    Private setPenStyle

    setScoringMode

    setSquareSize

    setSquareSizeBasedOnDisplayWidth

    setState

    • setState(): 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

    setMode

    setModeDeferred

    setMoveTreeContainer

    Private setPenStyle

    setScoringMode

    setSquareSize

    setSquareSizeBasedOnDisplayWidth

    setState

    setStrictSekiMode

    Protected setSubmit

    setSubscriptMark

    Protected setTheme

    Protected setTitle

    setToPreviousMode

    Protected setTransientMark

    showFirst

    showMessage

    showNext

    showPrevious

    showScores

    showStallingScoreEstimate

    syncReviewMove

    Protected toggleMark

    • toggleMark(x, y, mark, force_label?, force_put?): boolean

    • Parameters

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

      Returns boolean

    Protected updateMoveTree

    Protected updateOrRedrawMoveTree

    updatePlayerToMoveTitle

    updateScoreEstimation

    updateTitleAndStonePlacement

    Protected watchSelectedThemes

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

    • Parameters

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

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

          • Returns any

    Protected xy2ij

    • xy2ij(x, y, anti_slip?): {
          i: number;
          j: number;
          valid: boolean;
      }

    • Parameters

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

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

      • i: number
      • j: number
      • valid: boolean

    Private xy2pen

    Static getCDNReleaseBase

    Static getMoveTreeNumbering

    Static getSoundEnabled

    Static getSoundVolume

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__set_board_height__set_board_width__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_stateautoplaying_puzzle_movebounded_heightbounded_widthboundsbyoyomi_labelchat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentcoordinate_labels_layercurrent_cmovecurrent_pen_markcurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsdrawing_enablededit_colorengineerrorHandlerevent_layergame_idgame_typegetPuzzlePlacementSettinggoban_idgridgrid_layerhandleShiftKeyheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklabeling_modelast_clocklast_emitted_clocklast_hover_squarelast_label_positionlast_movelast_move_opacitylast_move_radiuslast_paused_by_player_statelast_paused_statelast_pen_positionlast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysislines_layermarked_analysis_scoremessage_divmessage_tdmessage_textmessage_timeoutmetricsmove_selectedmove_tree_containermove_tree_inner_containermove_tree_svgno_displayonErroron_game_screenone_click_submitoriginal_square_sizeparentpause_controlpaused_sincepen_layerpen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayready_to_drawrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshadow_gridshadow_layershift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donesvgsvg_defstheme_blacktheme_black_stonestheme_black_text_colortheme_blank_text_colortheme_boardtheme_faded_line_colortheme_faded_star_colortheme_line_colortheme_star_colortheme_stone_radiustheme_whitetheme_white_stonestheme_white_text_colorthemestitle_divvariation_stone_opacityvisual_undo_request_indicatorwidthTHEMESTHEMES_SORTEDsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle__drawSquare_socket_onacceptRemovedStonesacceptUndoannulattachPenLayerbindPointerBindingscancelGamecancelUndoclearAnalysisDrawingclearAnalysisScoresclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeMetricscomputeNewPlayerClockcomputeThemeStoneRadiusconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydetachPenLayerdisableDrawingdisablePendisableStonePlacementdisconnectdrawCoordinateLabelsdrawLinesdrawPenMarksdrawSquaredrawingHasheditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetAnalysisScoreColorAtLocationgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkAnalysisScoresmarkDirtymove_tree_bindEventsmove_tree_drawIsoBranchTomove_tree_drawPathmove_tree_drawRecursivemove_tree_drawStonemove_tree_hilightNodemove_tree_recursiveDrawPathmove_tree_redrawnextSiblingonAnalysisScoringMoveonAnalysisScoringStartonAnalysisToggleStoneRemovalonLabelingMoveonLabelingStartonMouseMoveonMouseOutonPenMoveonPenStartonTappasspauseGamepen2xyperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingputAnalysisRemovalAtLocationputAnalysisScoreColorAtLocationputOrClearLabelredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetByoYomiLabelsetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLabelPositionsetLastMoveOpacitysetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetPenStylesetScoringModesetSquareSizesetSquareSizeBasedOnDisplayWidthsetStatesetStrictSekiModesetSubmitsetSubscriptMarksetThemesetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementwatchSelectedThemesxy2ijxy2pengetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
    \ No newline at end of file +

    Returns void

    setStrictSekiMode

    Protected setSubmit

    setSubscriptMark

    Protected setTheme

    Protected setTitle

    setToPreviousMode

    Protected setTransientMark

    showFirst

    showMessage

    showNext

    showPrevious

    showScores

    showStallingScoreEstimate

    syncReviewMove

    Protected toggleMark

    Protected updateMoveTree

    Protected updateOrRedrawMoveTree

    updatePlayerToMoveTitle

    updateScoreEstimation

    updateTitleAndStonePlacement

    Protected watchSelectedThemes

    Protected xy2ij

    Private xy2pen

    Static getCDNReleaseBase

    Static getMoveTreeNumbering

    Static getSoundEnabled

    Static getSoundVolume

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__set_board_height__set_board_width__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_stateautoplaying_puzzle_movebounded_heightbounded_widthboundsbyoyomi_labelchat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentcoordinate_labels_layercurrent_cmovecurrent_pen_markcurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsdrawing_enablededit_colorengineerrorHandlerevent_layergame_idgame_typegetPuzzlePlacementSettinggoban_idgridgrid_layerhandleShiftKeyheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklabeling_modelast_clocklast_emitted_clocklast_hover_squarelast_label_positionlast_movelast_move_opacitylast_move_radiuslast_paused_by_player_statelast_paused_statelast_pen_positionlast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysislines_layermarked_analysis_scoremessage_divmessage_tdmessage_textmessage_timeoutmetricsmove_selectedmove_tree_containermove_tree_inner_containermove_tree_svgno_displayonErroron_game_screenone_click_submitoriginal_square_sizeparentpause_controlpaused_sincepen_layerpen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayready_to_drawrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshadow_gridshadow_layershift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donesvgsvg_defstheme_blacktheme_black_stonestheme_black_text_colortheme_blank_text_colortheme_boardtheme_faded_line_colortheme_faded_star_colortheme_line_colortheme_star_colortheme_stone_radiustheme_whitetheme_white_stonestheme_white_text_colorthemestitle_divvariation_stone_opacityvisual_undo_request_indicatorwidthTHEMESTHEMES_SORTEDsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle__drawSquare_socket_onacceptRemovedStonesacceptUndoannulattachPenLayerbindPointerBindingscancelGamecancelUndoclearAnalysisDrawingclearAnalysisScoresclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeMetricscomputeNewPlayerClockcomputeThemeStoneRadiusconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydetachPenLayerdisableDrawingdisablePendisableStonePlacementdisconnectdrawCoordinateLabelsdrawLinesdrawPenMarksdrawSquaredrawingHasheditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetAnalysisScoreColorAtLocationgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkAnalysisScoresmarkDirtymove_tree_bindEventsmove_tree_drawIsoBranchTomove_tree_drawPathmove_tree_drawRecursivemove_tree_drawStonemove_tree_hilightNodemove_tree_recursiveDrawPathmove_tree_redrawnextSiblingonAnalysisScoringMoveonAnalysisScoringStartonAnalysisToggleStoneRemovalonLabelingMoveonLabelingStartonMouseMoveonMouseOutonPenMoveonPenStartonTappasspauseGamepen2xyperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingputAnalysisRemovalAtLocationputAnalysisScoreColorAtLocationputOrClearLabelredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetByoYomiLabelsetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLabelPositionsetLastMoveOpacitysetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetPenStylesetScoringModesetSquareSizesetSquareSizeBasedOnDisplayWidthsetStatesetStrictSekiModesetSubmitsetSubscriptMarksetThemesetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementwatchSelectedThemesxy2ijxy2pengetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
    \ No newline at end of file diff --git a/docs/classes/ScoreEstimator.html b/docs/classes/ScoreEstimator.html index c092d4b0..c3bf787a 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

    constructor

    Properties

    amount autoscore autoscored_needs_sealing? @@ -47,24 +47,24 @@ setRemoved toggleSingleGroupRemoval updateEstimate -

    Constructors

    constructor

    Properties

    amount

    amount: number = NaN

    autoscore

    autoscore: boolean = false

    Optional autoscored_needs_sealing

    autoscored_needs_sealing?: JGOFSealingIntersection[]

    Optional autoscored_removed

    autoscored_removed?: JGOFMove[]

    Optional autoscored_state

    autoscored_state?: JGOFNumericPlayerColor[][]

    black

    black: PlayerScore = ...

    black_prisoners

    black_prisoners: number

    board

    board: JGOFNumericPlayerColor[][]

    board_is_repeating

    board_is_repeating: boolean

    color_to_move

    color_to_move: "black" | "white"

    engine

    engine: GobanEngine

    estimated_hard_score

    estimated_hard_score: number

    Protected Optional goban_callback

    goban_callback?: GobanBase

    Private groups

    groups: StoneStringBuilder

    Readonly height

    height: number = 19

    ownership

    ownership: number[][]

    player

    player: JGOFNumericPlayerColor

    prefer_remote

    prefer_remote: boolean

    removal

    removal: boolean[][]

    territory

    territory: number[][]

    tolerance

    tolerance: number

    trials

    trials: number

    when_ready

    when_ready: Promise<void>

    white

    white: PlayerScore = ...

    white_prisoners

    white_prisoners: number

    Readonly width

    width: number = 19

    winner

    winner: string = ""

    Methods

    boardEquals

    clearAutoScore

    clearRemoved

    cloneBoard

    cloneBoardState

    computeScoringLocations

    • computeScoringLocations(area_scoring): ScoringLocations

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

    Constructors

    constructor

    Properties

    amount

    amount: number = NaN

    autoscore

    autoscore: boolean = false

    Optional autoscored_needs_sealing

    autoscored_needs_sealing?: JGOFSealingIntersection[]

    Optional autoscored_removed

    autoscored_removed?: JGOFMove[]

    Optional autoscored_state

    autoscored_state?: JGOFNumericPlayerColor[][]

    black

    black: PlayerScore = ...

    black_prisoners

    black_prisoners: number

    board

    board: JGOFNumericPlayerColor[][]

    board_is_repeating

    board_is_repeating: boolean

    color_to_move

    color_to_move: "black" | "white"

    engine

    engine: GobanEngine

    estimated_hard_score

    estimated_hard_score: number

    Protected Optional goban_callback

    goban_callback?: GobanBase

    Private groups

    groups: StoneStringBuilder

    Readonly height

    height: number = 19

    ownership

    ownership: number[][]

    player

    player: JGOFNumericPlayerColor

    prefer_remote

    prefer_remote: boolean

    removal

    removal: boolean[][]

    territory

    territory: number[][]

    tolerance

    tolerance: number

    trials

    trials: number

    when_ready

    when_ready: Promise<void>

    white

    white: PlayerScore = ...

    white_prisoners

    white_prisoners: number

    Readonly width

    width: number = 19

    winner

    winner: string = ""

    Methods

    boardEquals

    clearAutoScore

    clearRemoved

    cloneBoard

    cloneBoardState

    computeScoringLocations

    countLiberties

    estimateScore

    • estimateScore(trials, tolerance, autoscore): Promise<void>

    • Parameters

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

      Returns Promise<void>

    Private estimateScoreLocal

    • estimateScoreLocal(trials, tolerance): Promise<void>

    • Parameters

      • trials: number
      • tolerance: number

      Returns Promise<void>

    Private estimateScoreRemote

    foreachNeighbor

    getGroup

    getNeighboringRawStoneStrings

    countLiberties

    estimateScore

    • estimateScore(trials, tolerance, autoscore): Promise<void>

    • Parameters

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

      Returns Promise<void>

    Private estimateScoreLocal

    • estimateScoreLocal(trials, tolerance): Promise<void>

    • Parameters

      • trials: number
      • tolerance: number

      Returns Promise<void>

    Private estimateScoreRemote

    foreachNeighbor

    getGroup

    getNeighboringRawStoneStrings

    getProbablyDead

    getRawStoneString

    getStoneRemovalString

    handleClick

    • handleClick(i, j, mod_key, press_duration_ms): void

    • Parameters

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

      Returns void

    score

    setRemoved

    getProbablyDead

    getRawStoneString

    getStoneRemovalString

    handleClick

    • handleClick(i, j, mod_key, press_duration_ms): void

    • Parameters

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

      Returns void

    score

    setRemoved

    • setRemoved(x, y, removed): 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

    toggleSingleGroupRemoval

    toggleSingleGroupRemoval

    • toggleSingleGroupRemoval(x, y, force_removal?): {
          group: RawStoneString;
          removed: boolean;
      }

    • Toggles a group of stones for removal or restoration.

      By default, if we are marking a group for removal but the group is almost certainly alive (two eyes, etc), this will result in a no-op, unless force_removal is set to true.

      -

      Parameters

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

      Returns {
          group: RawStoneString;
          removed: boolean;
      }

    updateEstimate

    • updateEstimate(estimated_score, ownership, score?): void

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructoramountautoscoreautoscored_needs_sealingautoscored_removedautoscored_stateblackblack_prisonersboardboard_is_repeatingcolor_to_moveengineestimated_hard_scoregoban_callbackgroupsheightownershipplayerprefer_remoteremovalterritorytolerancetrialswhen_readywhitewhite_prisonerswidthwinnerboardEqualsclearAutoScoreclearRemovedcloneBoardcloneBoardStatecomputeScoringLocationscountLibertiesestimateScoreestimateScoreLocalestimateScoreRemoteforeachNeighborgetGroupgetNeighboringRawStoneStringsgetProbablyDeadgetRawStoneStringgetStoneRemovalStringhandleClickscoresetRemovedtoggleSingleGroupRemovalupdateEstimate
    \ No newline at end of file +

    Parameters

    Returns {
        group: RawStoneString;
        removed: boolean;
    }

    updateEstimate

    Settings

    Member Visibility

    Theme

    On This Page

    constructoramountautoscoreautoscored_needs_sealingautoscored_removedautoscored_stateblackblack_prisonersboardboard_is_repeatingcolor_to_moveengineestimated_hard_scoregoban_callbackgroupsheightownershipplayerprefer_remoteremovalterritorytolerancetrialswhen_readywhitewhite_prisonerswidthwinnerboardEqualsclearAutoScoreclearRemovedcloneBoardcloneBoardStatecomputeScoringLocationscountLibertiesestimateScoreestimateScoreLocalestimateScoreRemoteforeachNeighborgetGroupgetNeighboringRawStoneStringsgetProbablyDeadgetRawStoneStringgetStoneRemovalStringhandleClickscoresetRemovedtoggleSingleGroupRemovalupdateEstimate
    \ No newline at end of file diff --git a/docs/classes/StoneString.html b/docs/classes/StoneString.html index 2002709c..2f10d158 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

    constructor +

    Constructors

    constructor

    Properties

    __added_neighbors color id @@ -18,12 +18,12 @@ foreachNeighboringString map size -

    Constructors

    constructor

    Properties

    Private __added_neighbors

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

    Type declaration

    • [group_id: number]: boolean

    Readonly color

    color: JGOFNumericPlayerColor

    Readonly id

    id: number

    Readonly intersections

    intersections: JGOFIntersection[]

    is_territory

    is_territory: boolean = false

    Private neighboring_space

    neighboring_space: StoneString[]

    Private neighboring_stone_strings

    neighboring_stone_strings: StoneString[]

    Readonly neighbors

    neighbors: StoneString[]

    territory_color

    territory_color: JGOFNumericPlayerColor = 0

    Methods

    _addNeighborGroup

    • _addNeighborGroup(group): void

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

      -

      Parameters

      Returns void

    _addStone

    • _addStone(x, y): void

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

      -

      Parameters

      • x: number
      • y: number

      Returns void

    _computeIsTerritory

    • _computeIsTerritory(): void

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

    Constructors

    constructor

    Properties

    Private __added_neighbors

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

    Type declaration

    • [group_id: number]: boolean

    Readonly color

    color: JGOFNumericPlayerColor

    Readonly id

    id: number

    Readonly intersections

    intersections: JGOFIntersection[]

    is_territory

    is_territory: boolean = false

    Private neighboring_space

    neighboring_space: StoneString[]

    Private neighboring_stone_strings

    neighboring_stone_strings: StoneString[]

    Readonly neighbors

    neighbors: StoneString[]

    territory_color

    territory_color: JGOFNumericPlayerColor = 0

    Methods

    _addNeighborGroup

    • _addNeighborGroup(group): void

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

      +

      Parameters

      Returns void

    _addStone

    • _addStone(x, y): void

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

      +

      Parameters

      • x: number
      • y: number

      Returns void

    _computeIsTerritory

    • _computeIsTerritory(): 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

    foreachNeighboringEmptyString

    • foreachNeighboringEmptyString(fn): void

    • Parameters

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

          • Parameters

            Returns void

      Returns void

    foreachNeighboringStoneString

    • foreachNeighboringStoneString(fn): void

    • Parameters

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

          • Parameters

            Returns void

      Returns void

    foreachNeighboringString

    • foreachNeighboringString(fn): void

    • Parameters

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

          • Parameters

            Returns void

      Returns void

    map

    size

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__added_neighborscoloridintersectionsis_territoryneighboring_spaceneighboring_stone_stringsneighborsterritory_color_addNeighborGroup_addStone_computeIsTerritoryforeachNeighboringEmptyStringforeachNeighboringStoneStringforeachNeighboringStringmapsize
    \ No newline at end of file +

    Returns void

    foreachNeighboringEmptyString

    foreachNeighboringStoneString

    foreachNeighboringString

    map

    size

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__added_neighborscoloridintersectionsis_territoryneighboring_spaceneighboring_stone_stringsneighborsterritory_color_addNeighborGroup_addStone_computeIsTerritoryforeachNeighboringEmptyStringforeachNeighboringStoneStringforeachNeighboringStringmapsize
    \ No newline at end of file diff --git a/docs/classes/StoneStringBuilder.html b/docs/classes/StoneStringBuilder.html index e8528b6a..f991abf2 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

    constructor

    Properties

    state stone_string_id_map stone_strings

    Methods

    foreachGroup getGroup -

    Constructors

    constructor

    Properties

    Private state

    state: BoardState

    Readonly stone_string_id_map

    stone_string_id_map: number[][]

    Readonly stone_strings

    stone_strings: StoneString[]

    Methods

    foreachGroup

    getGroup

    Settings

    Member Visibility

    Theme

    On This Page

    constructorstatestone_string_id_mapstone_stringsforeachGroupgetGroup
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private state

    state: BoardState

    Readonly stone_string_id_map

    stone_string_id_map: number[][]

    Readonly stone_strings

    stone_strings: StoneString[]

    Methods

    foreachGroup

    getGroup

    Settings

    Member Visibility

    Theme

    On This Page

    constructorstatestone_string_id_mapstone_stringsforeachGroupgetGroup
    \ No newline at end of file diff --git a/docs/classes/TestGoban.html b/docs/classes/TestGoban.html index 37cc673b..fc48142f 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

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    __board_redraw_pen_layer_timer __clock_timer? __draw_state @@ -250,31 +250,31 @@ getMoveTreeNumbering getSoundEnabled getSoundVolume -

    Constructors

    constructor

    Properties

    Protected __board_redraw_pen_layer_timer

    __board_redraw_pen_layer_timer: any = null

    Protected Optional __clock_timer

    __clock_timer?: Timeout

    Protected __draw_state

    __draw_state: string[][]

    Protected __last_pt

    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean

    Protected __update_move_tree

    __update_move_tree: any = null

    Protected analysis_move_counter

    analysis_move_counter: number

    Protected analysis_removal_last_position

    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number

    Protected Optional analysis_removal_state

    analysis_removal_state?: boolean

    Protected bounded_height

    bounded_height: number

    Protected bounded_width

    bounded_width: number

    Protected bounds

    bounds: GobanBounds

    chat_log

    chat_log: GobanChatLog = []

    Protected circle_radius

    circle_radius: number

    clock_should_be_paused_for_move_submission

    clock_should_be_paused_for_move_submission: boolean = false

    Protected Optional colored_circles

    colored_circles?: (undefined | ColoredCircle)[][]

    Protected conditional_path

    conditional_path: string = ""

    conditional_starting_color

    conditional_starting_color: "black" | "white" | "invalid" = "invalid"

    conditional_tree

    conditional_tree: ConditionalMoveTree = ...

    config

    config: GobanConfig

    Protected Optional connectToReviewSent

    connectToReviewSent?: boolean

    Protected Optional current_cmove

    current_cmove?: ConditionalMoveTree

    Protected currently_my_cmove

    currently_my_cmove: boolean = false

    Protected dirty_redraw

    dirty_redraw: any = null

    Protected disconnectedFromGame

    disconnectedFromGame: boolean = true

    Protected Optional display_width

    display_width?: number

    Protected done_loading_review

    done_loading_review: boolean = false

    Protected dont_draw_last_move

    dont_draw_last_move: boolean

    double_click_submit

    double_click_submit: boolean

    draw_bottom_labels

    draw_bottom_labels: boolean

    draw_left_labels

    draw_left_labels: boolean

    draw_right_labels

    draw_right_labels: boolean

    draw_top_labels

    draw_top_labels: boolean

    Protected Optional edit_color

    edit_color?: "black" | "white"

    engine

    engine: GobanEngine

    Protected errorHandler

    errorHandler: ((e) => void)

    Type declaration

      • (e): void

      • Parameters

        • e: Error

        Returns void

    Readonly game_id

    game_id: number

    Protected game_type

    game_type: string

    Protected Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Readonly goban_id

    goban_id: number = ++last_goban_id

    Base fields *

    -

    Protected Optional heatmap

    heatmap?: NumberMatrix

    height

    height: number

    Protected highlight_movetree_moves

    highlight_movetree_moves: boolean

    Protected interactive

    interactive: boolean

    Protected isInPushedAnalysis

    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerController

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerOwner

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected label_character

    label_character: string

    Protected label_mark

    label_mark: string = "[UNSET]"

    Optional last_clock

    last_clock?: AdHocClock

    Optional last_emitted_clock

    last_emitted_clock?: JGOFClockWithTransmitting

    Protected Optional last_hover_square

    last_hover_square?: JGOFIntersection

    Protected Optional last_move

    last_move?: MoveTree

    Protected last_move_radius

    last_move_radius: number

    Protected last_paused_by_player_state

    last_paused_by_player_state: null | boolean = null

    Protected last_paused_state

    last_paused_state: null | boolean = null

    Protected Optional last_phase

    last_phase?: GobanEnginePhase

    Protected last_review_message

    last_review_message: ReviewMessage

    Protected Optional last_sound_played_for_a_stone_placement

    last_sound_played_for_a_stone_placement?: string

    Protected last_stone_sound

    last_stone_sound: number

    Protected leavePushedAnalysis

    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void

      • Returns void

    Protected Optional marked_analysis_score

    marked_analysis_score?: boolean[][]

    Protected Optional move_selected

    move_selected?: JGOFIntersection

    Protected no_display

    no_display: boolean

    Protected Optional onError

    onError?: ((error) => void)

    Type declaration

      • (error): void

      • Parameters

        • error: Error

        Returns void

    Protected on_game_screen

    on_game_screen: boolean

    one_click_submit

    one_click_submit: boolean

    Protected original_square_size

    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Protected parent

    parent: HTMLElement

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    pen_marks

    pen_marks: any[]

    Protected player_id

    player_id: number

    Protected Optional preloaded_data

    preloaded_data?: GobanConfig

    previous_mode

    previous_mode: string

    Protected puzzle_autoplace_delay

    puzzle_autoplace_delay: number

    Protected restrict_moves_to_movetree

    restrict_moves_to_movetree: boolean

    Protected review_had_gamedata

    review_had_gamedata: boolean

    Readonly review_id

    review_id: number

    Protected scoring_mode

    scoring_mode: boolean | "stalling-scoring-mode"

    Protected Optional sendLatencyTimer

    sendLatencyTimer?: Timeout

    sent_timed_out_message

    sent_timed_out_message: boolean = false

    Protected shift_key_is_down

    shift_key_is_down: boolean

    Protected show_move_numbers

    show_move_numbers: boolean

    Protected show_variation_move_numbers

    show_variation_move_numbers: boolean

    showing_scores

    showing_scores: boolean = false

    Protected socket

    socket: GobanSocket<ClientToServer, ServerToClient>

    Protected socket_event_bindings

    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

    Protected square_size

    square_size: number = 10

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Protected stone_placement_enabled

    stone_placement_enabled: boolean

    Protected Optional stone_removal_auto_scoring_done

    stone_removal_auto_scoring_done?: boolean = false

    variation_stone_opacity

    variation_stone_opacity: number

    visual_undo_request_indicator

    visual_undo_request_indicator: boolean

    width

    width: number

    Static THEMES

    THEMES: ThemesInterface = THEMES

    Static THEMES_SORTED

    THEMES_SORTED: {
        black: GobanTheme[];
        board: GobanTheme[];
        white: GobanTheme[];
        [key: string]: GobanTheme[];
    } = THEMES_SORTED

    Type declaration

    Static setCallbacks

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

    Type declaration

      • (newCallbacks): void

      • Set's callback functions to be called in various situations. You can set any +

    Constructors

    constructor

    Properties

    Protected __board_redraw_pen_layer_timer

    __board_redraw_pen_layer_timer: any = null

    Protected Optional __clock_timer

    __clock_timer?: Timeout

    Protected __draw_state

    __draw_state: string[][]

    Protected __last_pt

    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean

    Protected __update_move_tree

    __update_move_tree: any = null

    Protected analysis_move_counter

    analysis_move_counter: number

    Protected analysis_removal_last_position

    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number

    Protected Optional analysis_removal_state

    analysis_removal_state?: boolean

    Protected bounded_height

    bounded_height: number

    Protected bounded_width

    bounded_width: number

    Protected bounds

    bounds: GobanBounds

    chat_log

    chat_log: GobanChatLog = []

    Protected circle_radius

    circle_radius: number

    clock_should_be_paused_for_move_submission

    clock_should_be_paused_for_move_submission: boolean = false

    Protected Optional colored_circles

    colored_circles?: (undefined | ColoredCircle)[][]

    Protected conditional_path

    conditional_path: string = ""

    conditional_starting_color

    conditional_starting_color: "black" | "white" | "invalid" = "invalid"

    conditional_tree

    conditional_tree: ConditionalMoveTree = ...

    config

    config: GobanConfig

    Protected Optional connectToReviewSent

    connectToReviewSent?: boolean

    Protected Optional current_cmove

    current_cmove?: ConditionalMoveTree

    Protected currently_my_cmove

    currently_my_cmove: boolean = false

    Protected dirty_redraw

    dirty_redraw: any = null

    Protected disconnectedFromGame

    disconnectedFromGame: boolean = true

    Protected Optional display_width

    display_width?: number

    Protected done_loading_review

    done_loading_review: boolean = false

    Protected dont_draw_last_move

    dont_draw_last_move: boolean

    double_click_submit

    double_click_submit: boolean

    draw_bottom_labels

    draw_bottom_labels: boolean

    draw_left_labels

    draw_left_labels: boolean

    draw_right_labels

    draw_right_labels: boolean

    draw_top_labels

    draw_top_labels: boolean

    Protected Optional edit_color

    edit_color?: "black" | "white"

    engine

    engine: GobanEngine

    Protected errorHandler

    errorHandler: ((e) => void)

    Type declaration

      • (e): void

      • Parameters

        • e: Error

        Returns void

    Readonly game_id

    game_id: number

    Protected game_type

    game_type: string

    Protected Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Readonly goban_id

    goban_id: number = ++last_goban_id

    Base fields *

    +

    Protected Optional heatmap

    heatmap?: NumberMatrix

    height

    height: number

    Protected highlight_movetree_moves

    highlight_movetree_moves: boolean

    Protected interactive

    interactive: boolean

    Protected isInPushedAnalysis

    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerController

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerOwner

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected label_character

    label_character: string

    Protected label_mark

    label_mark: string = "[UNSET]"

    Optional last_clock

    last_clock?: AdHocClock

    Optional last_emitted_clock

    last_emitted_clock?: JGOFClockWithTransmitting

    Protected Optional last_hover_square

    last_hover_square?: JGOFIntersection

    Protected Optional last_move

    last_move?: MoveTree

    Protected last_move_radius

    last_move_radius: number

    Protected last_paused_by_player_state

    last_paused_by_player_state: null | boolean = null

    Protected last_paused_state

    last_paused_state: null | boolean = null

    Protected Optional last_phase

    last_phase?: GobanEnginePhase

    Protected last_review_message

    last_review_message: ReviewMessage

    Protected Optional last_sound_played_for_a_stone_placement

    last_sound_played_for_a_stone_placement?: string

    Protected last_stone_sound

    last_stone_sound: number

    Protected leavePushedAnalysis

    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void

      • Returns void

    Protected Optional marked_analysis_score

    marked_analysis_score?: boolean[][]

    Protected Optional move_selected

    move_selected?: JGOFIntersection

    Protected no_display

    no_display: boolean

    Protected Optional onError

    onError?: ((error) => void)

    Type declaration

      • (error): void

      • Parameters

        • error: Error

        Returns void

    Protected on_game_screen

    on_game_screen: boolean

    one_click_submit

    one_click_submit: boolean

    Protected original_square_size

    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Protected parent

    parent: HTMLElement

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    pen_marks

    pen_marks: any[]

    Protected player_id

    player_id: number

    Protected Optional preloaded_data

    preloaded_data?: GobanConfig

    previous_mode

    previous_mode: string

    Protected puzzle_autoplace_delay

    puzzle_autoplace_delay: number

    Protected restrict_moves_to_movetree

    restrict_moves_to_movetree: boolean

    Protected review_had_gamedata

    review_had_gamedata: boolean

    Readonly review_id

    review_id: number

    Protected scoring_mode

    scoring_mode: boolean | "stalling-scoring-mode"

    Protected Optional sendLatencyTimer

    sendLatencyTimer?: Timeout

    sent_timed_out_message

    sent_timed_out_message: boolean = false

    Protected shift_key_is_down

    shift_key_is_down: boolean

    Protected show_move_numbers

    show_move_numbers: boolean

    Protected show_variation_move_numbers

    show_variation_move_numbers: boolean

    showing_scores

    showing_scores: boolean = false

    Protected socket

    socket: GobanSocket<ClientToServer, ServerToClient>

    Protected socket_event_bindings

    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

    Protected square_size

    square_size: number = 10

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Protected stone_placement_enabled

    stone_placement_enabled: boolean

    Protected Optional stone_removal_auto_scoring_done

    stone_removal_auto_scoring_done?: boolean = false

    variation_stone_opacity

    variation_stone_opacity: number

    visual_undo_request_indicator

    visual_undo_request_indicator: boolean

    width

    width: number

    Static THEMES

    THEMES: ThemesInterface = THEMES

    Static THEMES_SORTED

    THEMES_SORTED: {
        black: GobanTheme[];
        board: GobanTheme[];
        white: GobanTheme[];
        [key: string]: GobanTheme[];
    } = THEMES_SORTED

    Type declaration

    Static setCallbacks

    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

    Static setTranslations

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

    Type declaration

      • (_catalog, _debug_mode?): void

      • Parameters

        Returns void

    Accessors

    analyze_subtool

    • get analyze_subtool(): string

    • Returns string

    • set analyze_subtool(analyze_subtool): void

    • Parameters

      • analyze_subtool: string

      Returns void

    analyze_tool

    destroyed

    • get destroyed(): boolean

    • Returns boolean

    is_game_record

    • get is_game_record(): boolean

    • True if the game is a game record of a real life game

      -

      Returns boolean

    mode

    review_controller_id

    • 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

    review_owner_id

    • 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

    score_estimator

    submit_move

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

    • Returns undefined | (() => void)

    • set submit_move(submit_move): void

    • Parameters

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

      Returns void

    title

    Methods

    Protected _socket_on

    acceptRemovedStones

    acceptUndo

    Protected annul

    cancelGame

    cancelUndo

    clearAnalysisDrawing

    clearAnalysisScores

    clearMark

    clearMessage

    Protected clearPendingResignation

    Protected clearTransientMark

    computeMetrics

    Protected computeNewPlayerClock

    Protected connect

    debouncedEmitCapturedStones

    decodeMoves

    • decodeMoves(move_obj): JGOFMove[]

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

      Parameters

      Returns void

    Static setTranslations

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

    Type declaration

      • (_catalog, _debug_mode?): void

      • Parameters

        Returns void

    Accessors

    analyze_subtool

    • get analyze_subtool(): string

    • Returns string

    • set analyze_subtool(analyze_subtool): void

    • Parameters

      • analyze_subtool: string

      Returns void

    analyze_tool

    destroyed

    • get destroyed(): boolean

    • Returns boolean

    is_game_record

    • get is_game_record(): boolean

    • True if the game is a game record of a real life game

      +

      Returns boolean

    mode

    review_controller_id

    • 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

    review_owner_id

    • 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

    score_estimator

    submit_move

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

    • Returns undefined | (() => void)

    • set submit_move(submit_move): void

    • Parameters

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

      Returns void

    title

    Methods

    Protected _socket_on

    acceptRemovedStones

    acceptUndo

    Protected annul

    cancelGame

    cancelUndo

    clearAnalysisDrawing

    clearAnalysisScores

    clearMark

    clearMessage

    Protected clearPendingResignation

    Protected clearTransientMark

    computeMetrics

    Protected computeNewPlayerClock

    Protected connect

    debouncedEmitCapturedStones

    decodeMoves

    decodePrettyCoordinates

    decodePrettyCoordinates

    • decodePrettyCoordinates(coordinates): JGOFMove

    • Decodes a move string like "A11" into a move object like {x: 0, y: 10}. Also handles the special cases like ".." and "pass" which map to {x: -1, y: -1}.

      -

      Parameters

      • coordinates: string

      Returns JGOFMove

    Protected defaultConfig

    deleteBranch

    deleteConditionalPath

    deleteCustomMark

    destroy

    Protected disableDrawing

    disablePen

    disableStonePlacement

    Protected disconnect

    drawPenMarks

    drawSquare

    editPlaceByPrettyCoordinates

    Protected enableDrawing

    enablePen

    enableStonePlacement

    encodeMove

    encodeMoves

    followConditionalPath

    Protected followConditionalSegment

    Protected getAnalysisScoreColorAtLocation

    Protected getClockDrift

    Protected getCoordinateDisplaySystem

    getCurrentConditionalPath

    getLastReviewMessage

    Protected getLocation

    getMarks

    Protected getNetworkLatency

    getPlayerRelativeLatency

    Protected getSelectedThemes

    Protected getShowMoveNumbers

    Protected getShowVariationMoveNumbers

    Protected getWidthForSquareSize

    giveReviewControl

    hideScores

    Protected incrementLabelCharacter

    isAnalysisDisabled

    isCurrentUserAPlayer

    Protected isLastOfficialMove

    jumpToLastOfficialMove

    load

    markAnalysisScores

    Protected defaultConfig

    deleteBranch

    deleteConditionalPath

    deleteCustomMark

    destroy

    Protected disableDrawing

    disablePen

    disableStonePlacement

    Protected disconnect

    drawPenMarks

    drawSquare

    editPlaceByPrettyCoordinates

    Protected enableDrawing

    enablePen

    enableStonePlacement

    encodeMove

    encodeMoves

    followConditionalPath

    Protected followConditionalSegment

    Protected getAnalysisScoreColorAtLocation

    Protected getClockDrift

    Protected getCoordinateDisplaySystem

    getCurrentConditionalPath

    getLastReviewMessage

    Protected getLocation

    getMarks

    Protected getNetworkLatency

    getPlayerRelativeLatency

    Protected getSelectedThemes

    Protected getShowMoveNumbers

    Protected getShowVariationMoveNumbers

    Protected getWidthForSquareSize

    giveReviewControl

    hideScores

    Protected incrementLabelCharacter

    isAnalysisDisabled

    isCurrentUserAPlayer

    Protected isLastOfficialMove

    jumpToLastOfficialMove

    load

    markAnalysisScores

    • markAnalysisScores(): void

    • 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

    markDirty

    move_tree_redraw

    nextSibling

    Protected onAnalysisScoringMove

    Protected onAnalysisScoringStart

    Protected onAnalysisToggleStoneRemoval

    pass

    pauseGame

    performStoneRemovalAutoScoring

    placeByPrettyCoordinates

    Protected playMovementSound

    Protected post_config_constructor

    markDirty

    move_tree_redraw

    nextSibling

    Protected onAnalysisScoringMove

    Protected onAnalysisScoringStart

    Protected onAnalysisToggleStoneRemoval

    pass

    pauseGame

    performStoneRemovalAutoScoring

    placeByPrettyCoordinates

    Protected playMovementSound

    Protected post_config_constructor

    • post_config_constructor(): GobanEngine

    • 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

    prettyCoordinates

    prevSibling

    Protected putAnalysisRemovalAtLocation

    Protected putAnalysisScoreColorAtLocation

    Protected putOrClearLabel

    redraw

    rejectRemovedStones

    requestUndo

    resign

    resumeGame

    saveConditionalMoves

    Protected scheduleRedrawPenLayer

    sendChat

    Protected sendMove

    Protected sendPendingResignation

    sendPreventEscaping

    sendPreventStalling

    sendTimedOut

    prettyCoordinates

    prevSibling

    Protected putAnalysisRemovalAtLocation

    Protected putAnalysisScoreColorAtLocation

    Protected putOrClearLabel

    redraw

    rejectRemovedStones

    requestUndo

    resign

    resumeGame

    saveConditionalMoves

    Protected scheduleRedrawPenLayer

    sendChat

    Protected sendMove

    Protected sendPendingResignation

    sendPreventEscaping

    sendPreventStalling

    sendTimedOut

    • sendTimedOut(): void

    • 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

    set

    setAnalyzeTool

    setBounds

    setColoredCircles

    setColoredMarks

    • setColoredMarks(colored_marks): void

    • Parameters

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

      Returns void

    setConditionalTree

    setCustomMark

    setEditColor

    setForRemoval

    • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

    setGameClock

    setHeatmap

    setLabelCharacter

    Protected setLabelCharacterFromMarks

    setLabelPosition

    Protected setLastOfficialMove

    setLastReviewMessage

    Protected setLetterMark

    setMark

    setMarkByPrettyCoordinates

    Protected setMarkColor

    setMarks

    set

    setAnalyzeTool

    setBounds

    setColoredCircles

    setColoredMarks

    • setColoredMarks(colored_marks): void

    • Parameters

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

      Returns void

    setConditionalTree

    setCustomMark

    setEditColor

    setForRemoval

    • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

    setGameClock

    setHeatmap

    setLabelCharacter

    Protected setLabelCharacterFromMarks

    setLabelPosition

    Protected setLastOfficialMove

    setLastReviewMessage

    Protected setLetterMark

    setMark

    setMarkByPrettyCoordinates

    Protected setMarkColor

    setMarks

    • setMarks(marks, dont_draw?): 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

    setMode

    setModeDeferred

    setMoveTreeContainer

    setScoringMode

    setSquareSize

    setSquareSizeBasedOnDisplayWidth

    setState

    • setState(): 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

    setMode

    setModeDeferred

    setMoveTreeContainer

    setScoringMode

    setSquareSize

    setSquareSizeBasedOnDisplayWidth

    setState

    setStrictSekiMode

    Protected setSubmit

    setSubscriptMark

    Protected setTheme

    Protected setTitle

    setToPreviousMode

    Protected setTransientMark

    showFirst

    showMessage

    • showMessage(msg_id, parameters?, timeout?): void

    • Parameters

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

      Returns void

    showNext

    showPrevious

    showScores

    showStallingScoreEstimate

    syncReviewMove

    Protected toggleMark

    • toggleMark(x, y, mark, force_label?, force_put?): boolean

    • Parameters

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

      Returns boolean

    Protected updateMoveTree

    Protected updateOrRedrawMoveTree

    updatePlayerToMoveTitle

    updateScoreEstimation

    updateTitleAndStonePlacement

    Protected xy2ij

    • xy2ij(x, y, anti_slip?): {
          i: number;
          j: number;
          valid: boolean;
      }

    • Parameters

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

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

      • i: number
      • j: number
      • valid: boolean

    Static getCDNReleaseBase

    Static getMoveTreeNumbering

    Static getSoundEnabled

    Static getSoundVolume

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_statebounded_heightbounded_widthboundschat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentcurrent_cmovecurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsedit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklast_clocklast_emitted_clocklast_hover_squarelast_movelast_move_radiuslast_paused_by_player_statelast_paused_statelast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremove_selectedno_displayonErroron_game_screenone_click_submitoriginal_square_sizeparentpause_controlpaused_sincepen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donevariation_stone_opacityvisual_undo_request_indicatorwidthTHEMESTHEMES_SORTEDsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle_socket_onacceptRemovedStonesacceptUndoannulcancelGamecancelUndoclearAnalysisDrawingclearAnalysisScoresclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeMetricscomputeNewPlayerClockconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydisableDrawingdisablePendisableStonePlacementdisconnectdrawPenMarksdrawSquareeditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetAnalysisScoreColorAtLocationgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkAnalysisScoresmarkDirtymove_tree_redrawnextSiblingonAnalysisScoringMoveonAnalysisScoringStartonAnalysisToggleStoneRemovalpasspauseGameperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingputAnalysisRemovalAtLocationputAnalysisScoreColorAtLocationputOrClearLabelredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLabelPositionsetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetScoringModesetSquareSizesetSquareSizeBasedOnDisplayWidthsetStatesetStrictSekiModesetSubmitsetSubscriptMarksetThemesetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementxy2ijgetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
    \ No newline at end of file +

    Returns void

    setStrictSekiMode

    Protected setSubmit

    setSubscriptMark

    Protected setTheme

    Protected setTitle

    setToPreviousMode

    Protected setTransientMark

    showFirst

    showMessage

    showNext

    showPrevious

    showScores

    showStallingScoreEstimate

    syncReviewMove

    Protected toggleMark

    Protected updateMoveTree

    Protected updateOrRedrawMoveTree

    updatePlayerToMoveTitle

    updateScoreEstimation

    updateTitleAndStonePlacement

    Protected xy2ij

    Static getCDNReleaseBase

    Static getMoveTreeNumbering

    Static getSoundEnabled

    Static getSoundVolume

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_statebounded_heightbounded_widthboundschat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentcurrent_cmovecurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsedit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklast_clocklast_emitted_clocklast_hover_squarelast_movelast_move_radiuslast_paused_by_player_statelast_paused_statelast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremove_selectedno_displayonErroron_game_screenone_click_submitoriginal_square_sizeparentpause_controlpaused_sincepen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donevariation_stone_opacityvisual_undo_request_indicatorwidthTHEMESTHEMES_SORTEDsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle_socket_onacceptRemovedStonesacceptUndoannulcancelGamecancelUndoclearAnalysisDrawingclearAnalysisScoresclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeMetricscomputeNewPlayerClockconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydisableDrawingdisablePendisableStonePlacementdisconnectdrawPenMarksdrawSquareeditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetAnalysisScoreColorAtLocationgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkAnalysisScoresmarkDirtymove_tree_redrawnextSiblingonAnalysisScoringMoveonAnalysisScoringStartonAnalysisToggleStoneRemovalpasspauseGameperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingputAnalysisRemovalAtLocationputAnalysisScoreColorAtLocationputOrClearLabelredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLabelPositionsetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetScoringModesetSquareSizesetSquareSizeBasedOnDisplayWidthsetStatesetStrictSekiModesetSubmitsetSubscriptMarksetThemesetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementxy2ijgetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
    \ No newline at end of file diff --git a/docs/classes/_internal_.OGSConnectivity.html b/docs/classes/_internal_.OGSConnectivity.html index 6a01d70b..2424947f 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

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    __board_redraw_pen_layer_timer __clock_timer? __draw_state @@ -235,27 +235,27 @@ getMoveTreeNumbering getSoundEnabled getSoundVolume -

    Constructors

    constructor

    Properties

    Protected __board_redraw_pen_layer_timer

    __board_redraw_pen_layer_timer: any = null

    Protected Optional __clock_timer

    __clock_timer?: Timeout

    Protected __draw_state

    __draw_state: string[][]

    Protected __last_pt

    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean

    Protected __update_move_tree

    __update_move_tree: any = null

    Protected analysis_move_counter

    analysis_move_counter: number

    Protected analysis_removal_last_position

    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number

    Protected Optional analysis_removal_state

    analysis_removal_state?: boolean

    Protected bounded_height

    bounded_height: number

    Protected bounded_width

    bounded_width: number

    Protected bounds

    bounds: GobanBounds

    chat_log

    chat_log: GobanChatLog = []

    Protected circle_radius

    circle_radius: number

    clock_should_be_paused_for_move_submission

    clock_should_be_paused_for_move_submission: boolean = false

    Protected Optional colored_circles

    colored_circles?: (undefined | ColoredCircle)[][]

    Protected conditional_path

    conditional_path: string = ""

    conditional_starting_color

    conditional_starting_color: "black" | "white" | "invalid" = "invalid"

    conditional_tree

    conditional_tree: ConditionalMoveTree = ...

    config

    config: GobanConfig

    Protected Optional connectToReviewSent

    connectToReviewSent?: boolean

    Protected Optional current_cmove

    current_cmove?: ConditionalMoveTree

    Protected currently_my_cmove

    currently_my_cmove: boolean = false

    Protected dirty_redraw

    dirty_redraw: any = null

    Protected disconnectedFromGame

    disconnectedFromGame: boolean = true

    Protected Optional display_width

    display_width?: number

    Protected done_loading_review

    done_loading_review: boolean = false

    Protected dont_draw_last_move

    dont_draw_last_move: boolean

    double_click_submit

    double_click_submit: boolean

    draw_bottom_labels

    draw_bottom_labels: boolean

    draw_left_labels

    draw_left_labels: boolean

    draw_right_labels

    draw_right_labels: boolean

    draw_top_labels

    draw_top_labels: boolean

    Protected Optional edit_color

    edit_color?: "black" | "white"

    Abstract engine

    engine: GobanEngine

    Protected errorHandler

    errorHandler: ((e) => void)

    Type declaration

      • (e): void

      • Parameters

        • e: Error

        Returns void

    Readonly game_id

    game_id: number

    Protected game_type

    game_type: string

    Protected Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Readonly goban_id

    goban_id: number = ++last_goban_id

    Base fields *

    -

    Protected Optional heatmap

    heatmap?: NumberMatrix

    height

    height: number

    Protected highlight_movetree_moves

    highlight_movetree_moves: boolean

    Protected interactive

    interactive: boolean

    Protected isInPushedAnalysis

    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerController

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerOwner

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected label_character

    label_character: string

    Protected label_mark

    label_mark: string = "[UNSET]"

    Optional last_clock

    last_clock?: AdHocClock

    Optional last_emitted_clock

    last_emitted_clock?: JGOFClockWithTransmitting

    Protected Optional last_hover_square

    last_hover_square?: JGOFIntersection

    Protected Optional last_move

    last_move?: MoveTree

    Protected last_move_radius

    last_move_radius: number

    Protected last_paused_by_player_state

    last_paused_by_player_state: null | boolean = null

    Protected last_paused_state

    last_paused_state: null | boolean = null

    Protected Optional last_phase

    last_phase?: GobanEnginePhase

    Protected last_review_message

    last_review_message: ReviewMessage

    Protected Optional last_sound_played_for_a_stone_placement

    last_sound_played_for_a_stone_placement?: string

    Protected last_stone_sound

    last_stone_sound: number

    Protected leavePushedAnalysis

    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void

      • Returns void

    Protected Optional marked_analysis_score

    marked_analysis_score?: boolean[][]

    Protected Optional move_selected

    move_selected?: JGOFIntersection

    Protected no_display

    no_display: boolean

    Protected Optional onError

    onError?: ((error) => void)

    Type declaration

      • (error): void

      • Parameters

        • error: Error

        Returns void

    Protected on_game_screen

    on_game_screen: boolean

    one_click_submit

    one_click_submit: boolean

    Protected original_square_size

    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    pen_marks

    pen_marks: any[]

    Protected player_id

    player_id: number

    Protected Optional preloaded_data

    preloaded_data?: GobanConfig

    previous_mode

    previous_mode: string

    Protected puzzle_autoplace_delay

    puzzle_autoplace_delay: number

    Protected restrict_moves_to_movetree

    restrict_moves_to_movetree: boolean

    Protected review_had_gamedata

    review_had_gamedata: boolean

    Readonly review_id

    review_id: number

    Protected scoring_mode

    scoring_mode: boolean | "stalling-scoring-mode"

    Protected Optional sendLatencyTimer

    sendLatencyTimer?: Timeout

    sent_timed_out_message

    sent_timed_out_message: boolean = false

    Protected shift_key_is_down

    shift_key_is_down: boolean

    Protected show_move_numbers

    show_move_numbers: boolean

    Protected show_variation_move_numbers

    show_variation_move_numbers: boolean

    showing_scores

    showing_scores: boolean = false

    Protected socket

    socket: GobanSocket<ClientToServer, ServerToClient>

    Protected socket_event_bindings

    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

    Protected square_size

    square_size: number = 10

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Protected stone_placement_enabled

    stone_placement_enabled: boolean

    Protected Optional stone_removal_auto_scoring_done

    stone_removal_auto_scoring_done?: boolean = false

    variation_stone_opacity

    variation_stone_opacity: number

    visual_undo_request_indicator

    visual_undo_request_indicator: boolean

    width

    width: number

    Static setCallbacks

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

    Type declaration

      • (newCallbacks): void

      • Set's callback functions to be called in various situations. You can set any +

    Constructors

    constructor

    Properties

    Protected __board_redraw_pen_layer_timer

    __board_redraw_pen_layer_timer: any = null

    Protected Optional __clock_timer

    __clock_timer?: Timeout

    Protected __draw_state

    __draw_state: string[][]

    Protected __last_pt

    __last_pt: {
        i: number;
        j: number;
        valid: boolean;
    } = ...

    Type declaration

    • i: number
    • j: number
    • valid: boolean

    Protected __update_move_tree

    __update_move_tree: any = null

    Protected analysis_move_counter

    analysis_move_counter: number

    Protected analysis_removal_last_position

    analysis_removal_last_position: {
        i: number;
        j: number;
    } = ...

    Type declaration

    • i: number
    • j: number

    Protected Optional analysis_removal_state

    analysis_removal_state?: boolean

    Protected bounded_height

    bounded_height: number

    Protected bounded_width

    bounded_width: number

    Protected bounds

    bounds: GobanBounds

    chat_log

    chat_log: GobanChatLog = []

    Protected circle_radius

    circle_radius: number

    clock_should_be_paused_for_move_submission

    clock_should_be_paused_for_move_submission: boolean = false

    Protected Optional colored_circles

    colored_circles?: (undefined | ColoredCircle)[][]

    Protected conditional_path

    conditional_path: string = ""

    conditional_starting_color

    conditional_starting_color: "black" | "white" | "invalid" = "invalid"

    conditional_tree

    conditional_tree: ConditionalMoveTree = ...

    config

    config: GobanConfig

    Protected Optional connectToReviewSent

    connectToReviewSent?: boolean

    Protected Optional current_cmove

    current_cmove?: ConditionalMoveTree

    Protected currently_my_cmove

    currently_my_cmove: boolean = false

    Protected dirty_redraw

    dirty_redraw: any = null

    Protected disconnectedFromGame

    disconnectedFromGame: boolean = true

    Protected Optional display_width

    display_width?: number

    Protected done_loading_review

    done_loading_review: boolean = false

    Protected dont_draw_last_move

    dont_draw_last_move: boolean

    double_click_submit

    double_click_submit: boolean

    draw_bottom_labels

    draw_bottom_labels: boolean

    draw_left_labels

    draw_left_labels: boolean

    draw_right_labels

    draw_right_labels: boolean

    draw_top_labels

    draw_top_labels: boolean

    Protected Optional edit_color

    edit_color?: "black" | "white"

    Abstract engine

    engine: GobanEngine

    Protected errorHandler

    errorHandler: ((e) => void)

    Type declaration

      • (e): void

      • Parameters

        • e: Error

        Returns void

    Readonly game_id

    game_id: number

    Protected game_type

    game_type: string

    Protected Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Readonly goban_id

    goban_id: number = ++last_goban_id

    Base fields *

    +

    Protected Optional heatmap

    heatmap?: NumberMatrix

    height

    height: number

    Protected highlight_movetree_moves

    highlight_movetree_moves: boolean

    Protected interactive

    interactive: boolean

    Protected isInPushedAnalysis

    isInPushedAnalysis: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerController

    isPlayerController: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected isPlayerOwner

    isPlayerOwner: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Protected label_character

    label_character: string

    Protected label_mark

    label_mark: string = "[UNSET]"

    Optional last_clock

    last_clock?: AdHocClock

    Optional last_emitted_clock

    last_emitted_clock?: JGOFClockWithTransmitting

    Protected Optional last_hover_square

    last_hover_square?: JGOFIntersection

    Protected Optional last_move

    last_move?: MoveTree

    Protected last_move_radius

    last_move_radius: number

    Protected last_paused_by_player_state

    last_paused_by_player_state: null | boolean = null

    Protected last_paused_state

    last_paused_state: null | boolean = null

    Protected Optional last_phase

    last_phase?: GobanEnginePhase

    Protected last_review_message

    last_review_message: ReviewMessage

    Protected Optional last_sound_played_for_a_stone_placement

    last_sound_played_for_a_stone_placement?: string

    Protected last_stone_sound

    last_stone_sound: number

    Protected leavePushedAnalysis

    leavePushedAnalysis: (() => void)

    Type declaration

      • (): void

      • Returns void

    Protected Optional marked_analysis_score

    marked_analysis_score?: boolean[][]

    Protected Optional move_selected

    move_selected?: JGOFIntersection

    Protected no_display

    no_display: boolean

    Protected Optional onError

    onError?: ((error) => void)

    Type declaration

      • (error): void

      • Parameters

        • error: Error

        Returns void

    Protected on_game_screen

    on_game_screen: boolean

    one_click_submit

    one_click_submit: boolean

    Protected original_square_size

    original_square_size: number | ((goban) => number) | "auto"

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    pen_marks

    pen_marks: any[]

    Protected player_id

    player_id: number

    Protected Optional preloaded_data

    preloaded_data?: GobanConfig

    previous_mode

    previous_mode: string

    Protected puzzle_autoplace_delay

    puzzle_autoplace_delay: number

    Protected restrict_moves_to_movetree

    restrict_moves_to_movetree: boolean

    Protected review_had_gamedata

    review_had_gamedata: boolean

    Readonly review_id

    review_id: number

    Protected scoring_mode

    scoring_mode: boolean | "stalling-scoring-mode"

    Protected Optional sendLatencyTimer

    sendLatencyTimer?: Timeout

    sent_timed_out_message

    sent_timed_out_message: boolean = false

    Protected shift_key_is_down

    shift_key_is_down: boolean

    Protected show_move_numbers

    show_move_numbers: boolean

    Protected show_variation_move_numbers

    show_variation_move_numbers: boolean

    showing_scores

    showing_scores: boolean = false

    Protected socket

    socket: GobanSocket<ClientToServer, ServerToClient>

    Protected socket_event_bindings

    socket_event_bindings: [keyof GobanSocketEvents, (() => void)][] = []

    Protected square_size

    square_size: number = 10

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Protected stone_placement_enabled

    stone_placement_enabled: boolean

    Protected Optional stone_removal_auto_scoring_done

    stone_removal_auto_scoring_done?: boolean = false

    variation_stone_opacity

    variation_stone_opacity: number

    visual_undo_request_indicator

    visual_undo_request_indicator: boolean

    width

    width: number

    Static setCallbacks

    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

    Static setTranslations

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

    Type declaration

      • (_catalog, _debug_mode?): void

      • Parameters

        Returns void

    Accessors

    analyze_subtool

    • get analyze_subtool(): string

    • Returns string

    • set analyze_subtool(analyze_subtool): void

    • Parameters

      • analyze_subtool: string

      Returns void

    analyze_tool

    destroyed

    • get destroyed(): boolean

    • Returns boolean

    is_game_record

    • get is_game_record(): boolean

    • True if the game is a game record of a real life game

      -

      Returns boolean

    mode

    review_controller_id

    • 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

    review_owner_id

    • 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

    score_estimator

    submit_move

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

    • Returns undefined | (() => void)

    • set submit_move(submit_move): void

    • Parameters

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

      Returns void

    title

    Methods

    Protected _socket_on

    acceptRemovedStones

    acceptUndo

    Protected annul

    cancelGame

    cancelUndo

    Abstract clearAnalysisDrawing

    clearMark

    Abstract clearMessage

    Protected clearPendingResignation

    Protected clearTransientMark

    Protected computeNewPlayerClock

    Protected connect

    debouncedEmitCapturedStones

    decodeMoves

    • decodeMoves(move_obj): JGOFMove[]

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

      Parameters

      Returns void

    Static setTranslations

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

    Type declaration

      • (_catalog, _debug_mode?): void

      • Parameters

        Returns void

    Accessors

    analyze_subtool

    • get analyze_subtool(): string

    • Returns string

    • set analyze_subtool(analyze_subtool): void

    • Parameters

      • analyze_subtool: string

      Returns void

    analyze_tool

    destroyed

    • get destroyed(): boolean

    • Returns boolean

    is_game_record

    • get is_game_record(): boolean

    • True if the game is a game record of a real life game

      +

      Returns boolean

    mode

    review_controller_id

    • 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

    review_owner_id

    • 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

    score_estimator

    submit_move

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

    • Returns undefined | (() => void)

    • set submit_move(submit_move): void

    • Parameters

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

      Returns void

    title

    Methods

    Protected _socket_on

    acceptRemovedStones

    acceptUndo

    Protected annul

    cancelGame

    cancelUndo

    Abstract clearAnalysisDrawing

    clearMark

    Abstract clearMessage

    Protected clearPendingResignation

    Protected clearTransientMark

    Protected computeNewPlayerClock

    Protected connect

    debouncedEmitCapturedStones

    decodeMoves

    decodePrettyCoordinates

    decodePrettyCoordinates

    Protected defaultConfig

    deleteBranch

    deleteConditionalPath

    deleteCustomMark

    destroy

    Protected Abstract disableDrawing

    Abstract disablePen

    disableStonePlacement

    Protected disconnect

    Abstract drawPenMarks

    Abstract drawSquare

    editPlaceByPrettyCoordinates

    Protected Abstract enableDrawing

    Abstract enablePen

    enableStonePlacement

    encodeMove

    encodeMoves

    followConditionalPath

    Protected followConditionalSegment

    Protected getClockDrift

    Protected getCoordinateDisplaySystem

    getCurrentConditionalPath

    getLastReviewMessage

    Protected getLocation

    getMarks

    Protected getNetworkLatency

    getPlayerRelativeLatency

    Protected getShowMoveNumbers

    Protected getShowVariationMoveNumbers

    Protected getWidthForSquareSize

    giveReviewControl

    hideScores

    Protected incrementLabelCharacter

    isAnalysisDisabled

    isCurrentUserAPlayer

    Protected isLastOfficialMove

    jumpToLastOfficialMove

    load

    markDirty

    Abstract move_tree_redraw

    nextSibling

    pass

    pauseGame

    performStoneRemovalAutoScoring

    placeByPrettyCoordinates

    Protected playMovementSound

    Protected post_config_constructor

    Protected defaultConfig

    deleteBranch

    deleteConditionalPath

    deleteCustomMark

    destroy

    Protected Abstract disableDrawing

    Abstract disablePen

    disableStonePlacement

    Protected disconnect

    Abstract drawPenMarks

    Abstract drawSquare

    editPlaceByPrettyCoordinates

    Protected Abstract enableDrawing

    Abstract enablePen

    enableStonePlacement

    encodeMove

    encodeMoves

    followConditionalPath

    Protected followConditionalSegment

    Protected getClockDrift

    Protected getCoordinateDisplaySystem

    getCurrentConditionalPath

    getLastReviewMessage

    Protected getLocation

    getMarks

    Protected getNetworkLatency

    getPlayerRelativeLatency

    Protected getShowMoveNumbers

    Protected getShowVariationMoveNumbers

    Protected getWidthForSquareSize

    giveReviewControl

    hideScores

    Protected incrementLabelCharacter

    isAnalysisDisabled

    isCurrentUserAPlayer

    Protected isLastOfficialMove

    jumpToLastOfficialMove

    load

    markDirty

    Abstract move_tree_redraw

    nextSibling

    pass

    pauseGame

    performStoneRemovalAutoScoring

    placeByPrettyCoordinates

    Protected playMovementSound

    Protected post_config_constructor

    prettyCoordinates

    prevSibling

    Abstract redraw

    rejectRemovedStones

    requestUndo

    resign

    resumeGame

    saveConditionalMoves

    Protected scheduleRedrawPenLayer

    sendChat

    Protected sendMove

    Protected sendPendingResignation

    sendPreventEscaping

    sendPreventStalling

    sendTimedOut

    prettyCoordinates

    prevSibling

    Abstract redraw

    rejectRemovedStones

    requestUndo

    resign

    resumeGame

    saveConditionalMoves

    Protected scheduleRedrawPenLayer

    sendChat

    Protected sendMove

    Protected sendPendingResignation

    sendPreventEscaping

    sendPreventStalling

    sendTimedOut

    set

    setAnalyzeTool

    setBounds

    setColoredCircles

    setColoredMarks

    • setColoredMarks(colored_marks): void

    • Parameters

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

      Returns void

    setConditionalTree

    setCustomMark

    setEditColor

    setForRemoval

    • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

    setGameClock

    setHeatmap

    setLabelCharacter

    Protected setLabelCharacterFromMarks

    Protected setLastOfficialMove

    setLastReviewMessage

    Protected setLetterMark

    setMark

    setMarkByPrettyCoordinates

    Protected setMarkColor

    setMarks

    set

    setAnalyzeTool

    setBounds

    setColoredCircles

    setColoredMarks

    • setColoredMarks(colored_marks): void

    • Parameters

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

      Returns void

    setConditionalTree

    setCustomMark

    setEditColor

    setForRemoval

    • setForRemoval(x, y, removed, emit_stone_removal_updated?): 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

    setGameClock

    setHeatmap

    setLabelCharacter

    Protected setLabelCharacterFromMarks

    Protected setLastOfficialMove

    setLastReviewMessage

    Protected setLetterMark

    setMark

    setMarkByPrettyCoordinates

    Protected setMarkColor

    setMarks

    • setMarks(marks, dont_draw?): 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

    setMode

    setModeDeferred

    Abstract setMoveTreeContainer

    setScoringMode

    setState

    • setState(): 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

    setMode

    setModeDeferred

    Abstract setMoveTreeContainer

    setScoringMode

    setState

    setStrictSekiMode

    Protected setSubmit

    setSubscriptMark

    Protected Abstract setTitle

    setToPreviousMode

    Protected setTransientMark

    showFirst

    Abstract showMessage

    showNext

    showPrevious

    showScores

    showStallingScoreEstimate

    syncReviewMove

    Protected toggleMark

    Protected updateMoveTree

    Protected updateOrRedrawMoveTree

    updatePlayerToMoveTitle

    updateScoreEstimation

    updateTitleAndStonePlacement

    Protected xy2ij

    • xy2ij(x, y, anti_slip?): {
          i: number;
          j: number;
          valid: boolean;
      }

    • Parameters

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

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

      • i: number
      • j: number
      • valid: boolean

    Static getCDNReleaseBase

    Static getMoveTreeNumbering

    Static getSoundEnabled

    Static getSoundVolume

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_statebounded_heightbounded_widthboundschat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentcurrent_cmovecurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsedit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklast_clocklast_emitted_clocklast_hover_squarelast_movelast_move_radiuslast_paused_by_player_statelast_paused_statelast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremove_selectedno_displayonErroron_game_screenone_click_submitoriginal_square_sizepause_controlpaused_sincepen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donevariation_stone_opacityvisual_undo_request_indicatorwidthsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle_socket_onacceptRemovedStonesacceptUndoannulcancelGamecancelUndoclearAnalysisDrawingclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeNewPlayerClockconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydisableDrawingdisablePendisableStonePlacementdisconnectdrawPenMarksdrawSquareeditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkDirtymove_tree_redrawnextSiblingpasspauseGameperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetScoringModesetStatesetStrictSekiModesetSubmitsetSubscriptMarksetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementxy2ijgetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
    \ No newline at end of file +

    Returns void

    setStrictSekiMode

    Protected setSubmit

    setSubscriptMark

    Protected Abstract setTitle

    setToPreviousMode

    Protected setTransientMark

    showFirst

    Abstract showMessage

    showNext

    showPrevious

    showScores

    showStallingScoreEstimate

    syncReviewMove

    Protected toggleMark

    Protected updateMoveTree

    Protected updateOrRedrawMoveTree

    updatePlayerToMoveTitle

    updateScoreEstimation

    updateTitleAndStonePlacement

    Protected xy2ij

    Static getCDNReleaseBase

    Static getMoveTreeNumbering

    Static getSoundEnabled

    Static getSoundVolume

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__board_redraw_pen_layer_timer__clock_timer__draw_state__last_pt__update_move_treeanalysis_move_counteranalysis_removal_last_positionanalysis_removal_statebounded_heightbounded_widthboundschat_logcircle_radiusclock_should_be_paused_for_move_submissioncolored_circlesconditional_pathconditional_starting_colorconditional_treeconfigconnectToReviewSentcurrent_cmovecurrently_my_cmovedirty_redrawdisconnectedFromGamedisplay_widthdone_loading_reviewdont_draw_last_movedouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsedit_colorengineerrorHandlergame_idgame_typegetPuzzlePlacementSettinggoban_idheatmapheighthighlight_movetree_movesinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwnerlabel_characterlabel_marklast_clocklast_emitted_clocklast_hover_squarelast_movelast_move_radiuslast_paused_by_player_statelast_paused_statelast_phaselast_review_messagelast_sound_played_for_a_stone_placementlast_stone_soundleavePushedAnalysismarked_analysis_scoremove_selectedno_displayonErroron_game_screenone_click_submitoriginal_square_sizepause_controlpaused_sincepen_marksplayer_idpreloaded_dataprevious_modepuzzle_autoplace_delayrestrict_moves_to_movetreereview_had_gamedatareview_idscoring_modesendLatencyTimersent_timed_out_messageshift_key_is_downshow_move_numbersshow_variation_move_numbersshowing_scoressocketsocket_event_bindingssquare_sizestalling_score_estimatestone_placement_enabledstone_removal_auto_scoring_donevariation_stone_opacityvisual_undo_request_indicatorwidthsetCallbackssetTranslationsanalyze_subtoolanalyze_tooldestroyedis_game_recordmodereview_controller_idreview_owner_idscore_estimatorsubmit_movetitle_socket_onacceptRemovedStonesacceptUndoannulcancelGamecancelUndoclearAnalysisDrawingclearMarkclearMessageclearPendingResignationclearTransientMarkcomputeNewPlayerClockconnectdebouncedEmitCapturedStonesdecodeMovesdecodePrettyCoordinatesdefaultConfigdeleteBranchdeleteConditionalPathdeleteCustomMarkdestroydisableDrawingdisablePendisableStonePlacementdisconnectdrawPenMarksdrawSquareeditPlaceByPrettyCoordinatesenableDrawingenablePenenableStonePlacementencodeMoveencodeMovesfollowConditionalPathfollowConditionalSegmentgetClockDriftgetCoordinateDisplaySystemgetCurrentConditionalPathgetLastReviewMessagegetLocationgetMarksgetNetworkLatencygetPlayerRelativeLatencygetShowMoveNumbersgetShowVariationMoveNumbersgetWidthForSquareSizegiveReviewControlhideScoresincrementLabelCharacterisAnalysisDisabledisCurrentUserAPlayerisLastOfficialMovejumpToLastOfficialMoveloadmarkDirtymove_tree_redrawnextSiblingpasspauseGameperformStoneRemovalAutoScoringplaceByPrettyCoordinatesplayMovementSoundpost_config_constructorprettyCoordinatesprevSiblingredrawrejectRemovedStonesrequestUndoresignresumeGamesaveConditionalMovesscheduleRedrawPenLayersendChatsendMovesendPendingResignationsendPreventEscapingsendPreventStallingsendTimedOutsetsetAnalyzeToolsetBoundssetColoredCirclessetColoredMarkssetConditionalTreesetCustomMarksetEditColorsetForRemovalsetGameClocksetHeatmapsetLabelCharactersetLabelCharacterFromMarkssetLastOfficialMovesetLastReviewMessagesetLetterMarksetMarksetMarkByPrettyCoordinatessetMarkColorsetMarkssetModesetModeDeferredsetMoveTreeContainersetScoringModesetStatesetStrictSekiModesetSubmitsetSubscriptMarksetTitlesetToPreviousModesetTransientMarkshowFirstshowMessageshowNextshowPreviousshowScoresshowStallingScoreEstimatesyncReviewMovetoggleMarkupdateMoveTreeupdateOrRedrawMoveTreeupdatePlayerToMoveTitleupdateScoreEstimationupdateTitleAndStonePlacementxy2ijgetCDNReleaseBasegetMoveTreeNumberinggetSoundEnabledgetSoundVolume
    \ No newline at end of file diff --git a/docs/enums/JGOFNumericPlayerColor.html b/docs/enums/JGOFNumericPlayerColor.html index c475140c..06ab9403 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

    BLACK EMPTY WHITE -

    Enumeration Members

    BLACK

    BLACK: 1

    EMPTY

    EMPTY: 0

    WHITE

    WHITE: 2

    Settings

    Member Visibility

    Theme

    On This Page

    BLACKEMPTYWHITE
    \ No newline at end of file +

    Enumeration Members

    BLACK

    BLACK: 1

    EMPTY

    EMPTY: 0

    WHITE

    WHITE: 2

    Settings

    Member Visibility

    Theme

    On This Page

    BLACKEMPTYWHITE
    \ No newline at end of file diff --git a/docs/enums/protocol.RemoteStorageReplication.html b/docs/enums/protocol.RemoteStorageReplication.html index d14028e1..cae728ae 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

    LOCAL_OVERWRITES_REMOTE +

    Enumeration Members

    LOCAL_OVERWRITES_REMOTE NONE REMOTE_ONLY REMOTE_OVERWRITES_LOCAL

    Enumeration Members

    LOCAL_OVERWRITES_REMOTE

    LOCAL_OVERWRITES_REMOTE: 1

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

    -

    NONE

    NONE: 0

    No replication of this change

    -

    REMOTE_ONLY

    REMOTE_ONLY: 4

    Remotely set data, but do not update our local value

    -

    REMOTE_OVERWRITES_LOCAL

    REMOTE_OVERWRITES_LOCAL: 2

    Remotely set data will overwrite locally set data

    -

    Settings

    Member Visibility

    Theme

    On This Page

    LOCAL_OVERWRITES_REMOTENONEREMOTE_ONLYREMOTE_OVERWRITES_LOCAL
    \ No newline at end of file +

    NONE

    NONE: 0

    No replication of this change

    +

    REMOTE_ONLY

    REMOTE_ONLY: 4

    Remotely set data, but do not update our local value

    +

    REMOTE_OVERWRITES_LOCAL

    REMOTE_OVERWRITES_LOCAL: 2

    Remotely set data will overwrite locally set data

    +

    Settings

    Member Visibility

    Theme

    On This Page

    LOCAL_OVERWRITES_REMOTENONEREMOTE_ONLYREMOTE_OVERWRITES_LOCAL
    \ No newline at end of file diff --git a/docs/functions/adjust_estimate.html b/docs/functions/adjust_estimate.html index 5e10eeea..03cd162a 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;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/allocateCanvasOrError.html b/docs/functions/allocateCanvasOrError.html index 6201e252..1f147111 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns HTMLCanvasElement

    Settings

    Member Visibility

    Theme

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

    Function autoscore

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +autoscore | goban

    Function autoscore

    Settings

    Member Visibility

    Theme

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

    Function char2num

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +char2num | goban

    Function char2num

    Settings

    Member Visibility

    Theme

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

    Function cloneMatrix

    • cloneMatrix<T>(matrix): T[][]

    • Returns a cloned copy of the provided matrix

      -

      Type Parameters

      • T

      Parameters

      • matrix: T[][]

      Returns T[][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T[][]

    Settings

    Member Visibility

    Theme

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

    Function closeErrorCodeToString

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +closeErrorCodeToString | goban

    Function closeErrorCodeToString

    Settings

    Member Visibility

    Theme

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

    Function color_blend

    • color_blend(c1, c2): string

    • Simple 50% blend of two colors in hex format

      -

      Parameters

      • c1: string
      • c2: string

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/computeAverageMoveTime.html b/docs/functions/computeAverageMoveTime.html index 260a4b08..180621dc 100644 --- a/docs/functions/computeAverageMoveTime.html +++ b/docs/functions/computeAverageMoveTime.html @@ -1,2 +1,2 @@ computeAverageMoveTime | goban

    Function computeAverageMoveTime

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/createDeviceScaledCanvas.html b/docs/functions/createDeviceScaledCanvas.html index 9d0e4e5d..870de641 100644 --- a/docs/functions/createDeviceScaledCanvas.html +++ b/docs/functions/createDeviceScaledCanvas.html @@ -1 +1 @@ -createDeviceScaledCanvas | goban

    Function createDeviceScaledCanvas

    • createDeviceScaledCanvas(width, height): HTMLCanvasElement

    • Parameters

      • width: number
      • height: number

      Returns HTMLCanvasElement

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createDeviceScaledCanvas | goban

    Function createDeviceScaledCanvas

    • createDeviceScaledCanvas(width, height): HTMLCanvasElement

    • Parameters

      • width: number
      • height: number

      Returns HTMLCanvasElement

    Settings

    Member Visibility

    Theme

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

    Function createGoban

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createGoban | goban

    Function createGoban

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/decodeCoordinate.html b/docs/functions/decodeCoordinate.html index cbc482d3..78bf1e47 100644 --- a/docs/functions/decodeCoordinate.html +++ b/docs/functions/decodeCoordinate.html @@ -1,2 +1,2 @@ decodeCoordinate | goban

    Function decodeCoordinate

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

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

    Function decodeGTPCoordinates

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns JGOFMove

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/decodeMoves.html b/docs/functions/decodeMoves.html index 24a6ae61..93bf0777 100644 --- a/docs/functions/decodeMoves.html +++ b/docs/functions/decodeMoves.html @@ -1,3 +1,3 @@ decodeMoves | goban

    Function decodeMoves

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns JGOFMove[]

    Settings

    Member Visibility

    Theme

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

    Function decodePrettyCoordinates

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns JGOFMove

    Settings

    Member Visibility

    Theme

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

    Function decodePrettyXCoordinate

    • decodePrettyXCoordinate(ch): number

    • Decodes the pretty X coordinate to a number

      -

      Parameters

      • ch: string

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

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

    Function deepClone

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns any

    Settings

    Member Visibility

    Theme

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

    Function deepEqual

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/deviceCanvasScalingRatio.html b/docs/functions/deviceCanvasScalingRatio.html index 2cd7ca7f..73b8e965 100644 --- a/docs/functions/deviceCanvasScalingRatio.html +++ b/docs/functions/deviceCanvasScalingRatio.html @@ -1 +1 @@ -deviceCanvasScalingRatio | goban

    Function deviceCanvasScalingRatio

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +deviceCanvasScalingRatio | goban

    Function deviceCanvasScalingRatio

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/elementOffset.html b/docs/functions/elementOffset.html index 46bb2d74..7c2f30be 100644 --- a/docs/functions/elementOffset.html +++ b/docs/functions/elementOffset.html @@ -1 +1 @@ -elementOffset | goban

    Function elementOffset

    • elementOffset(element): {
          left: number;
          top: number;
      }

    • Parameters

      • element: HTMLElement

      Returns {
          left: number;
          top: number;
      }

      • left: number
      • top: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +elementOffset | goban

    Function elementOffset

    • elementOffset(element): {
          left: number;
          top: number;
      }

    • Parameters

      • element: HTMLElement

      Returns {
          left: number;
          top: number;
      }

      • left: number
      • top: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/encodeCoordinate.html b/docs/functions/encodeCoordinate.html index 6e0d4621..b8bc54d7 100644 --- a/docs/functions/encodeCoordinate.html +++ b/docs/functions/encodeCoordinate.html @@ -1,2 +1,2 @@ encodeCoordinate | goban

    Function encodeCoordinate

    • encodeCoordinate(coor): string

    • Encodes a single coordinate to a number

      -

      Parameters

      • coor: number

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/encodeMove.html b/docs/functions/encodeMove.html index e48972f1..624d21be 100644 --- a/docs/functions/encodeMove.html +++ b/docs/functions/encodeMove.html @@ -1 +1 @@ -encodeMove | goban

    Function encodeMove

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +encodeMove | goban

    Function encodeMove

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/encodeMoveToArray.html b/docs/functions/encodeMoveToArray.html index 073ada7f..e033f123 100644 --- a/docs/functions/encodeMoveToArray.html +++ b/docs/functions/encodeMoveToArray.html @@ -1 +1 @@ -encodeMoveToArray | goban

    Function encodeMoveToArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +encodeMoveToArray | goban

    Function encodeMoveToArray

    Settings

    Member Visibility

    Theme

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

    Function encodeMoves

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +encodeMoves | goban

    Function encodeMoves

    Settings

    Member Visibility

    Theme

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

    Function encodeMovesToArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +encodeMovesToArray | goban

    Function encodeMovesToArray

    Settings

    Member Visibility

    Theme

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

    Function encodePrettyXCoordinate

    • encodePrettyXCoordinate(coor): string

    • Encodes an X coordinate to a display encoding

      -

      Parameters

      • coor: number

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/escapeSGFText.html b/docs/functions/escapeSGFText.html index b8a74443..856dabe2 100644 --- a/docs/functions/escapeSGFText.html +++ b/docs/functions/escapeSGFText.html @@ -1 +1 @@ -escapeSGFText | goban

    Function escapeSGFText

    • escapeSGFText(txt, escapeColon?): string

    • Parameters

      • txt: string
      • escapeColon: boolean = false

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +escapeSGFText | goban

    Function escapeSGFText

    • escapeSGFText(txt, escapeColon?): string

    • Parameters

      • txt: string
      • escapeColon: boolean = false

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/getRandomInt.html b/docs/functions/getRandomInt.html index 51d3b187..598367c6 100644 --- a/docs/functions/getRandomInt.html +++ b/docs/functions/getRandomInt.html @@ -1,2 +1,2 @@ getRandomInt | goban

    Function getRandomInt

    • getRandomInt(min, max): number

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

      -

      Parameters

      • min: number
      • max: number

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

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

    Function getRelativeEventPosition

    • getRelativeEventPosition(event, target?): {
          x: number;
          y: number;
      }

    • 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns {
        x: number;
        y: number;
    }

    Settings

    Member Visibility

    Theme

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

    Function getWorstMoves

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns AIReviewWorstMoveEntry[]

    Settings

    Member Visibility

    Theme

    \ 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 817cccac..7c5d503c 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +init_remote_ownership_estimator | goban

    Function init_remote_ownership_estimator

    Settings

    Member Visibility

    Theme

    \ 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 0bd71cfe..3d0c3954 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +init_wasm_ownership_estimator | goban

    Function init_wasm_ownership_estimator

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/makeEmptyMatrix.html b/docs/functions/makeEmptyMatrix.html index 28faaf6c..450daba6 100644 --- a/docs/functions/makeEmptyMatrix.html +++ b/docs/functions/makeEmptyMatrix.html @@ -1 +1 @@ -makeEmptyMatrix | goban

    Function makeEmptyMatrix

    • makeEmptyMatrix<T>(width, height): (T | undefined)[][]

    • Type Parameters

      • T

      Parameters

      • width: number
      • height: number

      Returns (T | undefined)[][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +makeEmptyMatrix | goban

    Function makeEmptyMatrix

    • makeEmptyMatrix<T>(width, height): (T | undefined)[][]

    • Type Parameters

      • T

      Parameters

      • width: number
      • height: number

      Returns (T | undefined)[][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/makeMatrix.html b/docs/functions/makeMatrix.html index e626f547..4c271fdf 100644 --- a/docs/functions/makeMatrix.html +++ b/docs/functions/makeMatrix.html @@ -1 +1 @@ -makeMatrix | goban

    Function makeMatrix

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +makeMatrix | goban

    Function makeMatrix

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/makeObjectMatrix.html b/docs/functions/makeObjectMatrix.html index 52de0fbc..77883e81 100644 --- a/docs/functions/makeObjectMatrix.html +++ b/docs/functions/makeObjectMatrix.html @@ -1 +1 @@ -makeObjectMatrix | goban

    Function makeObjectMatrix

    • makeObjectMatrix<T>(width, height): T[][]

    • Type Parameters

      • T

      Parameters

      • width: number
      • height: number

      Returns T[][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +makeObjectMatrix | goban

    Function makeObjectMatrix

    • makeObjectMatrix<T>(width, height): T[][]

    • Type Parameters

      • T

      Parameters

      • width: number
      • height: number

      Returns T[][]

    Settings

    Member Visibility

    Theme

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

    Function matricesAreEqual

    • matricesAreEqual<T>(m1, m2): boolean

    • 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/newlines_to_spaces.html b/docs/functions/newlines_to_spaces.html index 46517b3e..8ca7c2a5 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

    • newlines_to_spaces(txt): string

    • 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/niceInterval.html b/docs/functions/niceInterval.html index 66760d5e..3e2fa322 100644 --- a/docs/functions/niceInterval.html +++ b/docs/functions/niceInterval.html @@ -1,4 +1,4 @@ niceInterval | goban

    Function niceInterval

    • niceInterval(callback, interval): ReturnType<typeof setInterval>

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns ReturnType<typeof setInterval>

    Settings

    Member Visibility

    Theme

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

    Function num2char

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +num2char | goban

    Function num2char

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/ojeSequenceToMoves.html b/docs/functions/ojeSequenceToMoves.html index 96f33471..d89c56e8 100644 --- a/docs/functions/ojeSequenceToMoves.html +++ b/docs/functions/ojeSequenceToMoves.html @@ -1 +1 @@ -ojeSequenceToMoves | goban

    Function ojeSequenceToMoves

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ojeSequenceToMoves | goban

    Function ojeSequenceToMoves

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/placeRenderedImageStone.html b/docs/functions/placeRenderedImageStone.html index 26f8c4d2..d7d8ebb7 100644 --- a/docs/functions/placeRenderedImageStone.html +++ b/docs/functions/placeRenderedImageStone.html @@ -1 +1 @@ -placeRenderedImageStone | goban

    Function placeRenderedImageStone

    • placeRenderedImageStone(ctx, shadow_ctx, stone, cx, cy, radius): void

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +placeRenderedImageStone | goban

    Function placeRenderedImageStone

    • placeRenderedImageStone(ctx, shadow_ctx, stone, cx, cy, radius): void

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/positionId.html b/docs/functions/positionId.html index 2b7e8fe4..3f5ca1eb 100644 --- a/docs/functions/positionId.html +++ b/docs/functions/positionId.html @@ -1 +1 @@ -positionId | goban

    Function positionId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +positionId | goban

    Function positionId

    Settings

    Member Visibility

    Theme

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

    Function preRenderImageStone

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +preRenderImageStone | goban

    Function preRenderImageStone

    Settings

    Member Visibility

    Theme

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

    Function prettyCoordinates

    • prettyCoordinates(x, y, board_height): string

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

      -

      Parameters

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

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

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

    Function resizeDeviceScaledCanvas

    • resizeDeviceScaledCanvas(canvas, width, height): HTMLCanvasElement

    • Parameters

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

      Returns HTMLCanvasElement

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +resizeDeviceScaledCanvas | goban

    Function resizeDeviceScaledCanvas

    • resizeDeviceScaledCanvas(canvas, width, height): HTMLCanvasElement

    • Parameters

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

      Returns HTMLCanvasElement

    Settings

    Member Visibility

    Theme

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

    Function setGobanCallbacks

    • setGobanCallbacks(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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

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

    Function setGobanRenderer

    • setGobanRenderer(_renderer): void

    • Parameters

      • _renderer: "canvas" | "svg"

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +setGobanRenderer | goban

    Function setGobanRenderer

    • setGobanRenderer(_renderer): void

    • Parameters

      • _renderer: "canvas" | "svg"

      Returns void

    Settings

    Member Visibility

    Theme

    \ 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 4ae33c26..be2b0347 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +set_local_ownership_estimator | goban

    Function set_local_ownership_estimator

    Settings

    Member Visibility

    Theme

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

    Function shortDurationString

    • shortDurationString(seconds): string

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

      -

      Parameters

      • seconds: number

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

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

    Function sortMoves

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

  • sortMoves(moves, width, height): JGOFMove[]

  • Parameters

    • moves: JGOFMove[]
    • width: number
    • height: number

    Returns JGOFMove[]

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/translate._.html b/docs/functions/translate._.html index add52cea..779df77f 100644 --- a/docs/functions/translate._.html +++ b/docs/functions/translate._.html @@ -1 +1 @@ -_ | goban

    Function _

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +_ | goban

    Function _

    Settings

    Member Visibility

    Theme

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

    Function interpolate

    • interpolate(str, params): string

    • Parameters

      • str: string
      • params: any

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +interpolate | goban

    Function interpolate

    • interpolate(str, params): string

    • Parameters

      • str: string
      • params: any

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/translate.setGobanTranslations.html b/docs/functions/translate.setGobanTranslations.html index 491cff61..766f1a34 100644 --- a/docs/functions/translate.setGobanTranslations.html +++ b/docs/functions/translate.setGobanTranslations.html @@ -1 +1 @@ -setGobanTranslations | goban

    Function setGobanTranslations

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +setGobanTranslations | goban

    Function setGobanTranslations

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/validateCanvas.html b/docs/functions/validateCanvas.html index 44c53f6a..bd189aa7 100644 --- a/docs/functions/validateCanvas.html +++ b/docs/functions/validateCanvas.html @@ -1,4 +1,4 @@ validateCanvas | goban

    Function validateCanvas

    • validateCanvas(canvas, err?, width?, height?): boolean

    • 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/voronoi_estimate_ownership.html b/docs/functions/voronoi_estimate_ownership.html index 521fa708..dc96390e 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number[][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/wasm_estimate_ownership.html b/docs/functions/wasm_estimate_ownership.html index 7f61b979..83396d3d 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +wasm_estimate_ownership | goban

    Function wasm_estimate_ownership

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/AIReviewWorstMoveEntry.html b/docs/interfaces/AIReviewWorstMoveEntry.html index 1d7180d4..4c5a246a 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 move move_number player -

    Properties

    delta

    delta: number

    move

    move: JGOFIntersection

    move_number

    move_number: number

    player

    player: JGOFNumericPlayerColor

    Settings

    Member Visibility

    Theme

    On This Page

    deltamovemove_numberplayer
    \ No newline at end of file +

    Properties

    delta

    delta: number

    move

    move: JGOFIntersection

    move_number

    move_number: number

    player

    player: JGOFNumericPlayerColor

    Settings

    Member Visibility

    Theme

    On This Page

    deltamovemove_numberplayer
    \ No newline at end of file diff --git a/docs/interfaces/AdHocClock.html b/docs/interfaces/AdHocClock.html index e1d592ef..11000984 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 black_time current_player expiration @@ -11,24 +11,24 @@ white_player_id white_time

    Properties

    black_player_id

    black_player_id: number

    OGS player id for black

    -

    black_time

    black_time: number | AdHocPlayerClock

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

    black_time

    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

    current_player: number

    Current player to move

    -

    expiration

    expiration: number

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

    current_player

    current_player: number

    Current player to move

    +

    expiration

    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

    game_id: number

    OGS Game id

    -

    last_move

    last_move: number

    Time the last move was made, in milliseconds since 1970

    -

    Optional pause

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

    If set, this AdHocClock is updating the pause state

    -

    Type declaration

    Optional paused_since

    paused_since?: number

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

    game_id

    game_id: number

    OGS Game id

    +

    last_move

    last_move: number

    Time the last move was made, in milliseconds since 1970

    +

    Optional pause

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

    If set, this AdHocClock is updating the pause state

    +

    Type declaration

    Optional paused_since

    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.

    -

    Optional start_mode

    start_mode?: boolean

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

    Optional start_mode

    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

    title: string

    Title of the game. This field will be removed.

    -

    white_player_id

    white_player_id: number

    OGS player id for white

    -

    white_time

    white_time: number | AdHocPlayerClock

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

    title

    title: string

    Title of the game. This field will be removed.

    +

    white_player_id

    white_player_id: number

    OGS player id for white

    +

    white_time

    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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    black_player_idblack_timecurrent_playerexpirationgame_idlast_movepausepaused_sincestart_modetitlewhite_player_idwhite_time
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    black_player_idblack_timecurrent_playerexpirationgame_idlast_movepausepaused_sincestart_modetitlewhite_player_idwhite_time
    \ No newline at end of file diff --git a/docs/interfaces/AdHocFormat.html b/docs/interfaces/AdHocFormat.html index 8ab1b7ae..f9792678 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

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

    Properties

    black clock pause_control time_control white -

    Properties

    black

    black: AdHocPlayer

    clock

    clock: AdHocClock

    pause_control

    pause_control: AdHocPauseControl

    time_control

    time_control: JGOFTimeControl

    white

    white: AdHocPlayer

    Settings

    Member Visibility

    Theme

    On This Page

    blackclockpause_controltime_controlwhite
    \ No newline at end of file +

    Properties

    black

    black: AdHocPlayer

    clock

    clock: AdHocClock

    pause_control

    pause_control: AdHocPauseControl

    time_control

    time_control: JGOFTimeControl

    white

    white: AdHocPlayer

    Settings

    Member Visibility

    Theme

    On This Page

    blackclockpause_controltime_controlwhite
    \ No newline at end of file diff --git a/docs/interfaces/AdHocPauseControl.html b/docs/interfaces/AdHocPauseControl.html index de120194..c778ba8d 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? paused? stone-removal? system? weekend? -

    Properties

    Optional moderator_paused

    moderator_paused?: {
        moderator_id: number;
    }

    Type declaration

    • moderator_id: number

    Optional paused

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

    Type declaration

    • pauses_left: number
    • pausing_player_id: number

    Optional stone-removal

    stone-removal?: true

    Optional system

    system?: true

    Optional weekend

    weekend?: true

    Settings

    Member Visibility

    Theme

    On This Page

    moderator_pausedpausedstone-removalsystemweekend
    \ No newline at end of file +

    Properties

    Optional moderator_paused

    moderator_paused?: {
        moderator_id: number;
    }

    Type declaration

    • moderator_id: number

    Optional paused

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

    Type declaration

    • pauses_left: number
    • pausing_player_id: number

    Optional stone-removal

    stone-removal?: true

    Optional system

    system?: true

    Optional weekend

    weekend?: true

    Settings

    Member Visibility

    Theme

    On This Page

    moderator_pausedpausedstone-removalsystemweekend
    \ No newline at end of file diff --git a/docs/interfaces/AdHocPlayer.html b/docs/interfaces/AdHocPlayer.html index 7896d923..09103b82 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

    id name -

    Properties

    id

    id: number

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    idname
    \ No newline at end of file +

    Properties

    id

    id: number

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    idname
    \ No newline at end of file diff --git a/docs/interfaces/AdHocPlayerClock.html b/docs/interfaces/AdHocPlayerClock.html index 6a513170..2eb9f873 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? moves_left? period_time? periods? @@ -6,12 +6,12 @@ thinking_time

    Properties

    Optional block_time

    block_time?: number

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

    -

    Optional moves_left

    moves_left?: number

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

    Optional moves_left

    moves_left?: number

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

    -

    Optional period_time

    period_time?: number

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

    -

    Optional periods

    periods?: number

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

    -

    Optional skip_bonus

    skip_bonus?: boolean

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

    Optional period_time

    period_time?: number

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

    +

    Optional periods

    periods?: number

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

    +

    Optional skip_bonus

    skip_bonus?: boolean

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

    -

    thinking_time

    thinking_time: number

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

    thinking_time

    thinking_time: number

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    block_timemoves_leftperiod_timeperiodsskip_bonusthinking_time
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    block_timemoves_leftperiod_timeperiodsskip_bonusthinking_time
    \ No newline at end of file diff --git a/docs/interfaces/AudioClockEvent.html b/docs/interfaces/AudioClockEvent.html index 6eac74ef..e3e71fd6 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

    clock color countdown_seconds in_overtime player_id time_control_system

    Properties

    clock

    clock: JGOFPlayerClock

    Full player clock information

    -

    color

    color: PlayerColor

    The player whose turn it is

    -

    countdown_seconds

    countdown_seconds: number

    Number of seconds left in the current period

    -

    in_overtime

    in_overtime: boolean

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

    color

    color: PlayerColor

    The player whose turn it is

    +

    countdown_seconds

    countdown_seconds: number

    Number of seconds left in the current period

    +

    in_overtime

    in_overtime: boolean

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

    -

    player_id

    player_id: string

    The player (id) whose turn it is

    -

    time_control_system

    time_control_system: JGOFTimeControlSystem

    Time control system being used by the clock

    -

    Settings

    Member Visibility

    Theme

    On This Page

    clockcolorcountdown_secondsin_overtimeplayer_idtime_control_system
    \ No newline at end of file +

    player_id

    player_id: string

    The player (id) whose turn it is

    +

    time_control_system

    time_control_system: JGOFTimeControlSystem

    Time control system being used by the clock

    +

    Settings

    Member Visibility

    Theme

    On This Page

    clockcolorcountdown_secondsin_overtimeplayer_idtime_control_system
    \ No newline at end of file diff --git a/docs/interfaces/BoardConfig.html b/docs/interfaces/BoardConfig.html index ebd00278..28f0fbc4 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? board? board_is_repeating? height? @@ -7,4 +7,4 @@ removal? white_prisoners? width? -

    Properties

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional height

    height?: number

    Optional isobranch_hash

    isobranch_hash?: string

    Optional player

    player?: JGOFNumericPlayerColor

    Optional removal

    removal?: boolean[][]

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Settings

    Member Visibility

    Theme

    On This Page

    black_prisonersboardboard_is_repeatingheightisobranch_hashplayerremovalwhite_prisonerswidth
    \ No newline at end of file +

    Properties

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional height

    height?: number

    Optional isobranch_hash

    isobranch_hash?: string

    Optional player

    player?: JGOFNumericPlayerColor

    Optional removal

    removal?: boolean[][]

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Settings

    Member Visibility

    Theme

    On This Page

    black_prisonersboardboard_is_repeatingheightisobranch_hashplayerremovalwhite_prisonerswidth
    \ No newline at end of file diff --git a/docs/interfaces/CanvasRendererGobanConfig.html b/docs/interfaces/CanvasRendererGobanConfig.html index 266946ba..696c3927 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);
        is_game_record?: 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);
        is_game_record?: 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? allow_ko? allow_self_capture? allow_superko? @@ -117,13 +117,13 @@ white_prisoners? width? winner? -

    Properties

    Optional aga_handicap_scoring

    aga_handicap_scoring?: boolean

    Optional allow_ko

    allow_ko?: boolean

    Optional allow_self_capture

    allow_self_capture?: boolean

    Optional allow_superko

    allow_superko?: boolean

    Optional auth

    auth?: string

    Optional automatic_stone_removal

    automatic_stone_removal?: boolean

    Optional black_player_id

    black_player_id?: number

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_div

    board_div?: HTMLElement

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional bounds

    bounds?: GobanBounds

    Optional chat_log

    chat_log?: GobanChatLog

    Optional circle_radius

    circle_radius?: number

    Optional clock

    clock?: GameClock

    Optional connect_to_chat

    connect_to_chat?: number | boolean

    Optional disable_analysis

    disable_analysis?: boolean

    Optional display_width

    display_width?: number

    Optional dont_draw_last_move

    dont_draw_last_move?: boolean

    Optional dont_show_messages

    dont_show_messages?: boolean

    Optional double_click_submit

    double_click_submit?: boolean

    Optional draw_bottom_labels

    draw_bottom_labels?: boolean

    Optional draw_left_labels

    draw_left_labels?: boolean

    Optional draw_right_labels

    draw_right_labels?: boolean

    Optional draw_top_labels

    draw_top_labels?: boolean

    Optional end_time

    end_time?: number

    Optional errors

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

    Type declaration

    • error: string
    • stack: any

    Optional free_handicap_placement

    free_handicap_placement?: boolean

    Optional game_date

    game_date?: string

    Optional game_id

    game_id?: string | number

    Optional game_name

    game_name?: string

    Optional game_type

    game_type?: "temporary"

    Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Optional group_ids

    group_ids?: number[]

    Optional handicap

    handicap?: number

    Optional handicap_rank_difference

    handicap_rank_difference?: number

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional interactive

    interactive?: boolean

    Optional isInPushedAnalysis

    isInPushedAnalysis?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerController

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerOwner

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional is_game_record

    is_game_record?: boolean

    Optional isobranch_hash

    isobranch_hash?: string

    Optional komi

    komi?: number

    Optional ladder

    ladder?: number

    Optional ladder_id

    ladder_id?: number

    Optional last_move_opacity

    last_move_opacity?: number

    Optional last_move_radius

    last_move_radius?: number

    Optional latencies

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

    Type declaration

    • [player_id: string]: number

    Optional leavePushedAnalysis

    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void

      • Returns void

    Optional malkovich_log

    malkovich_log?: GobanChatLog

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional mode

    mode?: GobanModes

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Optional moves

    moves?: GobanMovesArray

    Optional name

    name?: string

    Optional needs_sealing

    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    -

    Optional ogs

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

    Type declaration

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

    Optional ogs_import

    ogs_import?: boolean

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

    -

    Optional onError

    onError?: ((err) => void)

    Type declaration

      • (err): void

      • Parameters

        • err: Error

        Returns void

    Optional onScoreEstimationUpdated

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

    Type declaration

      • (winning_color, points): void

      • Parameters

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

        Returns void

    Optional one_click_submit

    one_click_submit?: boolean

    Optional opponent_plays_first_after_resume

    opponent_plays_first_after_resume?: boolean

    Optional original_disable_analysis

    original_disable_analysis?: boolean

    Optional original_sgf

    original_sgf?: string

    Optional outcome

    outcome?: string

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    Optional phase

    phase?: GobanEnginePhase

    Optional player

    player?: JGOFNumericPlayerColor

    Optional player_id

    player_id?: number

    Optional player_pool

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

    Type declaration

    Optional players

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

    Type declaration

    Optional puzzle_autoplace_delay

    puzzle_autoplace_delay?: number

    Optional puzzle_collection

    puzzle_collection?: number

    Optional puzzle_description

    puzzle_description?: string

    Optional puzzle_opponent_move_mode

    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

    Optional puzzle_player_move_mode

    puzzle_player_move_mode?: PuzzlePlayerMoveMode

    Optional puzzle_rank

    puzzle_rank?: number

    Optional puzzle_type

    puzzle_type?: string

    Optional ranked

    ranked?: boolean

    Optional removal

    removal?: boolean[][]

    Optional removed

    removed?: string | JGOFMove[]

    Removed stones in stone removal phase +

    Properties

    Optional aga_handicap_scoring

    aga_handicap_scoring?: boolean

    Optional allow_ko

    allow_ko?: boolean

    Optional allow_self_capture

    allow_self_capture?: boolean

    Optional allow_superko

    allow_superko?: boolean

    Optional auth

    auth?: string

    Optional automatic_stone_removal

    automatic_stone_removal?: boolean

    Optional black_player_id

    black_player_id?: number

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_div

    board_div?: HTMLElement

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional bounds

    bounds?: GobanBounds

    Optional chat_log

    chat_log?: GobanChatLog

    Optional circle_radius

    circle_radius?: number

    Optional clock

    clock?: GameClock

    Optional connect_to_chat

    connect_to_chat?: number | boolean

    Optional disable_analysis

    disable_analysis?: boolean

    Optional display_width

    display_width?: number

    Optional dont_draw_last_move

    dont_draw_last_move?: boolean

    Optional dont_show_messages

    dont_show_messages?: boolean

    Optional double_click_submit

    double_click_submit?: boolean

    Optional draw_bottom_labels

    draw_bottom_labels?: boolean

    Optional draw_left_labels

    draw_left_labels?: boolean

    Optional draw_right_labels

    draw_right_labels?: boolean

    Optional draw_top_labels

    draw_top_labels?: boolean

    Optional end_time

    end_time?: number

    Optional errors

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

    Type declaration

    • error: string
    • stack: any

    Optional free_handicap_placement

    free_handicap_placement?: boolean

    Optional game_date

    game_date?: string

    Optional game_id

    game_id?: string | number

    Optional game_name

    game_name?: string

    Optional game_type

    game_type?: "temporary"

    Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Optional group_ids

    group_ids?: number[]

    Optional handicap

    handicap?: number

    Optional handicap_rank_difference

    handicap_rank_difference?: number

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional interactive

    interactive?: boolean

    Optional isInPushedAnalysis

    isInPushedAnalysis?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerController

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerOwner

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional is_game_record

    is_game_record?: boolean

    Optional isobranch_hash

    isobranch_hash?: string

    Optional komi

    komi?: number

    Optional ladder

    ladder?: number

    Optional ladder_id

    ladder_id?: number

    Optional last_move_opacity

    last_move_opacity?: number

    Optional last_move_radius

    last_move_radius?: number

    Optional latencies

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

    Type declaration

    • [player_id: string]: number

    Optional leavePushedAnalysis

    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void

      • Returns void

    Optional malkovich_log

    malkovich_log?: GobanChatLog

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional mode

    mode?: GobanModes

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Optional moves

    moves?: GobanMovesArray

    Optional name

    name?: string

    Optional needs_sealing

    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    +

    Optional ogs

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

    Type declaration

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

    Optional ogs_import

    ogs_import?: boolean

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

    +

    Optional onError

    onError?: ((err) => void)

    Type declaration

      • (err): void

      • Parameters

        • err: Error

        Returns void

    Optional onScoreEstimationUpdated

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

    Type declaration

      • (winning_color, points): void

      • Parameters

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

        Returns void

    Optional one_click_submit

    one_click_submit?: boolean

    Optional opponent_plays_first_after_resume

    opponent_plays_first_after_resume?: boolean

    Optional original_disable_analysis

    original_disable_analysis?: boolean

    Optional original_sgf

    original_sgf?: string

    Optional outcome

    outcome?: string

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    Optional phase

    phase?: GobanEnginePhase

    Optional player

    player?: JGOFNumericPlayerColor

    Optional player_id

    player_id?: number

    Optional player_pool

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

    Type declaration

    Optional players

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

    Type declaration

    Optional puzzle_autoplace_delay

    puzzle_autoplace_delay?: number

    Optional puzzle_collection

    puzzle_collection?: number

    Optional puzzle_description

    puzzle_description?: string

    Optional puzzle_opponent_move_mode

    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

    Optional puzzle_player_move_mode

    puzzle_player_move_mode?: PuzzlePlayerMoveMode

    Optional puzzle_rank

    puzzle_rank?: number

    Optional puzzle_type

    puzzle_type?: string

    Optional ranked

    ranked?: boolean

    Optional removal

    removal?: boolean[][]

    Optional removed

    removed?: string | JGOFMove[]

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

    -

    Optional rengo

    rengo?: boolean

    Optional rengo_casual_mode

    rengo_casual_mode?: boolean

    Optional rengo_teams

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

    Type declaration

    Optional review_id

    review_id?: number

    Optional reviews

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

    Type declaration

    Optional rules

    rules?: GobanEngineRules

    Optional score

    score?: Score

    Optional score_handicap

    score_handicap?: boolean

    Optional score_passes

    score_passes?: boolean

    Optional score_prisoners

    score_prisoners?: boolean

    Optional score_stones

    score_stones?: boolean

    Optional score_territory

    score_territory?: boolean

    Optional score_territory_in_seki

    score_territory_in_seki?: boolean

    Optional server_socket

    server_socket?: GobanSocket<ClientToServer, ServerToClient>

    Optional spectator_log

    spectator_log?: GobanChatLog

    Optional square_size

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

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Optional start_time

    start_time?: number

    Optional strict_seki_mode

    strict_seki_mode?: boolean

    Optional superko_algorithm

    superko_algorithm?: GobanEngineSuperKoAlgorithm

    Optional throw_all_errors

    throw_all_errors?: boolean

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

    Optional rengo

    rengo?: boolean

    Optional rengo_casual_mode

    rengo_casual_mode?: boolean

    Optional rengo_teams

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

    Type declaration

    Optional review_id

    review_id?: number

    Optional reviews

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

    Type declaration

    Optional rules

    rules?: GobanEngineRules

    Optional score

    score?: Score

    Optional score_handicap

    score_handicap?: boolean

    Optional score_passes

    score_passes?: boolean

    Optional score_prisoners

    score_prisoners?: boolean

    Optional score_stones

    score_stones?: boolean

    Optional score_territory

    score_territory?: boolean

    Optional score_territory_in_seki

    score_territory_in_seki?: boolean

    Optional server_socket

    server_socket?: GobanSocket<ClientToServer, ServerToClient>

    Optional spectator_log

    spectator_log?: GobanChatLog

    Optional square_size

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

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Optional start_time

    start_time?: number

    Optional strict_seki_mode

    strict_seki_mode?: boolean

    Optional superko_algorithm

    superko_algorithm?: GobanEngineSuperKoAlgorithm

    Optional throw_all_errors

    throw_all_errors?: boolean

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

    -

    Optional time_control

    time_control?: JGOFTimeControl

    Optional time_per_move

    time_per_move?: number

    Optional title_div

    title_div?: HTMLElement

    Optional tournament_id

    tournament_id?: number

    Optional username

    username?: string

    Optional variation_stone_opacity

    variation_stone_opacity?: number

    Optional visual_undo_request_indicator

    visual_undo_request_indicator?: boolean

    Optional white_must_pass_last

    white_must_pass_last?: boolean

    Optional white_player_id

    white_player_id?: number

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Optional winner

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

    Settings

    Member Visibility

    Theme

    On This Page

    aga_handicap_scoringallow_koallow_self_captureallow_superkoauthautomatic_stone_removalblack_player_idblack_prisonersboardboard_divboard_is_repeatingboundschat_logcircle_radiusclockconnect_to_chatdisable_analysisdisplay_widthdont_draw_last_movedont_show_messagesdouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegame_typegetPuzzlePlacementSettinggroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwneris_game_recordisobranch_hashkomiladderladder_idlast_move_opacitylast_move_radiuslatenciesleavePushedAnalysismalkovich_logmarksmodemove_treemove_tree_containermovesnameneeds_sealingogsogs_importonErroronScoreEstimationUpdatedone_click_submitopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomepause_controlpaused_sincephaseplayerplayer_idplayer_poolplayerspuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typerankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekiserver_socketspectator_logsquare_sizestalling_score_estimatestart_timestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetitle_divtournament_idusernamevariation_stone_opacityvisual_undo_request_indicatorwhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner
    \ No newline at end of file +

    Optional time_control

    time_control?: JGOFTimeControl

    Optional time_per_move

    time_per_move?: number

    Optional title_div

    title_div?: HTMLElement

    Optional tournament_id

    tournament_id?: number

    Optional username

    username?: string

    Optional variation_stone_opacity

    variation_stone_opacity?: number

    Optional visual_undo_request_indicator

    visual_undo_request_indicator?: boolean

    Optional white_must_pass_last

    white_must_pass_last?: boolean

    Optional white_player_id

    white_player_id?: number

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Optional winner

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

    Settings

    Member Visibility

    Theme

    On This Page

    aga_handicap_scoringallow_koallow_self_captureallow_superkoauthautomatic_stone_removalblack_player_idblack_prisonersboardboard_divboard_is_repeatingboundschat_logcircle_radiusclockconnect_to_chatdisable_analysisdisplay_widthdont_draw_last_movedont_show_messagesdouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegame_typegetPuzzlePlacementSettinggroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwneris_game_recordisobranch_hashkomiladderladder_idlast_move_opacitylast_move_radiuslatenciesleavePushedAnalysismalkovich_logmarksmodemove_treemove_tree_containermovesnameneeds_sealingogsogs_importonErroronScoreEstimationUpdatedone_click_submitopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomepause_controlpaused_sincephaseplayerplayer_idplayer_poolplayerspuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typerankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekiserver_socketspectator_logsquare_sizestalling_score_estimatestart_timestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetitle_divtournament_idusernamevariation_stone_opacityvisual_undo_request_indicatorwhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner
    \ No newline at end of file diff --git a/docs/interfaces/ColoredCircle.html b/docs/interfaces/ColoredCircle.html index 04fff7cc..c2b553e7 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? border_width? color move -

    Properties

    Optional border_color

    border_color?: string

    Optional border_width

    border_width?: number

    color

    color: string

    move

    move: JGOFIntersection

    Settings

    Member Visibility

    Theme

    On This Page

    border_colorborder_widthcolormove
    \ No newline at end of file +

    Properties

    Optional border_color

    border_color?: string

    Optional border_width

    border_width?: number

    color

    color: string

    move

    move: JGOFIntersection

    Settings

    Member Visibility

    Theme

    On This Page

    border_colorborder_widthcolormove
    \ No newline at end of file diff --git a/docs/interfaces/ConditionalMoveResponseTree.html b/docs/interfaces/ConditionalMoveResponseTree.html index 0e6ee6f7..bb33c1a3 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ConditionalMoveResponseTree | goban

    Interface ConditionalMoveResponseTree

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

    Indexable

    [move: string]: ConditionalMoveResponse

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/GobanBounds.html b/docs/interfaces/GobanBounds.html index 9cb60513..2379af96 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

    bottom left right top -

    Properties

    bottom

    bottom: number

    left

    left: number

    right

    right: number

    top

    top: number

    Settings

    Member Visibility

    Theme

    On This Page

    bottomleftrighttop
    \ No newline at end of file +

    Properties

    bottom

    bottom: number

    left

    left: number

    right

    right: number

    top

    top: number

    Settings

    Member Visibility

    Theme

    On This Page

    bottomleftrighttop
    \ No newline at end of file diff --git a/docs/interfaces/GobanCallbacks.html b/docs/interfaces/GobanCallbacks.html index d14cd565..417feac0 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? canvasAllocationErrorHandler? customBlackStoneColor? customBlackStoneUrl? @@ -25,4 +25,4 @@ toast? updateScoreEstimation? watchSelectedThemes? -

    Properties

    Optional addCoordinatesToChatInput

    addCoordinatesToChatInput?: ((coordinates) => void)

    Type declaration

      • (coordinates): void

      • Parameters

        • coordinates: string

        Returns void

    Optional canvasAllocationErrorHandler

    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

    Optional customBlackStoneColor

    customBlackStoneColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBlackStoneUrl

    customBlackStoneUrl?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBlackTextColor

    customBlackTextColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBoardColor

    customBoardColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBoardLineColor

    customBoardLineColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBoardUrl

    customBoardUrl?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customWhiteStoneColor

    customWhiteStoneColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customWhiteStoneUrl

    customWhiteStoneUrl?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customWhiteTextColor

    customWhiteTextColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional defaultConfig

    defaultConfig?: (() => any)

    Type declaration

      • (): any

      • Returns any

    Optional getCDNReleaseBase

    getCDNReleaseBase?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional getClockDrift

    getClockDrift?: (() => number)

    Type declaration

      • (): number

      • Returns number

    Optional getCoordinateDisplaySystem

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

    Type declaration

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

      • Returns "A1" | "1-1"

    Optional getLocation

    getLocation?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional getMoveTreeNumbering

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

    Type declaration

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

      • Returns "none" | "move-coordinates" | "move-number"

    Optional getNetworkLatency

    getNetworkLatency?: (() => number)

    Type declaration

      • (): number

      • Returns number

    Optional getSelectedThemes

    getSelectedThemes?: (() => GobanSelectedThemes)

    Type declaration

    Optional getShowMoveNumbers

    getShowMoveNumbers?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional getShowVariationMoveNumbers

    getShowVariationMoveNumbers?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional getSoundEnabled

    getSoundEnabled?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional getSoundVolume

    getSoundVolume?: (() => number)

    Type declaration

      • (): number

      • Returns number

    Optional isAnalysisDisabled

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

    Type declaration

      • (goban, perGameSettingAppliesToNonPlayers): boolean

      • Parameters

        • goban: GobanBase
        • perGameSettingAppliesToNonPlayers: boolean

        Returns boolean

    Optional toast

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

    Type declaration

      • (message_id, duration): void

      • Parameters

        • message_id: string
        • duration: number

        Returns void

    Optional updateScoreEstimation

    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

    Optional watchSelectedThemes

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

    Type declaration

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

      • Parameters

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

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

            • Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    addCoordinatesToChatInputcanvasAllocationErrorHandlercustomBlackStoneColorcustomBlackStoneUrlcustomBlackTextColorcustomBoardColorcustomBoardLineColorcustomBoardUrlcustomWhiteStoneColorcustomWhiteStoneUrlcustomWhiteTextColordefaultConfiggetCDNReleaseBasegetClockDriftgetCoordinateDisplaySystemgetLocationgetMoveTreeNumberinggetNetworkLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetSoundEnabledgetSoundVolumeisAnalysisDisabledtoastupdateScoreEstimationwatchSelectedThemes
    \ No newline at end of file +

    Properties

    Optional addCoordinatesToChatInput

    addCoordinatesToChatInput?: ((coordinates) => void)

    Type declaration

      • (coordinates): void

      • Parameters

        • coordinates: string

        Returns void

    Optional canvasAllocationErrorHandler

    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

    Optional customBlackStoneColor

    customBlackStoneColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBlackStoneUrl

    customBlackStoneUrl?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBlackTextColor

    customBlackTextColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBoardColor

    customBoardColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBoardLineColor

    customBoardLineColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customBoardUrl

    customBoardUrl?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customWhiteStoneColor

    customWhiteStoneColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customWhiteStoneUrl

    customWhiteStoneUrl?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional customWhiteTextColor

    customWhiteTextColor?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional defaultConfig

    defaultConfig?: (() => any)

    Type declaration

      • (): any

      • Returns any

    Optional getCDNReleaseBase

    getCDNReleaseBase?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional getClockDrift

    getClockDrift?: (() => number)

    Type declaration

      • (): number

      • Returns number

    Optional getCoordinateDisplaySystem

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

    Type declaration

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

      • Returns "A1" | "1-1"

    Optional getLocation

    getLocation?: (() => string)

    Type declaration

      • (): string

      • Returns string

    Optional getMoveTreeNumbering

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

    Type declaration

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

      • Returns "none" | "move-coordinates" | "move-number"

    Optional getNetworkLatency

    getNetworkLatency?: (() => number)

    Type declaration

      • (): number

      • Returns number

    Optional getSelectedThemes

    getSelectedThemes?: (() => GobanSelectedThemes)

    Type declaration

    Optional getShowMoveNumbers

    getShowMoveNumbers?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional getShowVariationMoveNumbers

    getShowVariationMoveNumbers?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional getSoundEnabled

    getSoundEnabled?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional getSoundVolume

    getSoundVolume?: (() => number)

    Type declaration

      • (): number

      • Returns number

    Optional isAnalysisDisabled

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

    Type declaration

      • (goban, perGameSettingAppliesToNonPlayers): boolean

      • Parameters

        • goban: GobanBase
        • perGameSettingAppliesToNonPlayers: boolean

        Returns boolean

    Optional toast

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

    Type declaration

      • (message_id, duration): void

      • Parameters

        • message_id: string
        • duration: number

        Returns void

    Optional updateScoreEstimation

    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

    Optional watchSelectedThemes

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

    Type declaration

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

      • Parameters

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

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

            • Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    addCoordinatesToChatInputcanvasAllocationErrorHandlercustomBlackStoneColorcustomBlackStoneUrlcustomBlackTextColorcustomBoardColorcustomBoardLineColorcustomBoardUrlcustomWhiteStoneColorcustomWhiteStoneUrlcustomWhiteTextColordefaultConfiggetCDNReleaseBasegetClockDriftgetCoordinateDisplaySystemgetLocationgetMoveTreeNumberinggetNetworkLatencygetSelectedThemesgetShowMoveNumbersgetShowVariationMoveNumbersgetSoundEnabledgetSoundVolumeisAnalysisDisabledtoastupdateScoreEstimationwatchSelectedThemes
    \ No newline at end of file diff --git a/docs/interfaces/GobanCanvasInterface.html b/docs/interfaces/GobanCanvasInterface.html index c2605691..69668586 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 move_tree_container?

    Methods

    clearAnalysisDrawing clearMessage @@ -13,4 +13,4 @@ setLastMoveOpacity setMoveTreeContainer showMessage -

    Properties

    engine

    engine: GobanEngine

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Methods

    clearAnalysisDrawing

    clearMessage

    destroy

    disablePen

    drawPenMarks

    drawSquare

    enablePen

    move_tree_bindCanvasEvents

    move_tree_redraw

    setByoYomiLabel

    setLastMoveOpacity

    setMoveTreeContainer

    showMessage

    • showMessage(message_id_or_error, parameters?, timeout?): void

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    enginemove_tree_containerclearAnalysisDrawingclearMessagedestroydisablePendrawPenMarksdrawSquareenablePenmove_tree_bindCanvasEventsmove_tree_redrawsetByoYomiLabelsetLastMoveOpacitysetMoveTreeContainershowMessage
    \ No newline at end of file +

    Properties

    engine

    engine: GobanEngine

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Methods

    clearAnalysisDrawing

    clearMessage

    destroy

    disablePen

    drawPenMarks

    drawSquare

    enablePen

    move_tree_bindCanvasEvents

    move_tree_redraw

    setByoYomiLabel

    setLastMoveOpacity

    setMoveTreeContainer

    showMessage

    • showMessage(message_id_or_error, parameters?, timeout?): void

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    enginemove_tree_containerclearAnalysisDrawingclearMessagedestroydisablePendrawPenMarksdrawSquareenablePenmove_tree_bindCanvasEventsmove_tree_redrawsetByoYomiLabelsetLastMoveOpacitysetMoveTreeContainershowMessage
    \ No newline at end of file diff --git a/docs/interfaces/GobanConfig.html b/docs/interfaces/GobanConfig.html index 1fa4ae29..11e7a066 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);
        is_game_record?: boolean;
        isobranch_hash?: string;
        komi?: number;
        ladder?: number;
        ladder_id?: number;
        last_move_radius?: number;
        latencies?: {
            [player_id: string]: number;
        };
        leavePushedAnalysis?: (() => void);
        malkovich_log?: GobanChatLog;
        marks?: {
            [mark: string]: string;
        };
        mode?: GobanModes;
        move_tree?: MoveTreeJson;
        moves?: GobanMovesArray;
        name?: string;
        needs_sealing?: JGOFSealingIntersection[];
        ogs?: {
            black_dead_stones: string;
            black_seki_eyes: string;
            black_stones: string;
            black_territory: string;
            white_dead_stones: string;
            white_seki_eyes: string;
            white_stones: string;
            white_territory: string;
        };
        ogs_import?: boolean;
        onError?: ((err) => void);
        onScoreEstimationUpdated?: ((winning_color, points) => void);
        one_click_submit?: boolean;
        opponent_plays_first_after_resume?: boolean;
        original_disable_analysis?: boolean;
        original_sgf?: string;
        outcome?: string;
        pause_control?: AdHocPauseControl;
        paused_since?: number;
        phase?: GobanEnginePhase;
        player?: JGOFNumericPlayerColor;
        player_id?: number;
        player_pool?: {
            [id: number]: GobanEnginePlayerEntry;
        };
        players?: {
            black: GobanEnginePlayerEntry;
            white: GobanEnginePlayerEntry;
        };
        puzzle_autoplace_delay?: number;
        puzzle_collection?: number;
        puzzle_description?: string;
        puzzle_opponent_move_mode?: PuzzleOpponentMoveMode;
        puzzle_player_move_mode?: PuzzlePlayerMoveMode;
        puzzle_rank?: number;
        puzzle_type?: string;
        ranked?: boolean;
        removal?: boolean[][];
        removed?: string | JGOFMove[];
        rengo?: boolean;
        rengo_casual_mode?: boolean;
        rengo_teams?: {
            black: GobanEnginePlayerEntry[];
            white: GobanEnginePlayerEntry[];
        };
        review_id?: number;
        reviews?: {
            [review_id: number]: GobanEnginePlayerEntry;
        };
        rules?: GobanEngineRules;
        score?: Score;
        score_handicap?: boolean;
        score_passes?: boolean;
        score_prisoners?: boolean;
        score_stones?: boolean;
        score_territory?: boolean;
        score_territory_in_seki?: boolean;
        server_socket?: GobanSocket<ClientToServer, ServerToClient>;
        spectator_log?: GobanChatLog;
        square_size?: number | "auto" | ((goban) => number);
        stalling_score_estimate?: StallingScoreEstimate;
        start_time?: number;
        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);
        is_game_record?: boolean;
        isobranch_hash?: string;
        komi?: number;
        ladder?: number;
        ladder_id?: number;
        last_move_radius?: number;
        latencies?: {
            [player_id: string]: number;
        };
        leavePushedAnalysis?: (() => void);
        malkovich_log?: GobanChatLog;
        marks?: {
            [mark: string]: string;
        };
        mode?: GobanModes;
        move_tree?: MoveTreeJson;
        moves?: GobanMovesArray;
        name?: string;
        needs_sealing?: JGOFSealingIntersection[];
        ogs?: {
            black_dead_stones: string;
            black_seki_eyes: string;
            black_stones: string;
            black_territory: string;
            white_dead_stones: string;
            white_seki_eyes: string;
            white_stones: string;
            white_territory: string;
        };
        ogs_import?: boolean;
        onError?: ((err) => void);
        onScoreEstimationUpdated?: ((winning_color, points) => void);
        one_click_submit?: boolean;
        opponent_plays_first_after_resume?: boolean;
        original_disable_analysis?: boolean;
        original_sgf?: string;
        outcome?: string;
        pause_control?: AdHocPauseControl;
        paused_since?: number;
        phase?: GobanEnginePhase;
        player?: JGOFNumericPlayerColor;
        player_id?: number;
        player_pool?: {
            [id: number]: GobanEnginePlayerEntry;
        };
        players?: {
            black: GobanEnginePlayerEntry;
            white: GobanEnginePlayerEntry;
        };
        puzzle_autoplace_delay?: number;
        puzzle_collection?: number;
        puzzle_description?: string;
        puzzle_opponent_move_mode?: PuzzleOpponentMoveMode;
        puzzle_player_move_mode?: PuzzlePlayerMoveMode;
        puzzle_rank?: number;
        puzzle_type?: string;
        ranked?: boolean;
        removal?: boolean[][];
        removed?: string | JGOFMove[];
        rengo?: boolean;
        rengo_casual_mode?: boolean;
        rengo_teams?: {
            black: GobanEnginePlayerEntry[];
            white: GobanEnginePlayerEntry[];
        };
        review_id?: number;
        reviews?: {
            [review_id: number]: GobanEnginePlayerEntry;
        };
        rules?: GobanEngineRules;
        score?: Score;
        score_handicap?: boolean;
        score_passes?: boolean;
        score_prisoners?: boolean;
        score_stones?: boolean;
        score_territory?: boolean;
        score_territory_in_seki?: boolean;
        server_socket?: GobanSocket<ClientToServer, ServerToClient>;
        spectator_log?: GobanChatLog;
        square_size?: number | "auto" | ((goban) => number);
        stalling_score_estimate?: StallingScoreEstimate;
        start_time?: number;
        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? allow_ko? allow_self_capture? allow_superko? @@ -113,13 +113,13 @@ white_prisoners? width? winner? -

    Properties

    Optional aga_handicap_scoring

    aga_handicap_scoring?: boolean

    Optional allow_ko

    allow_ko?: boolean

    Optional allow_self_capture

    allow_self_capture?: boolean

    Optional allow_superko

    allow_superko?: boolean

    Optional auth

    auth?: string

    Optional automatic_stone_removal

    automatic_stone_removal?: boolean

    Optional black_player_id

    black_player_id?: number

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional bounds

    bounds?: GobanBounds

    Optional chat_log

    chat_log?: GobanChatLog

    Optional circle_radius

    circle_radius?: number

    Optional clock

    clock?: GameClock

    Optional connect_to_chat

    connect_to_chat?: number | boolean

    Optional disable_analysis

    disable_analysis?: boolean

    Optional display_width

    display_width?: number

    Optional dont_draw_last_move

    dont_draw_last_move?: boolean

    Optional dont_show_messages

    dont_show_messages?: boolean

    Optional double_click_submit

    double_click_submit?: boolean

    Optional draw_bottom_labels

    draw_bottom_labels?: boolean

    Optional draw_left_labels

    draw_left_labels?: boolean

    Optional draw_right_labels

    draw_right_labels?: boolean

    Optional draw_top_labels

    draw_top_labels?: boolean

    Optional end_time

    end_time?: number

    Optional errors

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

    Type declaration

    • error: string
    • stack: any

    Optional free_handicap_placement

    free_handicap_placement?: boolean

    Optional game_date

    game_date?: string

    Optional game_id

    game_id?: string | number

    Optional game_name

    game_name?: string

    Optional game_type

    game_type?: "temporary"

    Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Optional group_ids

    group_ids?: number[]

    Optional handicap

    handicap?: number

    Optional handicap_rank_difference

    handicap_rank_difference?: number

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional interactive

    interactive?: boolean

    Optional isInPushedAnalysis

    isInPushedAnalysis?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerController

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerOwner

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional is_game_record

    is_game_record?: boolean

    Optional isobranch_hash

    isobranch_hash?: string

    Optional komi

    komi?: number

    Optional ladder

    ladder?: number

    Optional ladder_id

    ladder_id?: number

    Optional last_move_radius

    last_move_radius?: number

    Optional latencies

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

    Type declaration

    • [player_id: string]: number

    Optional leavePushedAnalysis

    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void

      • Returns void

    Optional malkovich_log

    malkovich_log?: GobanChatLog

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional mode

    mode?: GobanModes

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional moves

    moves?: GobanMovesArray

    Optional name

    name?: string

    Optional needs_sealing

    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    -

    Optional ogs

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

    Type declaration

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

    Optional ogs_import

    ogs_import?: boolean

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

    -

    Optional onError

    onError?: ((err) => void)

    Type declaration

      • (err): void

      • Parameters

        • err: Error

        Returns void

    Optional onScoreEstimationUpdated

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

    Type declaration

      • (winning_color, points): void

      • Parameters

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

        Returns void

    Optional one_click_submit

    one_click_submit?: boolean

    Optional opponent_plays_first_after_resume

    opponent_plays_first_after_resume?: boolean

    Optional original_disable_analysis

    original_disable_analysis?: boolean

    Optional original_sgf

    original_sgf?: string

    Optional outcome

    outcome?: string

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    Optional phase

    phase?: GobanEnginePhase

    Optional player

    player?: JGOFNumericPlayerColor

    Optional player_id

    player_id?: number

    Optional player_pool

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

    Type declaration

    Optional players

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

    Type declaration

    Optional puzzle_autoplace_delay

    puzzle_autoplace_delay?: number

    Optional puzzle_collection

    puzzle_collection?: number

    Optional puzzle_description

    puzzle_description?: string

    Optional puzzle_opponent_move_mode

    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

    Optional puzzle_player_move_mode

    puzzle_player_move_mode?: PuzzlePlayerMoveMode

    Optional puzzle_rank

    puzzle_rank?: number

    Optional puzzle_type

    puzzle_type?: string

    Optional ranked

    ranked?: boolean

    Optional removal

    removal?: boolean[][]

    Optional removed

    removed?: string | JGOFMove[]

    Removed stones in stone removal phase +

    Properties

    Optional aga_handicap_scoring

    aga_handicap_scoring?: boolean

    Optional allow_ko

    allow_ko?: boolean

    Optional allow_self_capture

    allow_self_capture?: boolean

    Optional allow_superko

    allow_superko?: boolean

    Optional auth

    auth?: string

    Optional automatic_stone_removal

    automatic_stone_removal?: boolean

    Optional black_player_id

    black_player_id?: number

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional bounds

    bounds?: GobanBounds

    Optional chat_log

    chat_log?: GobanChatLog

    Optional circle_radius

    circle_radius?: number

    Optional clock

    clock?: GameClock

    Optional connect_to_chat

    connect_to_chat?: number | boolean

    Optional disable_analysis

    disable_analysis?: boolean

    Optional display_width

    display_width?: number

    Optional dont_draw_last_move

    dont_draw_last_move?: boolean

    Optional dont_show_messages

    dont_show_messages?: boolean

    Optional double_click_submit

    double_click_submit?: boolean

    Optional draw_bottom_labels

    draw_bottom_labels?: boolean

    Optional draw_left_labels

    draw_left_labels?: boolean

    Optional draw_right_labels

    draw_right_labels?: boolean

    Optional draw_top_labels

    draw_top_labels?: boolean

    Optional end_time

    end_time?: number

    Optional errors

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

    Type declaration

    • error: string
    • stack: any

    Optional free_handicap_placement

    free_handicap_placement?: boolean

    Optional game_date

    game_date?: string

    Optional game_id

    game_id?: string | number

    Optional game_name

    game_name?: string

    Optional game_type

    game_type?: "temporary"

    Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Optional group_ids

    group_ids?: number[]

    Optional handicap

    handicap?: number

    Optional handicap_rank_difference

    handicap_rank_difference?: number

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional interactive

    interactive?: boolean

    Optional isInPushedAnalysis

    isInPushedAnalysis?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerController

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerOwner

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional is_game_record

    is_game_record?: boolean

    Optional isobranch_hash

    isobranch_hash?: string

    Optional komi

    komi?: number

    Optional ladder

    ladder?: number

    Optional ladder_id

    ladder_id?: number

    Optional last_move_radius

    last_move_radius?: number

    Optional latencies

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

    Type declaration

    • [player_id: string]: number

    Optional leavePushedAnalysis

    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void

      • Returns void

    Optional malkovich_log

    malkovich_log?: GobanChatLog

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional mode

    mode?: GobanModes

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional moves

    moves?: GobanMovesArray

    Optional name

    name?: string

    Optional needs_sealing

    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    +

    Optional ogs

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

    Type declaration

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

    Optional ogs_import

    ogs_import?: boolean

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

    +

    Optional onError

    onError?: ((err) => void)

    Type declaration

      • (err): void

      • Parameters

        • err: Error

        Returns void

    Optional onScoreEstimationUpdated

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

    Type declaration

      • (winning_color, points): void

      • Parameters

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

        Returns void

    Optional one_click_submit

    one_click_submit?: boolean

    Optional opponent_plays_first_after_resume

    opponent_plays_first_after_resume?: boolean

    Optional original_disable_analysis

    original_disable_analysis?: boolean

    Optional original_sgf

    original_sgf?: string

    Optional outcome

    outcome?: string

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    Optional phase

    phase?: GobanEnginePhase

    Optional player

    player?: JGOFNumericPlayerColor

    Optional player_id

    player_id?: number

    Optional player_pool

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

    Type declaration

    Optional players

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

    Type declaration

    Optional puzzle_autoplace_delay

    puzzle_autoplace_delay?: number

    Optional puzzle_collection

    puzzle_collection?: number

    Optional puzzle_description

    puzzle_description?: string

    Optional puzzle_opponent_move_mode

    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

    Optional puzzle_player_move_mode

    puzzle_player_move_mode?: PuzzlePlayerMoveMode

    Optional puzzle_rank

    puzzle_rank?: number

    Optional puzzle_type

    puzzle_type?: string

    Optional ranked

    ranked?: boolean

    Optional removal

    removal?: boolean[][]

    Optional removed

    removed?: string | JGOFMove[]

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

    -

    Optional rengo

    rengo?: boolean

    Optional rengo_casual_mode

    rengo_casual_mode?: boolean

    Optional rengo_teams

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

    Type declaration

    Optional review_id

    review_id?: number

    Optional reviews

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

    Type declaration

    Optional rules

    rules?: GobanEngineRules

    Optional score

    score?: Score

    Optional score_handicap

    score_handicap?: boolean

    Optional score_passes

    score_passes?: boolean

    Optional score_prisoners

    score_prisoners?: boolean

    Optional score_stones

    score_stones?: boolean

    Optional score_territory

    score_territory?: boolean

    Optional score_territory_in_seki

    score_territory_in_seki?: boolean

    Optional server_socket

    server_socket?: GobanSocket<ClientToServer, ServerToClient>

    Optional spectator_log

    spectator_log?: GobanChatLog

    Optional square_size

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

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Optional start_time

    start_time?: number

    Optional strict_seki_mode

    strict_seki_mode?: boolean

    Optional superko_algorithm

    superko_algorithm?: GobanEngineSuperKoAlgorithm

    Optional throw_all_errors

    throw_all_errors?: boolean

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

    Optional rengo

    rengo?: boolean

    Optional rengo_casual_mode

    rengo_casual_mode?: boolean

    Optional rengo_teams

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

    Type declaration

    Optional review_id

    review_id?: number

    Optional reviews

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

    Type declaration

    Optional rules

    rules?: GobanEngineRules

    Optional score

    score?: Score

    Optional score_handicap

    score_handicap?: boolean

    Optional score_passes

    score_passes?: boolean

    Optional score_prisoners

    score_prisoners?: boolean

    Optional score_stones

    score_stones?: boolean

    Optional score_territory

    score_territory?: boolean

    Optional score_territory_in_seki

    score_territory_in_seki?: boolean

    Optional server_socket

    server_socket?: GobanSocket<ClientToServer, ServerToClient>

    Optional spectator_log

    spectator_log?: GobanChatLog

    Optional square_size

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

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Optional start_time

    start_time?: number

    Optional strict_seki_mode

    strict_seki_mode?: boolean

    Optional superko_algorithm

    superko_algorithm?: GobanEngineSuperKoAlgorithm

    Optional throw_all_errors

    throw_all_errors?: boolean

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

    -

    Optional time_control

    time_control?: JGOFTimeControl

    Optional time_per_move

    time_per_move?: number

    Optional tournament_id

    tournament_id?: number

    Optional username

    username?: string

    Optional variation_stone_opacity

    variation_stone_opacity?: number

    Optional visual_undo_request_indicator

    visual_undo_request_indicator?: boolean

    Optional white_must_pass_last

    white_must_pass_last?: boolean

    Optional white_player_id

    white_player_id?: number

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Optional winner

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

    Settings

    Member Visibility

    Theme

    On This Page

    aga_handicap_scoringallow_koallow_self_captureallow_superkoauthautomatic_stone_removalblack_player_idblack_prisonersboardboard_is_repeatingboundschat_logcircle_radiusclockconnect_to_chatdisable_analysisdisplay_widthdont_draw_last_movedont_show_messagesdouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegame_typegetPuzzlePlacementSettinggroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwneris_game_recordisobranch_hashkomiladderladder_idlast_move_radiuslatenciesleavePushedAnalysismalkovich_logmarksmodemove_treemovesnameneeds_sealingogsogs_importonErroronScoreEstimationUpdatedone_click_submitopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomepause_controlpaused_sincephaseplayerplayer_idplayer_poolplayerspuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typerankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekiserver_socketspectator_logsquare_sizestalling_score_estimatestart_timestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetournament_idusernamevariation_stone_opacityvisual_undo_request_indicatorwhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner
    \ No newline at end of file +

    Optional time_control

    time_control?: JGOFTimeControl

    Optional time_per_move

    time_per_move?: number

    Optional tournament_id

    tournament_id?: number

    Optional username

    username?: string

    Optional variation_stone_opacity

    variation_stone_opacity?: number

    Optional visual_undo_request_indicator

    visual_undo_request_indicator?: boolean

    Optional white_must_pass_last

    white_must_pass_last?: boolean

    Optional white_player_id

    white_player_id?: number

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Optional winner

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

    Settings

    Member Visibility

    Theme

    On This Page

    aga_handicap_scoringallow_koallow_self_captureallow_superkoauthautomatic_stone_removalblack_player_idblack_prisonersboardboard_is_repeatingboundschat_logcircle_radiusclockconnect_to_chatdisable_analysisdisplay_widthdont_draw_last_movedont_show_messagesdouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegame_typegetPuzzlePlacementSettinggroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwneris_game_recordisobranch_hashkomiladderladder_idlast_move_radiuslatenciesleavePushedAnalysismalkovich_logmarksmodemove_treemovesnameneeds_sealingogsogs_importonErroronScoreEstimationUpdatedone_click_submitopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomepause_controlpaused_sincephaseplayerplayer_idplayer_poolplayerspuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typerankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekiserver_socketspectator_logsquare_sizestalling_score_estimatestart_timestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetournament_idusernamevariation_stone_opacityvisual_undo_request_indicatorwhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner
    \ No newline at end of file diff --git a/docs/interfaces/GobanEngineConfig.html b/docs/interfaces/GobanEngineConfig.html index 3dc91a73..f8fa489f 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;
        is_game_record?: boolean;
        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;
        is_game_record?: boolean;
        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? allow_ko? allow_self_capture? allow_superko? @@ -71,13 +71,13 @@ white_prisoners? width? winner? -

    Properties

    Optional aga_handicap_scoring

    aga_handicap_scoring?: boolean

    Optional allow_ko

    allow_ko?: boolean

    Optional allow_self_capture

    allow_self_capture?: boolean

    Optional allow_superko

    allow_superko?: boolean

    Optional automatic_stone_removal

    automatic_stone_removal?: boolean

    Optional black_player_id

    black_player_id?: number

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional clock

    clock?: GameClock

    Optional disable_analysis

    disable_analysis?: boolean

    Optional end_time

    end_time?: number

    Optional errors

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

    Type declaration

    • error: string
    • stack: any

    Optional free_handicap_placement

    free_handicap_placement?: boolean

    Optional game_date

    game_date?: string

    Optional game_id

    game_id?: string | number

    Optional game_name

    game_name?: string

    Optional group_ids

    group_ids?: number[]

    Optional handicap

    handicap?: number

    Optional handicap_rank_difference

    handicap_rank_difference?: number

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional is_game_record

    is_game_record?: boolean

    Optional isobranch_hash

    isobranch_hash?: string

    Optional komi

    komi?: number

    Optional ladder

    ladder?: number

    Optional ladder_id

    ladder_id?: number

    Optional latencies

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

    Type declaration

    • [player_id: string]: number

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional moves

    moves?: GobanMovesArray

    Optional needs_sealing

    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    -

    Optional ogs

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

    Type declaration

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

    Optional ogs_import

    ogs_import?: boolean

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

    -

    Optional opponent_plays_first_after_resume

    opponent_plays_first_after_resume?: boolean

    Optional original_disable_analysis

    original_disable_analysis?: boolean

    Optional original_sgf

    original_sgf?: string

    Optional outcome

    outcome?: string

    Optional phase

    phase?: GobanEnginePhase

    Optional player

    player?: JGOFNumericPlayerColor

    Optional player_id

    player_id?: number

    Optional player_pool

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

    Type declaration

    Optional players

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

    Type declaration

    Optional ranked

    ranked?: boolean

    Optional removal

    removal?: boolean[][]

    Optional removed

    removed?: string | JGOFMove[]

    Removed stones in stone removal phase +

    Properties

    Optional aga_handicap_scoring

    aga_handicap_scoring?: boolean

    Optional allow_ko

    allow_ko?: boolean

    Optional allow_self_capture

    allow_self_capture?: boolean

    Optional allow_superko

    allow_superko?: boolean

    Optional automatic_stone_removal

    automatic_stone_removal?: boolean

    Optional black_player_id

    black_player_id?: number

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional clock

    clock?: GameClock

    Optional disable_analysis

    disable_analysis?: boolean

    Optional end_time

    end_time?: number

    Optional errors

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

    Type declaration

    • error: string
    • stack: any

    Optional free_handicap_placement

    free_handicap_placement?: boolean

    Optional game_date

    game_date?: string

    Optional game_id

    game_id?: string | number

    Optional game_name

    game_name?: string

    Optional group_ids

    group_ids?: number[]

    Optional handicap

    handicap?: number

    Optional handicap_rank_difference

    handicap_rank_difference?: number

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional is_game_record

    is_game_record?: boolean

    Optional isobranch_hash

    isobranch_hash?: string

    Optional komi

    komi?: number

    Optional ladder

    ladder?: number

    Optional ladder_id

    ladder_id?: number

    Optional latencies

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

    Type declaration

    • [player_id: string]: number

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional moves

    moves?: GobanMovesArray

    Optional needs_sealing

    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    +

    Optional ogs

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

    Type declaration

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

    Optional ogs_import

    ogs_import?: boolean

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

    +

    Optional opponent_plays_first_after_resume

    opponent_plays_first_after_resume?: boolean

    Optional original_disable_analysis

    original_disable_analysis?: boolean

    Optional original_sgf

    original_sgf?: string

    Optional outcome

    outcome?: string

    Optional phase

    phase?: GobanEnginePhase

    Optional player

    player?: JGOFNumericPlayerColor

    Optional player_id

    player_id?: number

    Optional player_pool

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

    Type declaration

    Optional players

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

    Type declaration

    Optional ranked

    ranked?: boolean

    Optional removal

    removal?: boolean[][]

    Optional removed

    removed?: string | JGOFMove[]

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

    -

    Optional rengo

    rengo?: boolean

    Optional rengo_casual_mode

    rengo_casual_mode?: boolean

    Optional rengo_teams

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

    Type declaration

    Optional review_id

    review_id?: number

    Optional reviews

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

    Type declaration

    Optional rules

    rules?: GobanEngineRules

    Optional score

    score?: Score

    Optional score_handicap

    score_handicap?: boolean

    Optional score_passes

    score_passes?: boolean

    Optional score_prisoners

    score_prisoners?: boolean

    Optional score_stones

    score_stones?: boolean

    Optional score_territory

    score_territory?: boolean

    Optional score_territory_in_seki

    score_territory_in_seki?: boolean

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Optional start_time

    start_time?: number

    Optional strict_seki_mode

    strict_seki_mode?: boolean

    Optional superko_algorithm

    superko_algorithm?: GobanEngineSuperKoAlgorithm

    Optional throw_all_errors

    throw_all_errors?: boolean

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

    Optional rengo

    rengo?: boolean

    Optional rengo_casual_mode

    rengo_casual_mode?: boolean

    Optional rengo_teams

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

    Type declaration

    Optional review_id

    review_id?: number

    Optional reviews

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

    Type declaration

    Optional rules

    rules?: GobanEngineRules

    Optional score

    score?: Score

    Optional score_handicap

    score_handicap?: boolean

    Optional score_passes

    score_passes?: boolean

    Optional score_prisoners

    score_prisoners?: boolean

    Optional score_stones

    score_stones?: boolean

    Optional score_territory

    score_territory?: boolean

    Optional score_territory_in_seki

    score_territory_in_seki?: boolean

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Optional start_time

    start_time?: number

    Optional strict_seki_mode

    strict_seki_mode?: boolean

    Optional superko_algorithm

    superko_algorithm?: GobanEngineSuperKoAlgorithm

    Optional throw_all_errors

    throw_all_errors?: boolean

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

    -

    Optional time_control

    time_control?: JGOFTimeControl

    Optional time_per_move

    time_per_move?: number

    Optional tournament_id

    tournament_id?: number

    Optional white_must_pass_last

    white_must_pass_last?: boolean

    Optional white_player_id

    white_player_id?: number

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Optional winner

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

    Settings

    Member Visibility

    Theme

    On This Page

    aga_handicap_scoringallow_koallow_self_captureallow_superkoautomatic_stone_removalblack_player_idblack_prisonersboardboard_is_repeatingclockdisable_analysisend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateis_game_recordisobranch_hashkomiladderladder_idlatenciesmarksmove_treemovesneeds_sealingogsogs_importopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomephaseplayerplayer_idplayer_poolplayersrankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekistalling_score_estimatestart_timestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetournament_idwhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner
    \ No newline at end of file +

    Optional time_control

    time_control?: JGOFTimeControl

    Optional time_per_move

    time_per_move?: number

    Optional tournament_id

    tournament_id?: number

    Optional white_must_pass_last

    white_must_pass_last?: boolean

    Optional white_player_id

    white_player_id?: number

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Optional winner

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

    Settings

    Member Visibility

    Theme

    On This Page

    aga_handicap_scoringallow_koallow_self_captureallow_superkoautomatic_stone_removalblack_player_idblack_prisonersboardboard_is_repeatingclockdisable_analysisend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateis_game_recordisobranch_hashkomiladderladder_idlatenciesmarksmove_treemovesneeds_sealingogsogs_importopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomephaseplayerplayer_idplayer_poolplayersrankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekistalling_score_estimatestart_timestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetournament_idwhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner
    \ No newline at end of file diff --git a/docs/interfaces/GobanEngineInitialState.html b/docs/interfaces/GobanEngineInitialState.html index 4574a2eb..2c69d63e 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

    black? white? -

    Properties

    Optional black

    black?: string

    Optional white

    white?: string

    Settings

    Member Visibility

    Theme

    On This Page

    blackwhite
    \ No newline at end of file +

    Properties

    Optional black

    black?: string

    Optional white

    white?: string

    Settings

    Member Visibility

    Theme

    On This Page

    blackwhite
    \ No newline at end of file diff --git a/docs/interfaces/GobanEnginePlayerEntry.html b/docs/interfaces/GobanEnginePlayerEntry.html index 36c8a6b4..780d8e86 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? accepted_strict_seki_mode? country? id @@ -7,6 +7,6 @@ rank? username

    Properties

    Optional accepted_stones

    accepted_stones?: string

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

    -

    Optional accepted_strict_seki_mode

    accepted_strict_seki_mode?: boolean

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

    -

    Optional country

    country?: string

    id

    id: number

    Optional name

    name?: string

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

    -

    Optional pro

    pro?: boolean

    Optional rank

    rank?: number

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    accepted_stonesaccepted_strict_seki_modecountryidnameprorankusername
    \ No newline at end of file +

    Optional accepted_strict_seki_mode

    accepted_strict_seki_mode?: boolean

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

    +

    Optional country

    country?: string

    id

    id: number

    Optional name

    name?: string

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

    +

    Optional pro

    pro?: boolean

    Optional rank

    rank?: number

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    accepted_stonesaccepted_strict_seki_modecountryidnameprorankusername
    \ No newline at end of file diff --git a/docs/interfaces/GobanEvents.html b/docs/interfaces/GobanEvents.html index 5a05eb93..787d0d55 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 analyze_subtool analyze_tool audio-capture-stones @@ -67,5 +67,5 @@ undo_requested update winner -

    Properties

    advance-to-next-board

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

    Type declaration

      • (): void

      • Returns void

    analyze_subtool

    analyze_subtool: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    analyze_tool

    analyze_tool: ((d) => void)

    Type declaration

    audio-capture-stones

    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

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

    Type declaration

    audio-disconnected

    audio-disconnected: (() => void)

    Type declaration

      • (): void

      • Returns void

    audio-enter-stone-removal

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

    Type declaration

      • (): void

      • Returns void

    audio-game-ended

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

    Type declaration

      • (winner): void

      • Parameters

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

        Returns void

    audio-game-paused

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

    Type declaration

      • (): void

      • Returns void

    audio-game-resumed

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

    Type declaration

      • (): void

      • Returns void

    audio-game-started

    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

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

    Type declaration

      • (obj): void

      • Parameters

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

        Returns void

    audio-other-player-reconnected

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

    Type declaration

      • (obj): void

      • Parameters

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

        Returns void

    audio-pass

    audio-pass: (() => void)

    Type declaration

      • (): void

      • Returns void

    audio-reconnected

    audio-reconnected: (() => void)

    Type declaration

      • (): void

      • Returns void

    audio-resume-game-from-stone-removal

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

    Type declaration

      • (): void

      • Returns void

    audio-stone

    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

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

    Type declaration

      • (): void

      • Returns void

    audio-undo-requested

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

    Type declaration

      • (): void

      • Returns void

    auto-resign

    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

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

    Type declaration

    chat

    chat: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: any

        Returns void

    chat-remove

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

    Type declaration

      • (ids): void

      • Parameters

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

        Returns void

    chat-reset

    chat-reset: (() => void)

    Type declaration

      • (): void

      • Returns void

    clear-auto-resign

    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

    clear-message: (() => void)

    Type declaration

      • (): void

      • Returns void

    clock

    clock: ((clock) => void)

    Type declaration

    conditional-moves.updated

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

    Type declaration

      • (): void

      • Returns void

    cur_move

    cur_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    cur_review_move

    cur_review_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    destroy

    destroy: (() => void)

    Type declaration

      • (): void

      • Returns void

    engine.updated

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

    Type declaration

      • (engine): void

      • Parameters

        Returns void

    error

    error: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: any

        Returns void

    gamedata

    gamedata: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: any

        Returns void

    last_official_move

    last_official_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    load

    load: ((config) => void)

    Type declaration

      • (config): void

      • Parameters

        Returns void

    mode

    mode: ((d) => void)

    Type declaration

    move-made

    move-made: (() => void)

    Type declaration

      • (): void

      • Returns void

    outcome

    outcome: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    paused

    paused: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: boolean

        Returns void

    phase

    phase: ((d) => void)

    Type declaration

    played-by-click

    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-update: ((player) => void)

    Type declaration

    puzzle-correct-answer

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

    Type declaration

      • (): void

      • Returns void

    puzzle-place

    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

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

    Type declaration

      • (): void

      • Returns void

    review.load-end

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

    Type declaration

      • (): void

      • Returns void

    review.load-start

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

    Type declaration

      • (): void

      • Returns void

    review.sync-to-current-move

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

    Type declaration

      • (): void

      • Returns void

    review.updated

    review.updated: (() => void)

    Type declaration

      • (): void

      • Returns void

    review_controller_id

    review_controller_id: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    review_owner_id

    review_owner_id: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    rules

    rules: ((d) => void)

    Type declaration

    score_estimate

    score_estimate: ((d) => void)

    Type declaration

    set-for-removal

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

    Type declaration

    • removed: boolean
    • x: number
    • y: number

    show-message

    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

    stalling_score_estimate: ((data?) => void)

    Type declaration

    state_text

    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

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

    Type declaration

      • (): void

      • Returns void

    stone-removal.needs-sealing

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

    Type declaration

    stone-removal.updated

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

    Type declaration

      • (): void

      • Returns void

    strict_seki_mode

    strict_seki_mode: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: boolean

        Returns void

    submit_move

    submit_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

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

        Returns void

    submitting-move

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

    Type declaration

      • (tf): void

      • Parameters

        • tf: boolean

        Returns void

    title

    title: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    undo_canceled

    undo_canceled: (() => void)

    Type declaration

      • (): void

      • Returns void

    undo_requested

    undo_requested: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    update

    update: (() => void)

    Type declaration

      • (): void

      • Returns void

    winner

    winner: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    advance-to-next-boardanalyze_subtoolanalyze_toolaudio-capture-stonesaudio-clockaudio-disconnectedaudio-enter-stone-removalaudio-game-endedaudio-game-pausedaudio-game-resumedaudio-game-startedaudio-other-player-disconnectedaudio-other-player-reconnectedaudio-passaudio-reconnectedaudio-resume-game-from-stone-removalaudio-stoneaudio-undo-grantedaudio-undo-requestedauto-resigncaptured-stoneschatchat-removechat-resetclear-auto-resignclear-messageclockconditional-moves.updatedcur_movecur_review_movedestroyengine.updatederrorgamedatalast_official_moveloadmodemove-madeoutcomepausedphaseplayed-by-clickplayer-updatepuzzle-correct-answerpuzzle-placepuzzle-wrong-answerreview.load-endreview.load-startreview.sync-to-current-movereview.updatedreview_controller_idreview_owner_idrulesscore_estimateset-for-removalshow-messagestalling_score_estimatestate_textstone-removal.acceptedstone-removal.needs-sealingstone-removal.updatedstrict_seki_modesubmit_movesubmitting-movetitleundo_canceledundo_requestedupdatewinner
    \ No newline at end of file +

    Properties

    advance-to-next-board

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

    Type declaration

      • (): void

      • Returns void

    analyze_subtool

    analyze_subtool: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    analyze_tool

    analyze_tool: ((d) => void)

    Type declaration

    audio-capture-stones

    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

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

    Type declaration

    audio-disconnected

    audio-disconnected: (() => void)

    Type declaration

      • (): void

      • Returns void

    audio-enter-stone-removal

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

    Type declaration

      • (): void

      • Returns void

    audio-game-ended

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

    Type declaration

      • (winner): void

      • Parameters

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

        Returns void

    audio-game-paused

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

    Type declaration

      • (): void

      • Returns void

    audio-game-resumed

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

    Type declaration

      • (): void

      • Returns void

    audio-game-started

    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

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

    Type declaration

      • (obj): void

      • Parameters

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

        Returns void

    audio-other-player-reconnected

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

    Type declaration

      • (obj): void

      • Parameters

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

        Returns void

    audio-pass

    audio-pass: (() => void)

    Type declaration

      • (): void

      • Returns void

    audio-reconnected

    audio-reconnected: (() => void)

    Type declaration

      • (): void

      • Returns void

    audio-resume-game-from-stone-removal

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

    Type declaration

      • (): void

      • Returns void

    audio-stone

    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

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

    Type declaration

      • (): void

      • Returns void

    audio-undo-requested

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

    Type declaration

      • (): void

      • Returns void

    auto-resign

    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

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

    Type declaration

    chat

    chat: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: any

        Returns void

    chat-remove

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

    Type declaration

      • (ids): void

      • Parameters

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

        Returns void

    chat-reset

    chat-reset: (() => void)

    Type declaration

      • (): void

      • Returns void

    clear-auto-resign

    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

    clear-message: (() => void)

    Type declaration

      • (): void

      • Returns void

    clock

    clock: ((clock) => void)

    Type declaration

    conditional-moves.updated

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

    Type declaration

      • (): void

      • Returns void

    cur_move

    cur_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    cur_review_move

    cur_review_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    destroy

    destroy: (() => void)

    Type declaration

      • (): void

      • Returns void

    engine.updated

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

    Type declaration

      • (engine): void

      • Parameters

        Returns void

    error

    error: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: any

        Returns void

    gamedata

    gamedata: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: any

        Returns void

    last_official_move

    last_official_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    load

    load: ((config) => void)

    Type declaration

      • (config): void

      • Parameters

        Returns void

    mode

    mode: ((d) => void)

    Type declaration

    move-made

    move-made: (() => void)

    Type declaration

      • (): void

      • Returns void

    outcome

    outcome: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    paused

    paused: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: boolean

        Returns void

    phase

    phase: ((d) => void)

    Type declaration

    played-by-click

    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-update: ((player) => void)

    Type declaration

    puzzle-correct-answer

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

    Type declaration

      • (): void

      • Returns void

    puzzle-place

    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

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

    Type declaration

      • (): void

      • Returns void

    review.load-end

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

    Type declaration

      • (): void

      • Returns void

    review.load-start

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

    Type declaration

      • (): void

      • Returns void

    review.sync-to-current-move

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

    Type declaration

      • (): void

      • Returns void

    review.updated

    review.updated: (() => void)

    Type declaration

      • (): void

      • Returns void

    review_controller_id

    review_controller_id: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    review_owner_id

    review_owner_id: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    rules

    rules: ((d) => void)

    Type declaration

    score_estimate

    score_estimate: ((d) => void)

    Type declaration

    set-for-removal

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

    Type declaration

    • removed: boolean
    • x: number
    • y: number

    show-message

    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

    stalling_score_estimate: ((data?) => void)

    Type declaration

    state_text

    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

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

    Type declaration

      • (): void

      • Returns void

    stone-removal.needs-sealing

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

    Type declaration

    stone-removal.updated

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

    Type declaration

      • (): void

      • Returns void

    strict_seki_mode

    strict_seki_mode: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: boolean

        Returns void

    submit_move

    submit_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

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

        Returns void

    submitting-move

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

    Type declaration

      • (tf): void

      • Parameters

        • tf: boolean

        Returns void

    title

    title: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    undo_canceled

    undo_canceled: (() => void)

    Type declaration

      • (): void

      • Returns void

    undo_requested

    undo_requested: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    update

    update: (() => void)

    Type declaration

      • (): void

      • Returns void

    winner

    winner: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    advance-to-next-boardanalyze_subtoolanalyze_toolaudio-capture-stonesaudio-clockaudio-disconnectedaudio-enter-stone-removalaudio-game-endedaudio-game-pausedaudio-game-resumedaudio-game-startedaudio-other-player-disconnectedaudio-other-player-reconnectedaudio-passaudio-reconnectedaudio-resume-game-from-stone-removalaudio-stoneaudio-undo-grantedaudio-undo-requestedauto-resigncaptured-stoneschatchat-removechat-resetclear-auto-resignclear-messageclockconditional-moves.updatedcur_movecur_review_movedestroyengine.updatederrorgamedatalast_official_moveloadmodemove-madeoutcomepausedphaseplayed-by-clickplayer-updatepuzzle-correct-answerpuzzle-placepuzzle-wrong-answerreview.load-endreview.load-startreview.sync-to-current-movereview.updatedreview_controller_idreview_owner_idrulesscore_estimateset-for-removalshow-messagestalling_score_estimatestate_textstone-removal.acceptedstone-removal.needs-sealingstone-removal.updatedstrict_seki_modesubmit_movesubmitting-movetitleundo_canceledundo_requestedupdatewinner
    \ No newline at end of file diff --git a/docs/interfaces/GobanIOErrorMessageObject.html b/docs/interfaces/GobanIOErrorMessageObject.html index eaaf3f24..e8363abc 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

    message_id url -

    Properties

    message_id

    message_id: "failed_to_load_sgf"

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    message_idurl
    \ No newline at end of file +

    Properties

    message_id

    message_id: "failed_to_load_sgf"

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    message_idurl
    \ No newline at end of file diff --git a/docs/interfaces/GobanMetrics.html b/docs/interfaces/GobanMetrics.html index 4173aff4..d2c81e08 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

    height mid offset width -

    Properties

    height

    height: number

    mid

    mid: number

    offset

    offset: number

    width

    width: number

    Settings

    Member Visibility

    Theme

    On This Page

    heightmidoffsetwidth
    \ No newline at end of file +

    Properties

    height

    height: number

    mid

    mid: number

    offset

    offset: number

    width

    width: number

    Settings

    Member Visibility

    Theme

    On This Page

    heightmidoffsetwidth
    \ No newline at end of file diff --git a/docs/interfaces/GobanMoveErrorMessageObject.html b/docs/interfaces/GobanMoveErrorMessageObject.html index b74b929b..898ada1a 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 message_id move_number -

    Properties

    coords

    coords: string

    message_id

    message_id: GobanMoveErrorMessageId

    move_number

    move_number: number

    Settings

    Member Visibility

    Theme

    On This Page

    coordsmessage_idmove_number
    \ No newline at end of file +

    Properties

    coords

    coords: string

    message_id

    message_id: GobanMoveErrorMessageId

    move_number

    move_number: number

    Settings

    Member Visibility

    Theme

    On This Page

    coordsmessage_idmove_number
    \ No newline at end of file diff --git a/docs/interfaces/GobanSelectedThemes.html b/docs/interfaces/GobanSelectedThemes.html index 92f65c37..346d8901 100644 --- a/docs/interfaces/GobanSelectedThemes.html +++ b/docs/interfaces/GobanSelectedThemes.html @@ -1,6 +1,6 @@ -GobanSelectedThemes | goban

    Interface GobanSelectedThemes

    interface GobanSelectedThemes {
        black: string;
        board: string;
        removal-graphic: "x" | "square";
        removal-scale: number;
        white: string;
    }

    Properties

    black +GobanSelectedThemes | goban

    Interface GobanSelectedThemes

    interface GobanSelectedThemes {
        black: string;
        board: string;
        removal-graphic: "x" | "square";
        removal-scale: number;
        white: string;
    }

    Properties

    black board removal-graphic removal-scale white -

    Properties

    black

    black: string

    board

    board: string

    removal-graphic

    removal-graphic: "x" | "square"

    removal-scale

    removal-scale: number

    white

    white: string

    Settings

    Member Visibility

    Theme

    On This Page

    blackboardremoval-graphicremoval-scalewhite
    \ No newline at end of file +

    Properties

    black

    black: string

    board

    board: string

    removal-graphic

    removal-graphic: "x" | "square"

    removal-scale

    removal-scale: number

    white

    white: string

    Settings

    Member Visibility

    Theme

    On This Page

    blackboardremoval-graphicremoval-scalewhite
    \ No newline at end of file diff --git a/docs/interfaces/GobanSocketEvents.html b/docs/interfaces/GobanSocketEvents.html index e74dc415..ac696876 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

    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

    HUP: (() => void)

    The client should reload

    -

    Type declaration

      • (): void

      • Returns void

    active-bots

    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

    active_game: ((data) => void)

    Message to inform the client of an active game, or a change to an existing game

    -

    Type declaration

    automatch/cancel

    automatch/cancel: ((data) => void)

    An automatch request was canceled

    -

    Type declaration

      • (data): void

      • Parameters

        • data: {
              uuid: string;
          }
          • uuid: string

        Returns void

    automatch/entry

    automatch/entry: ((data) => void)

    An automatch request is active

    -

    Type declaration

    automatch/start

    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

    chat-join: ((data) => void)

    User(s) joined a chat channel

    +

    Type declaration

      • (data): void

      • Parameters

        • data: string | {
              errcode: string;
          }

        Returns void

    HUP

    HUP: (() => void)

    The client should reload

    +

    Type declaration

      • (): void

      • Returns void

    active-bots

    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

    active_game: ((data) => void)

    Message to inform the client of an active game, or a change to an existing game

    +

    Type declaration

    automatch/cancel

    automatch/cancel: ((data) => void)

    An automatch request was canceled

    +

    Type declaration

      • (data): void

      • Parameters

        • data: {
              uuid: string;
          }
          • uuid: string

        Returns void

    automatch/entry

    automatch/entry: ((data) => void)

    An automatch request is active

    +

    Type declaration

    automatch/start

    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

    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

    chat-message: ((data) => void)

    Chat message was received

    +

    Returns void

    chat-message

    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

    chat-message-removed: ((data) => void)

    A chat message should be removed from the display

    +

    Returns void

    chat-message-removed

    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

    chat-part: ((data) => void)

    User left a chat channel

    +

    Returns void

    chat-part

    chat-part: ((data) => void)

    User left a chat channel

    Type declaration

      • (data): void

      • Parameters

        • data: {
              channel: string;
              user: User;
          }
          • channel: string

            The channel

          • user: User

            User that left

            -

        Returns void

    chat-topic

    chat-topic: ((data) => void)

    Channel topic was updated

    +

    Returns void

    chat-topic

    chat-topic: ((data) => void)

    Channel topic was updated

    Type declaration

      • (data): void

      • Parameters

        • data: {
              channel: string;
              country?: string;
              id: number;
              professional: boolean;
              ranking: number;
              timestamp: number;
              topic: string;
              ui_class: string;
              username: string;
          }
          • channel: string

            The channel

          • Optional country?: string

            Country of the user that changed the topic

          • id: number

            User id of the user that changed the topic

            @@ -95,40 +95,40 @@
          • topic: string

            The new topic

          • ui_class: string

            UI class of the user that changed the topic

          • username: string

            Username of the user that changed the topic

            -

        Returns void

    chat-update-user

    chat-update-user: ((data) => void)

    A user's profile was updated

    +

    Returns void

    chat-update-user

    chat-update-user: ((data) => void)

    A user's profile was updated

    Type declaration

      • (data): void

      • Parameters

        • data: {
              channel: string;
              old_player_id: number;
              user: User;
          }
          • channel: string

            The channel

          • old_player_id: number

            Player id entry that was update. This might change in the case of a guest logging in, in this case this will switch from being a negative (guest) id, to some positive id. It is not expected that a non guest id should change using this system.

          • user: User

            New user details

            -

        Returns void

    connect

    connect: (() => void)

    Type declaration

      • (): void

      • Returns void

    disconnect

    disconnect: ((code) => void)

    Type declaration

      • (code): void

      • Parameters

        • code: number

        Returns void

    game/:id/auto_resign

    game/:id/auto_resign: ((data) => void)

    Informs the client the player is scheduled to resign if not cleared

    +

    Returns void

    connect

    connect: (() => void)

    Type declaration

      • (): void

      • Returns void

    disconnect

    disconnect: ((code) => void)

    Type declaration

      • (code): void

      • Parameters

        • code: number

        Returns void

    game/:id/auto_resign

    game/:id/auto_resign: ((data) => void)

    Informs the client the player is scheduled to resign if not cleared

    Type declaration

      • (data): void

      • Parameters

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

            When the auto resign will happen

          • game_id: number

            The game id

          • player_id: number

            The player id

            -

        Returns void

    game/:id/chat

    game/:id/chat: ((data) => void)

    A game chat message

    -

    Type declaration

    game/:id/chat/remove

    game/:id/chat/remove: ((data) => void)

    Game chat lines should be removed

    +

    Returns void

    game/:id/chat

    game/:id/chat: ((data) => void)

    A game chat message

    +

    Type declaration

    game/:id/chat/remove

    game/:id/chat/remove: ((data) => void)

    Game chat lines should be removed

    Type declaration

      • (data): void

      • Parameters

        • data: {
              chat_ids: string[];
              game_id: number;
          }
          • chat_ids: string[]

            The chat ids

          • game_id: number

            The game id

            -

        Returns void

    game/:id/clear_auto_resign

    game/:id/clear_auto_resign: ((data) => void)

    The auto resign for the given player has been cleared

    +

    Returns void

    game/:id/clear_auto_resign

    game/:id/clear_auto_resign: ((data) => void)

    The auto resign for the given player has been cleared

    Type declaration

      • (data): void

      • Parameters

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

            The game id

          • player_id: number

            The player id

            -

        Returns void

    game/:id/clock

    game/:id/clock: ((data) => void)

    Game clock update

    -

    Type declaration

      • (data): void

      • Parameters

        Returns void

    game/:id/conditional_moves

    game/:id/conditional_moves: ((data) => void)

    Update the conditional moves currently active

    +

    Returns void

    game/:id/clock

    game/:id/clock: ((data) => void)

    Game clock update

    +

    Type declaration

      • (data): void

      • Parameters

        Returns void

    game/:id/conditional_moves

    game/:id/conditional_moves: ((data) => void)

    Update the conditional moves currently active

    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/:id/error

    game/:id/error: ((data) => void)

    Error that should be displayed to the user

    -

    Type declaration

      • (data): void

      • Parameters

        • data: string

        Returns void

    game/:id/gamedata

    game/:id/gamedata: ((data) => void)

    Update the entire game state

    -

    Type declaration

    game/:id/latency

    game/:id/latency: ((data) => void)

    Update latency information for a player

    +

    Returns void

    game/:id/error

    game/:id/error: ((data) => void)

    Error that should be displayed to the user

    +

    Type declaration

      • (data): void

      • Parameters

        • data: string

        Returns void

    game/:id/gamedata

    game/:id/gamedata: ((data) => void)

    Update the entire game state

    +

    Type declaration

    game/:id/latency

    game/:id/latency: ((data) => void)

    Update latency information for a player

    Type declaration

      • (data): void

      • Parameters

        • data: {
              game_id: number;
              latency: number;
              player_id: number;
          }
          • game_id: number

            The game id

          • latency: number

            The latency in milliseconds

          • player_id: number

            The player id

            -

        Returns void

    game/:id/phase

    game/:id/phase: ((data) => void)

    The phase has changed for the game

    -

    Type declaration

      • (data): void

      • Parameters

        • data: "play" | "stone removal" | "finished"

        Returns void

    game/:id/removed_stones

    game/:id/removed_stones: ((data) => void)

    Update the state of the stone removal phase

    -

    Type declaration

      • (data): void

      • Parameters

        • data: {
              all_removed: string;
              removed: boolean;
              stones: string;
          } | {
              strict_seki_mode: boolean;
          }

        Returns void

    game/:id/removed_stones_accepted

    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

    game/:id/phase: ((data) => void)

    The phase has changed for the game

    +

    Type declaration

      • (data): void

      • Parameters

        • data: "play" | "stone removal" | "finished"

        Returns void

    game/:id/removed_stones

    game/:id/removed_stones: ((data) => void)

    Update the state of the stone removal phase

    +

    Type declaration

      • (data): void

      • Parameters

        • data: {
              all_removed: string;
              removed: boolean;
              stones: string;
          } | {
              strict_seki_mode: boolean;
          }

        Returns void

    game/:id/removed_stones_accepted

    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

      • (data): void

      • Parameters

        • data: {
              end_time: number;
              outcome: string;
              phase: "finished";
              player_id: number;
              players: {
                  black: User | {
                      accepted_stones: string;
                      accepted_strict_seki_mode: boolean;
                  };
                  white: User | {
                      accepted_stones: string;
                      accepted_strict_seki_mode: boolean;
                  };
              };
              score: Score;
              stones: string;
              strict_seki_mode: boolean;
              winner: number;
          }
          • end_time: number

            Timestamp in ms

            @@ -140,26 +140,26 @@
          • stones: string
          • strict_seki_mode: boolean

            True if Japanese strict seki mode was true. This will probably always be false and may be removed in the future.

          • winner: number

            Player id of the winner

            -

        Returns void

    game/:id/reset-chats

    game/:id/reset-chats: (() => void)

    The chat log should be reset.

    -

    Type declaration

      • (): void

      • Returns void

    game/:id/stalling_score_estimate

    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

    game/:id/undo_accepted: ((data) => void)

    Undo move has been accepted, the parameter is the new move number

    -

    Type declaration

      • (data): void

      • Parameters

        • data: number

        Returns void

    game/:id/undo_canceled

    game/:id/undo_canceled: ((data) => void)

    Undo request has been canceled, the parameter is the move number of the original request

    -

    Type declaration

      • (data): void

      • Parameters

        • data: number

        Returns void

    game/:id/undo_requested

    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

      • (data): void

      • Parameters

        • data: number

        Returns void

    gamelist-count

    gamelist-count: ((data) => void)

    Update number of live and correspondence games are currently being +

    Returns void

    game/:id/reset-chats

    game/:id/reset-chats: (() => void)

    The chat log should be reset.

    +

    Type declaration

      • (): void

      • Returns void

    game/:id/stalling_score_estimate

    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

    game/:id/undo_accepted: ((data) => void)

    Undo move has been accepted, the parameter is the new move number

    +

    Type declaration

      • (data): void

      • Parameters

        • data: number

        Returns void

    game/:id/undo_canceled

    game/:id/undo_canceled: ((data) => void)

    Undo request has been canceled, the parameter is the move number of the original request

    +

    Type declaration

      • (data): void

      • Parameters

        • data: number

        Returns void

    game/:id/undo_requested

    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

      • (data): void

      • Parameters

        • data: number

        Returns void

    gamelist-count

    gamelist-count: ((data) => void)

    Update number of live and correspondence games are currently being played

    Type declaration

      • (data): void

      • Parameters

        • data: {
              correspondence: number;
              live: number;
          }
          • correspondence: number

            Number of correspondence games

          • live: number

            Number of live games

            -

        Returns void

    gamelist-count-:channel

    gamelist-count-:channel: ((data) => void)

    Update number of live and correspondence games are currently being +

    Returns void

    gamelist-count-:channel

    gamelist-count-:channel: ((data) => void)

    Update number of live and correspondence games are currently being played in a particular channel

    Type declaration

      • (data): void

      • Parameters

        • data: {
              correspondence: number;
              live: number;
          }
          • correspondence: number

            Number of correspondence games

          • live: number

            Number of live games

            -

        Returns void

    hostinfo

    hostinfo: ((data) => void)

    General host information for the termination server you +

    Returns void

    hostinfo

    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

      • (data): void

      • Parameters

        • data: {
              clients: number;
              hostname: string;
              uptime: number;
          }
          • clients: number

            Number of clients connected, if available

          • hostname: string

            The hostname of the server

          • uptime: number

            Number of seconds the server has been running

            -

        Returns void

    incident-report

    incident-report: ((data) => void)

    Incident report update

    -

    Type declaration

      • (data): void

      • Parameters

        • data: {
              cleared_by_user?: boolean;
              created: string;
              id: number;
              moderator?: User;
              moderator_note: string;
              report_type: string;
              reported_conversation?: string;
              reported_game?: number;
              reported_review?: number;
              reported_user?: User;
              reporter_note: string;
              reporter_note_translation: {
                  source_language: string;
                  source_text: string;
                  target_language: string;
                  target_text: string;
              };
              reporting_user?: User;
              source: string;
              state: "pending" | "claimed" | "resolved";
              system_note: string;
              updated: string;
              url: string;
              was_helpful: boolean;
          }
          • Optional cleared_by_user?: boolean
          • created: string
          • id: number
          • Optional moderator?: User
          • moderator_note: string
          • report_type: string
          • Optional reported_conversation?: string
          • Optional reported_game?: number
          • Optional reported_review?: number
          • Optional reported_user?: User
          • reporter_note: string
          • reporter_note_translation: {
                source_language: string;
                source_text: string;
                target_language: string;
                target_text: string;
            }
            • source_language: string
            • source_text: string
            • target_language: string
            • target_text: string
          • Optional reporting_user?: User
          • source: string
          • state: "pending" | "claimed" | "resolved"
          • system_note: string
          • updated: string
          • url: string
          • was_helpful: boolean

        Returns void

    itc

    itc: ((data) => void)

    "Inter Tab Communication" message. This is a client utility to enable +

    Returns void

    incident-report

    incident-report: ((data) => void)

    Incident report update

    +

    Type declaration

      • (data): void

      • Parameters

        • data: {
              cleared_by_user?: boolean;
              created: string;
              id: number;
              moderator?: User;
              moderator_note: string;
              report_type: string;
              reported_conversation?: string;
              reported_game?: number;
              reported_review?: number;
              reported_user?: User;
              reporter_note: string;
              reporter_note_translation: {
                  source_language: string;
                  source_text: string;
                  target_language: string;
                  target_text: string;
              };
              reporting_user?: User;
              source: string;
              state: "pending" | "claimed" | "resolved";
              system_note: string;
              updated: string;
              url: string;
              was_helpful: boolean;
          }
          • Optional cleared_by_user?: boolean
          • created: string
          • id: number
          • Optional moderator?: User
          • moderator_note: string
          • report_type: string
          • Optional reported_conversation?: string
          • Optional reported_game?: number
          • Optional reported_review?: number
          • Optional reported_user?: User
          • reporter_note: string
          • reporter_note_translation: {
                source_language: string;
                source_text: string;
                target_language: string;
                target_text: string;
            }
            • source_language: string
            • source_text: string
            • target_language: string
            • target_text: string
          • Optional reporting_user?: User
          • source: string
          • state: "pending" | "claimed" | "resolved"
          • system_note: string
          • updated: string
          • url: string
          • was_helpful: boolean

        Returns void

    itc

    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

      • (data): void

      • Parameters

        • data: {
              data: any;
              event: string;
          }
          • data: any

            User defined data

          • event: string

            User defined event string

            -

        Returns void

    latency

    latency: ((latency, clock_drift) => void)

    Type declaration

      • (latency, clock_drift): void

      • Parameters

        • latency: number
        • clock_drift: number

        Returns void

    net/pong

    net/pong: ((data) => void)

    Pong response from a ping

    +

    Returns void

    latency

    latency: ((latency, clock_drift) => void)

    Type declaration

      • (latency, clock_drift): void

      • Parameters

        • latency: number
        • clock_drift: number

        Returns void

    net/pong

    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

    notification

    notification: ((data) => void)

    A notification that should be displayed to the user +

    Returns void

    notification

    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

      • (data): void

      • Parameters

        • data: {
              id: string;
              type: string;
              [key: string]: any;
          }
          • [key: string]: any

            There are often more fields here

          • id: string

            The notification id

          • type: string

            The notification type

            -

        Returns void

    private-message

    private-message: ((data) => void)

    A private message was received

    +

    Returns void

    private-message

    private-message: ((data) => void)

    A private message was received

    Type declaration

      • (data): void

      • Parameters

        • data: {
              from: User;
              message: {
                  i: string;
                  m: string;
                  t: number;
              };
              superchat_enabled?: boolean;
              to: User;
          }
          • from: User

            Who sent the message

          • message: {
                i: string;
                m: string;
                t: number;
            }

            The message received

            • i: string

              Message id.

              @@ -188,7 +188,7 @@ is when a moderator needs to talk with a player and ignoring the moderator is not suitable thing to do.

            • to: User

              Your user id

              -

        Returns void

    private-superchat

    private-superchat: ((data) => void)

    Notify the client that a private message "super chat" has started. A +

    Returns void

    private-superchat

    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

    reconnect: (() => void)

    Type declaration

      • (): void

      • Returns void

    remote_storage/sync_complete

    remote_storage/sync_complete: (() => void)

    Notification that the server has completed sending all remote storage +

    Returns void

    reconnect

    reconnect: (() => void)

    Type declaration

      • (): void

      • Returns void

    remote_storage/sync_complete

    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

      • (): void

      • Returns void

    remote_storage/update

    remote_storage/update: ((data) => void)

    Updates a key value pair

    +

    Type declaration

      • (): void

      • Returns void

    remote_storage/update

    remote_storage/update: ((data) => void)

    Updates a key value pair

    Type declaration

      • (data): void

      • Parameters

        • data: {
              key: string;
              modified: string;
              replication: RemoteStorageReplication;
              value: any;
          }
          • key: string

            Key for the k/v pair

          • modified: string

            Timestamp of the update

          • replication: RemoteStorageReplication

            Replication mode

          • value: any

            Value of of the k/v pair

            -

        Returns void

    review/:id/full_state

    review/:id/full_state: ((data) => void)

    Replay of the entire full state of the review

    -

    Type declaration

    review/:id/r

    review/:id/r: ((data) => void)

    An incremental modification to the review stream

    -

    Type declaration

    score-estimator-enabled-state

    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

    review/:id/full_state: ((data) => void)

    Replay of the entire full state of the review

    +

    Type declaration

    review/:id/r

    review/:id/r: ((data) => void)

    An incremental modification to the review stream

    +

    Type declaration

    score-estimator-enabled-state

    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

      • (data): void

      • Parameters

        • data: {
              game_id: number;
              shared_ip_with_player: boolean;
          }
          • game_id: number

            The game ID

          • shared_ip_with_player: boolean

            True if the client shares an IP with one of the players of the game

            -

        Returns void

    seekgraph/global

    seekgraph/global: ((messages) => void)

    Type declaration

    timeout

    timeout: (() => void)

    Type declaration

      • (): void

      • Returns void

    ui-push

    ui-push: ((data) => void)

    A UI Push notification. The event and data are not well defined here, +

    Returns void

    seekgraph/global

    seekgraph/global: ((messages) => void)

    Type declaration

    timeout

    timeout: (() => void)

    Type declaration

      • (): void

      • Returns void

    ui-push

    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

      • (data): void

      • Parameters

        • data: {
              data: string;
              event: string;
          }
          • data: string

            UI Push data

          • event: string

            UI Push event

            -

        Returns void

    unrecoverable_error

    unrecoverable_error: ((code, tag, message) => void)

    Type declaration

      • (code, tag, message): void

      • Parameters

        • code: number
        • tag: string
        • message: string

        Returns void

    user/jwt

    user/jwt: ((jwt) => void)

    Update the user's JWT token

    -

    Type declaration

      • (jwt): void

      • Parameters

        • jwt: string

        Returns void

    user/state

    user/state: ((data) => void)

    Updates whether a user is online or not. Subscribe to these updates for +

    Returns void

    unrecoverable_error

    unrecoverable_error: ((code, tag, message) => void)

    Type declaration

      • (code, tag, message): void

      • Parameters

        • code: number
        • tag: string
        • message: string

        Returns void

    user/jwt

    user/jwt: ((jwt) => void)

    Update the user's JWT token

    +

    Type declaration

      • (jwt): void

      • Parameters

        • jwt: string

        Returns void

    user/state

    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

      • (data): void

      • Parameters

        • data: {
              [player_id: number]: boolean;
          }
          • [player_id: number]: boolean

        Returns void

    user/update

    user/update: ((user) => void)

    Update user information. For other players, this has the standard User +

    Type declaration

      • (data): void

      • Parameters

        • data: {
              [player_id: number]: boolean;
          }
          • [player_id: number]: boolean

        Returns void

    user/update

    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

      • (user): void

      • Parameters

        • user: User & {
              [extra: string]: any;
          }

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    ERRORHUPactive-botsactive_gameautomatch/cancelautomatch/entryautomatch/startchat-joinchat-messagechat-message-removedchat-partchat-topicchat-update-userconnectdisconnectgame/:id/auto_resigngame/:id/chatgame/:id/chat/removegame/:id/clear_auto_resigngame/:id/clockgame/:id/conditional_movesgame/:id/errorgame/:id/gamedatagame/:id/latencygame/:id/phasegame/:id/removed_stonesgame/:id/removed_stones_acceptedgame/:id/reset-chatsgame/:id/stalling_score_estimategame/:id/undo_acceptedgame/:id/undo_canceledgame/:id/undo_requestedgamelist-countgamelist-count-:channelhostinfoincident-reportitclatencynet/pongnotificationprivate-messageprivate-superchatreconnectremote_storage/sync_completeremote_storage/updatereview/:id/full_statereview/:id/rscore-estimator-enabled-stateseekgraph/globaltimeoutui-pushunrecoverable_erroruser/jwtuser/stateuser/update
    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    ERRORHUPactive-botsactive_gameautomatch/cancelautomatch/entryautomatch/startchat-joinchat-messagechat-message-removedchat-partchat-topicchat-update-userconnectdisconnectgame/:id/auto_resigngame/:id/chatgame/:id/chat/removegame/:id/clear_auto_resigngame/:id/clockgame/:id/conditional_movesgame/:id/errorgame/:id/gamedatagame/:id/latencygame/:id/phasegame/:id/removed_stonesgame/:id/removed_stones_acceptedgame/:id/reset-chatsgame/:id/stalling_score_estimategame/:id/undo_acceptedgame/:id/undo_canceledgame/:id/undo_requestedgamelist-countgamelist-count-:channelhostinfoincident-reportitclatencynet/pongnotificationprivate-messageprivate-superchatreconnectremote_storage/sync_completeremote_storage/updatereview/:id/full_statereview/:id/rscore-estimator-enabled-stateseekgraph/globaltimeoutui-pushunrecoverable_erroruser/jwtuser/stateuser/update
    \ No newline at end of file diff --git a/docs/interfaces/GobanThemeBackgroundCSS.html b/docs/interfaces/GobanThemeBackgroundCSS.html index 7ed3fc45..ef871f06 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? background-image? background-size? -

    Properties

    Optional background-color

    background-color?: string

    Optional background-image

    background-image?: string

    Optional background-size

    background-size?: string

    Settings

    Member Visibility

    Theme

    On This Page

    background-colorbackground-imagebackground-size
    \ No newline at end of file +

    Properties

    Optional background-color

    background-color?: string

    Optional background-image

    background-image?: string

    Optional background-size

    background-size?: string

    Settings

    Member Visibility

    Theme

    On This Page

    background-colorbackground-imagebackground-size
    \ No newline at end of file diff --git a/docs/interfaces/GobanThemeBackgroundReactStyles.html b/docs/interfaces/GobanThemeBackgroundReactStyles.html index 8d0d0b0f..3aa09ae7 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? backgroundImage? backgroundSize? -

    Properties

    Optional backgroundColor

    backgroundColor?: string

    Optional backgroundImage

    backgroundImage?: string

    Optional backgroundSize

    backgroundSize?: string

    Settings

    Member Visibility

    Theme

    On This Page

    backgroundColorbackgroundImagebackgroundSize
    \ No newline at end of file +

    Properties

    Optional backgroundColor

    backgroundColor?: string

    Optional backgroundImage

    backgroundImage?: string

    Optional backgroundSize

    backgroundSize?: string

    Settings

    Member Visibility

    Theme

    On This Page

    backgroundColorbackgroundImagebackgroundSize
    \ No newline at end of file diff --git a/docs/interfaces/JGOF.html b/docs/interfaces/JGOF.html index bdc0dd9a..1d9a962c 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

    ai_reviews? +
    interface JGOF {
        ai_reviews?: {
            [id: string]: JGOFAIReview;
        };
        black?: JGOFPlayer | JGOFPlayer[];
        clock?: JGOFClock;
        jgof: 1;
        time_control?: JGOFTimeControl;
        white?: JGOFPlayer | JGOFPlayer[];
    }

    Properties

    ai_reviews? black? clock? jgof time_control? white?

    Properties

    Optional ai_reviews

    ai_reviews?: {
        [id: string]: JGOFAIReview;
    }

    AI Review information computed for this game

    -

    Type declaration

    Optional black

    black?: JGOFPlayer | JGOFPlayer[]

    Player information for those playing Black

    -

    Optional clock

    clock?: JGOFClock

    Current clock information, this is used for ongoing games

    -

    jgof

    jgof: 1

    JGOF version number

    -

    Optional time_control

    time_control?: JGOFTimeControl

    Time control settings for the game

    -

    Optional white

    white?: JGOFPlayer | JGOFPlayer[]

    Player information for those playing White

    -

    Settings

    Member Visibility

    Theme

    On This Page

    ai_reviewsblackclockjgoftime_controlwhite
    \ No newline at end of file +

    Type declaration

    Optional black

    black?: JGOFPlayer | JGOFPlayer[]

    Player information for those playing Black

    +

    Optional clock

    clock?: JGOFClock

    Current clock information, this is used for ongoing games

    +

    jgof

    jgof: 1

    JGOF version number

    +

    Optional time_control

    time_control?: JGOFTimeControl

    Time control settings for the game

    +

    Optional white

    white?: JGOFPlayer | JGOFPlayer[]

    Player information for those playing White

    +

    Settings

    Member Visibility

    Theme

    On This Page

    ai_reviewsblackclockjgoftime_controlwhite
    \ No newline at end of file diff --git a/docs/interfaces/JGOFAIReview.html b/docs/interfaces/JGOFAIReview.html index a8d1a28a..fb07b79b 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

    analyzed_variations? +
    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? date engine engine_version @@ -15,15 +15,15 @@ win_rate win_rates?

    Properties

    Optional analyzed_variations

    analyzed_variations?: {
        [var_key: string]: JGOFAIReviewMove;
    }

    Analysis of variations in the game.

    -

    Type declaration

    date

    date: number

    millisecond epoch time (ms from 1970 UTC)

    -

    engine

    engine: string

    engine_version

    engine_version: string

    Optional error

    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

    id: string

    moves

    moves: {
        [move_number: string]: JGOFAIReviewMove;
    }

    Analysis of moves in the game.

    -

    Type declaration

    network

    network: string

    network_size

    network_size: string

    Optional scores

    scores?: number[]

    predicted scores that black will win or lose by (negative for loss) for all moves

    -

    strength

    strength: number

    type

    type: "fast" | "full"

    A fast review typically only has a few moves reviewed, whereas a full +

    Type declaration

    date

    date: number

    millisecond epoch time (ms from 1970 UTC)

    +

    engine

    engine: string

    engine_version

    engine_version: string

    Optional error

    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

    id: string

    moves

    moves: {
        [move_number: string]: JGOFAIReviewMove;
    }

    Analysis of moves in the game.

    +

    Type declaration

    network

    network: string

    network_size

    network_size: string

    Optional scores

    scores?: number[]

    predicted scores that black will win or lose by (negative for loss) for all moves

    +

    strength

    strength: number

    type

    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

    uuid: string

    win_rate

    win_rate: number

    predicted probability that black will win the last move

    -

    Optional win_rates

    win_rates?: number[]

    predicted probability that black will win for all moves

    -

    Settings

    Member Visibility

    Theme

    On This Page

    analyzed_variationsdateengineengine_versionerroridmovesnetworknetwork_sizescoresstrengthtypeuuidwin_ratewin_rates
    \ No newline at end of file +

    uuid

    uuid: string

    win_rate

    win_rate: number

    predicted probability that black will win the last move

    +

    Optional win_rates

    win_rates?: number[]

    predicted probability that black will win for all moves

    +

    Settings

    Member Visibility

    Theme

    On This Page

    analyzed_variationsdateengineengine_versionerroridmovesnetworknetwork_sizescoresstrengthtypeuuidwin_ratewin_rates
    \ No newline at end of file diff --git a/docs/interfaces/JGOFAIReviewMove.html b/docs/interfaces/JGOFAIReviewMove.html index cd0d00ae..6fed31ab 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

    branches move move_number ownership? score? win_rate

    Properties

    branches

    branches: JGOFAIReviewMoveVariation[]

    Followup move branches explored

    -

    move

    move: JGOFIntersection

    The move that was played.

    -

    move_number

    move_number: number

    The move number. This is 1 indexed.

    -

    Optional ownership

    ownership?: number[][]

    A width*height array of ownership values

    -

    Optional score

    score?: number

    How many points black is predicted to win by (if positive, lose by if negative)

    -

    win_rate

    win_rate: number

    Probability of black winning after this move was made

    -

    Settings

    Member Visibility

    Theme

    On This Page

    branchesmovemove_numberownershipscorewin_rate
    \ No newline at end of file +

    move

    move: JGOFIntersection

    The move that was played.

    +

    move_number

    move_number: number

    The move number. This is 1 indexed.

    +

    Optional ownership

    ownership?: number[][]

    A width*height array of ownership values

    +

    Optional score

    score?: number

    How many points black is predicted to win by (if positive, lose by if negative)

    +

    win_rate

    win_rate: number

    Probability of black winning after this move was made

    +

    Settings

    Member Visibility

    Theme

    On This Page

    branchesmovemove_numberownershipscorewin_rate
    \ No newline at end of file diff --git a/docs/interfaces/JGOFAIReviewMoveVariation.html b/docs/interfaces/JGOFAIReviewMoveVariation.html index 8271f544..9aa94f0b 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

    Optional lcb

    lcb?: number

    lower confidence bound, both KataGo and LeelaZero provide this

    -

    moves

    moves: JGOFIntersection[]

    Followup predicted moves by the AI

    -

    Optional policy

    policy?: number

    From Leela Zero

    -

    Optional score

    score?: number

    How many points black is predicted to win for this variation (or lose by if negative)

    -

    Optional score_mean

    score_mean?: number

    From KataGo

    -

    Optional score_stdev

    score_stdev?: number

    From KataGo

    -

    Optional utility

    utility?: number

    From KataGo

    -

    Optional utility_lcb

    utility_lcb?: number

    From KataGo

    -

    visits

    visits: number

    Number of times the AI considered the first move of this variation

    -

    win_rate

    win_rate: number

    Probability of black wining to report for this variation

    -

    Settings

    Member Visibility

    Theme

    On This Page

    lcbmovespolicyscorescore_meanscore_stdevutilityutility_lcbvisitswin_rate
    \ No newline at end of file +

    moves

    moves: JGOFIntersection[]

    Followup predicted moves by the AI

    +

    Optional policy

    policy?: number

    From Leela Zero

    +

    Optional score

    score?: number

    How many points black is predicted to win for this variation (or lose by if negative)

    +

    Optional score_mean

    score_mean?: number

    From KataGo

    +

    Optional score_stdev

    score_stdev?: number

    From KataGo

    +

    Optional utility

    utility?: number

    From KataGo

    +

    Optional utility_lcb

    utility_lcb?: number

    From KataGo

    +

    visits

    visits: number

    Number of times the AI considered the first move of this variation

    +

    win_rate

    win_rate: number

    Probability of black wining to report for this variation

    +

    Settings

    Member Visibility

    Theme

    On This Page

    lcbmovespolicyscorescore_meanscore_stdevutilityutility_lcbvisitswin_rate
    \ No newline at end of file diff --git a/docs/interfaces/JGOFAbsoluteTimeControl.html b/docs/interfaces/JGOFAbsoluteTimeControl.html index 419fbbf7..53d6fcb3 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 speed system total_time -

    Properties

    pause_on_weekends

    pause_on_weekends: boolean

    speed

    speed: JGOFTimeControlSpeed

    system

    system: "absolute"

    total_time

    total_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    pause_on_weekendsspeedsystemtotal_time
    \ No newline at end of file +

    Properties

    pause_on_weekends

    pause_on_weekends: boolean

    speed

    speed: JGOFTimeControlSpeed

    system

    system: "absolute"

    total_time

    total_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    pause_on_weekendsspeedsystemtotal_time
    \ No newline at end of file diff --git a/docs/interfaces/JGOFByoYomiTimeControl.html b/docs/interfaces/JGOFByoYomiTimeControl.html index f12abdd9..4ec0b144 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 pause_on_weekends period_time periods speed system -

    Properties

    main_time

    main_time: number

    pause_on_weekends

    pause_on_weekends: boolean

    period_time

    period_time: number

    periods

    periods: number

    speed

    speed: JGOFTimeControlSpeed

    system

    system: "byoyomi"

    Settings

    Member Visibility

    Theme

    On This Page

    main_timepause_on_weekendsperiod_timeperiodsspeedsystem
    \ No newline at end of file +

    Properties

    main_time

    main_time: number

    pause_on_weekends

    pause_on_weekends: boolean

    period_time

    period_time: number

    periods

    periods: number

    speed

    speed: JGOFTimeControlSpeed

    system

    system: "byoyomi"

    Settings

    Member Visibility

    Theme

    On This Page

    main_timepause_on_weekendsperiod_timeperiodsspeedsystem
    \ No newline at end of file diff --git a/docs/interfaces/JGOFCanadianTimeControl.html b/docs/interfaces/JGOFCanadianTimeControl.html index 008d8ed6..fbd9f12c 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 pause_on_weekends period_time speed stones_per_period system -

    Properties

    main_time

    main_time: number

    pause_on_weekends

    pause_on_weekends: boolean

    period_time

    period_time: number

    speed

    speed: JGOFTimeControlSpeed

    stones_per_period

    stones_per_period: number

    system

    system: "canadian"

    Settings

    Member Visibility

    Theme

    On This Page

    main_timepause_on_weekendsperiod_timespeedstones_per_periodsystem
    \ No newline at end of file +

    Properties

    main_time

    main_time: number

    pause_on_weekends

    pause_on_weekends: boolean

    period_time

    period_time: number

    speed

    speed: JGOFTimeControlSpeed

    stones_per_period

    stones_per_period: number

    system

    system: "canadian"

    Settings

    Member Visibility

    Theme

    On This Page

    main_timepause_on_weekendsperiod_timespeedstones_per_periodsystem
    \ No newline at end of file diff --git a/docs/interfaces/JGOFClock.html b/docs/interfaces/JGOFClock.html index db265d04..4198ab54 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

    black_clock +
    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 current_player current_player_id pause_state? @@ -10,17 +10,17 @@ time_of_last_move white_clock

    Properties

    black_clock

    black_clock: JGOFPlayerClock

    Time left on blacks clock.

    -

    current_player

    current_player: "black" | "white"

    Player to move, and thus player whose clock is running.

    -

    current_player_id

    current_player_id: string

    Player ID of player to move

    -

    Optional pause_state

    pause_state?: JGOFPauseState

    If this field is set, the game clocks are paused for one or more reasons.

    -

    Optional paused_since

    paused_since?: number

    Time the game was paused, in milliseconds since 1970, as observed by the server

    -

    Optional start_mode

    start_mode?: boolean

    True if the game has not begun yet and we are waiting for the first +

    current_player

    current_player: "black" | "white"

    Player to move, and thus player whose clock is running.

    +

    current_player_id

    current_player_id: string

    Player ID of player to move

    +

    Optional pause_state

    pause_state?: JGOFPauseState

    If this field is set, the game clocks are paused for one or more reasons.

    +

    Optional paused_since

    paused_since?: number

    Time the game was paused, in milliseconds since 1970, as observed by the server

    +

    Optional start_mode

    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.

    -

    Optional start_time_left

    start_time_left?: number

    If start_mode is true, this is the number of milliseconds left +

    Optional start_time_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.

    -

    Optional stone_removal_time_left

    stone_removal_time_left?: number

    If pause_State.stone_removal is true, this is the number of +

    Optional stone_removal_time_left

    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

    time_of_last_move: number

    Time the last move was made, in milliseconds since 1970, as observed by the server.

    -

    white_clock

    white_clock: JGOFPlayerClock

    Time left on whites clock.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    black_clockcurrent_playercurrent_player_idpause_statepaused_sincestart_modestart_time_leftstone_removal_time_lefttime_of_last_movewhite_clock
    \ No newline at end of file +

    time_of_last_move

    time_of_last_move: number

    Time the last move was made, in milliseconds since 1970, as observed by the server.

    +

    white_clock

    white_clock: JGOFPlayerClock

    Time left on whites clock.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    black_clockcurrent_playercurrent_player_idpause_statepaused_sincestart_modestart_time_leftstone_removal_time_lefttime_of_last_movewhite_clock
    \ No newline at end of file diff --git a/docs/interfaces/JGOFClockWithTransmitting.html b/docs/interfaces/JGOFClockWithTransmitting.html index b9fdca27..a363ce40 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

    black_clock +
    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 black_move_transmitting current_player current_player_id @@ -12,17 +12,17 @@ white_clock white_move_transmitting

    Properties

    black_clock

    black_clock: JGOFPlayerClock

    Time left on blacks clock.

    -

    black_move_transmitting

    black_move_transmitting: number

    current_player

    current_player: "black" | "white"

    Player to move, and thus player whose clock is running.

    -

    current_player_id

    current_player_id: string

    Player ID of player to move

    -

    Optional pause_state

    pause_state?: JGOFPauseState

    If this field is set, the game clocks are paused for one or more reasons.

    -

    Optional paused_since

    paused_since?: number

    Time the game was paused, in milliseconds since 1970, as observed by the server

    -

    Optional start_mode

    start_mode?: boolean

    True if the game has not begun yet and we are waiting for the first +

    black_move_transmitting

    black_move_transmitting: number

    current_player

    current_player: "black" | "white"

    Player to move, and thus player whose clock is running.

    +

    current_player_id

    current_player_id: string

    Player ID of player to move

    +

    Optional pause_state

    pause_state?: JGOFPauseState

    If this field is set, the game clocks are paused for one or more reasons.

    +

    Optional paused_since

    paused_since?: number

    Time the game was paused, in milliseconds since 1970, as observed by the server

    +

    Optional start_mode

    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.

    -

    Optional start_time_left

    start_time_left?: number

    If start_mode is true, this is the number of milliseconds left +

    Optional start_time_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.

    -

    Optional stone_removal_time_left

    stone_removal_time_left?: number

    If pause_State.stone_removal is true, this is the number of +

    Optional stone_removal_time_left

    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

    time_of_last_move: number

    Time the last move was made, in milliseconds since 1970, as observed by the server.

    -

    white_clock

    white_clock: JGOFPlayerClock

    Time left on whites clock.

    -

    white_move_transmitting

    white_move_transmitting: number

    Settings

    Member Visibility

    Theme

    On This Page

    black_clockblack_move_transmittingcurrent_playercurrent_player_idpause_statepaused_sincestart_modestart_time_leftstone_removal_time_lefttime_of_last_movewhite_clockwhite_move_transmitting
    \ No newline at end of file +

    time_of_last_move

    time_of_last_move: number

    Time the last move was made, in milliseconds since 1970, as observed by the server.

    +

    white_clock

    white_clock: JGOFPlayerClock

    Time left on whites clock.

    +

    white_move_transmitting

    white_move_transmitting: number

    Settings

    Member Visibility

    Theme

    On This Page

    black_clockblack_move_transmittingcurrent_playercurrent_player_idpause_statepaused_sincestart_modestart_time_leftstone_removal_time_lefttime_of_last_movewhite_clockwhite_move_transmitting
    \ No newline at end of file diff --git a/docs/interfaces/JGOFFischerTimeControl.html b/docs/interfaces/JGOFFischerTimeControl.html index 3f5c2a5f..5804bd22 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 max_time pause_on_weekends speed system time_increment -

    Properties

    initial_time

    initial_time: number

    max_time

    max_time: number

    pause_on_weekends

    pause_on_weekends: boolean

    speed

    speed: JGOFTimeControlSpeed

    system

    system: "fischer"

    time_increment

    time_increment: number

    Settings

    Member Visibility

    Theme

    On This Page

    initial_timemax_timepause_on_weekendsspeedsystemtime_increment
    \ No newline at end of file +

    Properties

    initial_time

    initial_time: number

    max_time

    max_time: number

    pause_on_weekends

    pause_on_weekends: boolean

    speed

    speed: JGOFTimeControlSpeed

    system

    system: "fischer"

    time_increment

    time_increment: number

    Settings

    Member Visibility

    Theme

    On This Page

    initial_timemax_timepause_on_weekendsspeedsystemtime_increment
    \ No newline at end of file diff --git a/docs/interfaces/JGOFIntersection.html b/docs/interfaces/JGOFIntersection.html index bb857cf2..c40abb4f 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

    x: number

    Horizontal coordinate, counting left to right, starting with zero

    -

    y

    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    -

    Settings

    Member Visibility

    Theme

    On This Page

    xy
    \ No newline at end of file +

    y

    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    +

    Settings

    Member Visibility

    Theme

    On This Page

    xy
    \ No newline at end of file diff --git a/docs/interfaces/JGOFMove.html b/docs/interfaces/JGOFMove.html index 400c69e8..ab37a6a4 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

    blur? color? edited? played_by? @@ -8,7 +8,7 @@ timedelta? x y -

    Properties

    Optional blur

    blur?: number

    Optional color

    color?: JGOFNumericPlayerColor

    Optional edited

    edited?: boolean

    Optional played_by

    played_by?: number

    Optional player_update

    player_update?: JGOFPlayerSummary

    Optional removal_reason

    removal_reason?: string

    Stone removal reasoning, primarily for debugging

    -

    Optional sgf_downloaded_by

    sgf_downloaded_by?: number[]

    Optional timedelta

    timedelta?: number

    x

    x: number

    Horizontal coordinate, counting left to right, starting with zero

    -

    y

    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    -

    Settings

    Member Visibility

    Theme

    On This Page

    blurcoloreditedplayed_byplayer_updateremoval_reasonsgf_downloaded_bytimedeltaxy
    \ No newline at end of file +

    Properties

    Optional blur

    blur?: number

    Optional color

    color?: JGOFNumericPlayerColor

    Optional edited

    edited?: boolean

    Optional played_by

    played_by?: number

    Optional player_update

    player_update?: JGOFPlayerSummary

    Optional removal_reason

    removal_reason?: string

    Stone removal reasoning, primarily for debugging

    +

    Optional sgf_downloaded_by

    sgf_downloaded_by?: number[]

    Optional timedelta

    timedelta?: number

    x

    x: number

    Horizontal coordinate, counting left to right, starting with zero

    +

    y

    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    +

    Settings

    Member Visibility

    Theme

    On This Page

    blurcoloreditedplayed_byplayer_updateremoval_reasonsgf_downloaded_bytimedeltaxy
    \ No newline at end of file diff --git a/docs/interfaces/JGOFNoneTimeControl.html b/docs/interfaces/JGOFNoneTimeControl.html index 3ab6c3d1..60b34b91 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 speed system -

    Properties

    pause_on_weekends

    pause_on_weekends: boolean

    speed

    speed: "correspondence"

    system

    system: "none"

    Settings

    Member Visibility

    Theme

    On This Page

    pause_on_weekendsspeedsystem
    \ No newline at end of file +

    Properties

    pause_on_weekends

    pause_on_weekends: boolean

    speed

    speed: "correspondence"

    system

    system: "none"

    Settings

    Member Visibility

    Theme

    On This Page

    pause_on_weekendsspeedsystem
    \ No newline at end of file diff --git a/docs/interfaces/JGOFPauseState.html b/docs/interfaces/JGOFPauseState.html index 7935218d..3385a950 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? player? server? stone_removal? vacation? weekend?

    Properties

    Optional moderator

    moderator?: string

    Paused by a moderator, value of this field is the moderator's id

    -

    Optional player

    player?: {
        pauses_left: number;
        player_id: string;
    }

    Paused by a player. The game can only be paused by one player at a time.

    +

    Optional player

    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.

      -

    Optional server

    server?: true

    Paused by the server

    -

    Optional stone_removal

    stone_removal?: true

    Paused because the game is in the stone removal phase

    -

    Optional vacation

    vacation?: {
        [player_id: string]: true;
    }

    Paused because one or more players is on vacation

    +

    Optional server

    server?: true

    Paused by the server

    +

    Optional stone_removal

    stone_removal?: true

    Paused because the game is in the stone removal phase

    +

    Optional vacation

    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

      -

    Optional weekend

    weekend?: true

    Paused because it is the weekend

    -

    Settings

    Member Visibility

    Theme

    On This Page

    moderatorplayerserverstone_removalvacationweekend
    \ No newline at end of file +

    Optional weekend

    weekend?: true

    Paused because it is the weekend

    +

    Settings

    Member Visibility

    Theme

    On This Page

    moderatorplayerserverstone_removalvacationweekend
    \ No newline at end of file diff --git a/docs/interfaces/JGOFPlayer.html b/docs/interfaces/JGOFPlayer.html index 29b0068c..9e68967b 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

    id? name

    Properties

    Optional id

    id?: string

    Identifier for the player

    -

    name

    name: string

    Name or username of the player

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idname
    \ No newline at end of file +

    name

    name: string

    Name or username of the player

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idname
    \ No newline at end of file diff --git a/docs/interfaces/JGOFPlayerClock.html b/docs/interfaces/JGOFPlayerClock.html index ac99399c..6fd860a5 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? main_time moves_left? period_time_left? periods_left?

    Properties

    Optional block_time_left

    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

    main_time: number

    Main time left on the clock, in milliseconds.

    -

    Optional moves_left

    moves_left?: number

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

    main_time

    main_time: number

    Main time left on the clock, in milliseconds.

    +

    Optional moves_left

    moves_left?: number

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

    -

    Optional period_time_left

    period_time_left?: number

    Used with byo-yomi time control. Time left on the period time, in milliseconds.

    -

    Optional periods_left

    periods_left?: number

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    block_time_leftmain_timemoves_leftperiod_time_leftperiods_left
    \ No newline at end of file +

    Optional period_time_left

    period_time_left?: number

    Used with byo-yomi time control. Time left on the period time, in milliseconds.

    +

    Optional periods_left

    periods_left?: number

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    block_time_leftmain_timemoves_leftperiod_time_leftperiods_left
    \ No newline at end of file diff --git a/docs/interfaces/JGOFPlayerSummary.html b/docs/interfaces/JGOFPlayerSummary.html index c7d47d9b..81b5837c 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? players rengo_teams -

    Properties

    Optional dropped_players

    dropped_players?: {
        black?: number[];
        white?: number[];
    }

    Type declaration

    • Optional black?: number[]
    • Optional white?: number[]

    players

    players: {
        black: number;
        white: number;
    }

    Type declaration

    • black: number
    • white: number

    rengo_teams

    rengo_teams: {
        black: number[];
        white: number[];
    }

    Type declaration

    • black: number[]
    • white: number[]

    Settings

    Member Visibility

    Theme

    On This Page

    dropped_playersplayersrengo_teams
    \ No newline at end of file +

    Properties

    Optional dropped_players

    dropped_players?: {
        black?: number[];
        white?: number[];
    }

    Type declaration

    • Optional black?: number[]
    • Optional white?: number[]

    players

    players: {
        black: number;
        white: number;
    }

    Type declaration

    • black: number
    • white: number

    rengo_teams

    rengo_teams: {
        black: number[];
        white: number[];
    }

    Type declaration

    • black: number[]
    • white: number[]

    Settings

    Member Visibility

    Theme

    On This Page

    dropped_playersplayersrengo_teams
    \ No newline at end of file diff --git a/docs/interfaces/JGOFSealingIntersection.html b/docs/interfaces/JGOFSealingIntersection.html index 60b8dc03..24824482 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

    color x y

    Properties

    color

    color: JGOFNumericPlayerColor

    Color the intersection is probably presumed to be by the players, but is in fact empty.

    -

    x

    x: number

    Horizontal coordinate, counting left to right, starting with zero

    -

    y

    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colorxy
    \ No newline at end of file +

    x

    x: number

    Horizontal coordinate, counting left to right, starting with zero

    +

    y

    y: number

    Vertical coordinate, counting top to bottom, starting with zero

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colorxy
    \ No newline at end of file diff --git a/docs/interfaces/JGOFSimpleTimeControl.html b/docs/interfaces/JGOFSimpleTimeControl.html index ab2de345..68ca92de 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 per_move speed system -

    Properties

    pause_on_weekends

    pause_on_weekends: boolean

    per_move

    per_move: number

    speed

    speed: JGOFTimeControlSpeed

    system

    system: "simple"

    Settings

    Member Visibility

    Theme

    On This Page

    pause_on_weekendsper_movespeedsystem
    \ No newline at end of file +

    Properties

    pause_on_weekends

    pause_on_weekends: boolean

    per_move

    per_move: number

    speed

    speed: JGOFTimeControlSpeed

    system

    system: "simple"

    Settings

    Member Visibility

    Theme

    On This Page

    pause_on_weekendsper_movespeedsystem
    \ No newline at end of file diff --git a/docs/interfaces/MarkInterface.html b/docs/interfaces/MarkInterface.html index ea31f9c9..ba9a6d93 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? blue_move? chat_triangle? circle? @@ -17,4 +17,4 @@ transient_letter? triangle? white? -

    Properties

    Optional black

    black?: boolean

    Optional blue_move

    blue_move?: boolean

    Optional chat_triangle

    chat_triangle?: boolean

    Optional circle

    circle?: boolean

    Optional color

    color?: string

    Optional cross

    cross?: boolean

    Optional hint

    hint?: boolean

    Optional letter

    letter?: string

    Optional mark_x

    mark_x?: boolean

    Optional needs_sealing

    needs_sealing?: boolean

    Optional remove

    remove?: boolean

    Optional score

    score?: string

    Optional square

    square?: boolean

    Optional stone_removed

    stone_removed?: boolean

    Optional sub_triangle

    sub_triangle?: boolean

    Optional subscript

    subscript?: string

    Optional transient_letter

    transient_letter?: string

    Optional triangle

    triangle?: boolean

    Optional white

    white?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    blackblue_movechat_trianglecirclecolorcrosshintlettermark_xneeds_sealingremovescoresquarestone_removedsub_trianglesubscripttransient_lettertrianglewhite
    \ No newline at end of file +

    Properties

    Optional black

    black?: boolean

    Optional blue_move

    blue_move?: boolean

    Optional chat_triangle

    chat_triangle?: boolean

    Optional circle

    circle?: boolean

    Optional color

    color?: string

    Optional cross

    cross?: boolean

    Optional hint

    hint?: boolean

    Optional letter

    letter?: string

    Optional mark_x

    mark_x?: boolean

    Optional needs_sealing

    needs_sealing?: boolean

    Optional remove

    remove?: boolean

    Optional score

    score?: string

    Optional square

    square?: boolean

    Optional stone_removed

    stone_removed?: boolean

    Optional sub_triangle

    sub_triangle?: boolean

    Optional subscript

    subscript?: string

    Optional transient_letter

    transient_letter?: string

    Optional triangle

    triangle?: boolean

    Optional white

    white?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    blackblue_movechat_trianglecirclecolorcrosshintlettermark_xneeds_sealingremovescoresquarestone_removedsub_trianglesubscripttransient_lettertrianglewhite
    \ No newline at end of file diff --git a/docs/interfaces/MoveCommand.html b/docs/interfaces/MoveCommand.html index 048922c5..a5db5d0a 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

    blur? clock? game_id move -

    Properties

    Optional blur

    blur?: number

    Optional clock

    clock?: JGOFPlayerClock

    game_id

    game_id: number

    move

    move: string

    Settings

    Member Visibility

    Theme

    On This Page

    blurclockgame_idmove
    \ No newline at end of file +

    Properties

    Optional blur

    blur?: number

    Optional clock

    clock?: JGOFPlayerClock

    game_id

    game_id: number

    move

    move: string

    Settings

    Member Visibility

    Theme

    On This Page

    blurclockgame_idmove
    \ No newline at end of file diff --git a/docs/interfaces/MoveTreeChatLine.html b/docs/interfaces/MoveTreeChatLine.html index d56935e8..9130e5c7 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

    body username -

    Properties

    body

    body: MoveTreeChatLineBody

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    bodyusername
    \ No newline at end of file +

    Properties

    body

    body: MoveTreeChatLineBody

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    bodyusername
    \ No newline at end of file diff --git a/docs/interfaces/MoveTreeChatLineBody.html b/docs/interfaces/MoveTreeChatLineBody.html index 2ae2f97a..a2052b81 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

    from moves name type -

    Properties

    from

    from: number

    moves

    moves: string | AdHocPackedMove

    name

    name: string

    type

    type: "analysis"

    Settings

    Member Visibility

    Theme

    On This Page

    frommovesnametype
    \ No newline at end of file +

    Properties

    from

    from: number

    moves

    moves: string | AdHocPackedMove

    name

    name: string

    type

    type: "analysis"

    Settings

    Member Visibility

    Theme

    On This Page

    frommovesnametype
    \ No newline at end of file diff --git a/docs/interfaces/MoveTreeJson.html b/docs/interfaces/MoveTreeJson.html index b0e0908a..5f6cf781 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? correct_answer? marks? pen_marks? @@ -7,4 +7,4 @@ wrong_answer? x y -

    Properties

    Optional branches

    branches?: MoveTreeJson[]

    Optional correct_answer

    correct_answer?: boolean

    Optional marks

    marks?: {
        marks: MarkInterface;
        x: number;
        y: number;
    }[]

    Type declaration

    Optional pen_marks

    pen_marks?: MoveTreePenMarks

    Optional text

    text?: string

    Optional trunk_next

    trunk_next?: MoveTreeJson

    Optional wrong_answer

    wrong_answer?: boolean

    x

    x: number

    y

    y: number

    Settings

    Member Visibility

    Theme

    On This Page

    branchescorrect_answermarkspen_markstexttrunk_nextwrong_answerxy
    \ No newline at end of file +

    Properties

    Optional branches

    branches?: MoveTreeJson[]

    Optional correct_answer

    correct_answer?: boolean

    Optional marks

    marks?: {
        marks: MarkInterface;
        x: number;
        y: number;
    }[]

    Type declaration

    Optional pen_marks

    pen_marks?: MoveTreePenMarks

    Optional text

    text?: string

    Optional trunk_next

    trunk_next?: MoveTreeJson

    Optional wrong_answer

    wrong_answer?: boolean

    x

    x: number

    y

    y: number

    Settings

    Member Visibility

    Theme

    On This Page

    branchescorrect_answermarkspen_markstexttrunk_nextwrong_answerxy
    \ No newline at end of file diff --git a/docs/interfaces/PlayerScore.html b/docs/interfaces/PlayerScore.html index 09672642..c7b2d6f1 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 komi prisoners scoring_positions stones territory total -

    Properties

    handicap

    handicap: number

    komi

    komi: number

    prisoners

    prisoners: number

    scoring_positions

    scoring_positions: string

    stones

    stones: number

    territory

    territory: number

    total

    total: number

    Settings

    Member Visibility

    Theme

    On This Page

    handicapkomiprisonersscoring_positionsstonesterritorytotal
    \ No newline at end of file +

    Properties

    handicap

    handicap: number

    komi

    komi: number

    prisoners

    prisoners: number

    scoring_positions

    scoring_positions: string

    stones

    stones: number

    territory

    territory: number

    total

    total: number

    Settings

    Member Visibility

    Theme

    On This Page

    handicapkomiprisonersscoring_positionsstonesterritorytotal
    \ No newline at end of file diff --git a/docs/interfaces/PuzzleConfig.html b/docs/interfaces/PuzzleConfig.html index ed1a4dd4..6b34522e 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? board? board_is_repeating? height? @@ -20,4 +20,4 @@ removal? white_prisoners? width? -

    Properties

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional isobranch_hash

    isobranch_hash?: string

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional mode

    mode?: string

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional name

    name?: string

    Optional player

    player?: JGOFNumericPlayerColor

    Optional puzzle_autoplace_delay

    puzzle_autoplace_delay?: number

    Optional puzzle_collection

    puzzle_collection?: number

    Optional puzzle_description

    puzzle_description?: string

    Optional puzzle_opponent_move_mode

    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

    Optional puzzle_player_move_mode

    puzzle_player_move_mode?: PuzzlePlayerMoveMode

    Optional puzzle_rank

    puzzle_rank?: number

    Optional puzzle_type

    puzzle_type?: string

    Optional removal

    removal?: boolean[][]

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Settings

    Member Visibility

    Theme

    On This Page

    black_prisonersboardboard_is_repeatingheightinitial_playerinitial_stateisobranch_hashmarksmodemove_treenameplayerpuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typeremovalwhite_prisonerswidth
    \ No newline at end of file +

    Properties

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional isobranch_hash

    isobranch_hash?: string

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional mode

    mode?: string

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional name

    name?: string

    Optional player

    player?: JGOFNumericPlayerColor

    Optional puzzle_autoplace_delay

    puzzle_autoplace_delay?: number

    Optional puzzle_collection

    puzzle_collection?: number

    Optional puzzle_description

    puzzle_description?: string

    Optional puzzle_opponent_move_mode

    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

    Optional puzzle_player_move_mode

    puzzle_player_move_mode?: PuzzlePlayerMoveMode

    Optional puzzle_rank

    puzzle_rank?: number

    Optional puzzle_type

    puzzle_type?: string

    Optional removal

    removal?: boolean[][]

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Settings

    Member Visibility

    Theme

    On This Page

    black_prisonersboardboard_is_repeatingheightinitial_playerinitial_stateisobranch_hashmarksmodemove_treenameplayerpuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typeremovalwhite_prisonerswidth
    \ No newline at end of file diff --git a/docs/interfaces/ReviewMessage.html b/docs/interfaces/ReviewMessage.html index 6d3287ab..e4290d2e 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

    chat? +
    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

    Optional chat

    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

    Optional clearpen

    clearpen?: boolean

    Clears the pen drawings on the node

    -

    Optional controller

    controller?: number | {
        id: number;
        username: string;
    }

    Sets the controller of the review

    -

    Type declaration

    • id: number
    • username: string

    Optional delete

    delete?: number

    Delete

    -

    Optional f

    f?: number

    from (move number)

    -

    Optional gamedata

    gamedata?: GobanEngineConfig

    Initial gamedata to review

    -

    Optional k

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

    Marks made

    -

    Type declaration

    • [mark: string]: string

    Optional m

    m?: string

    Moves made

    -

    Optional om

    om?: [number, number, number]

    official move [reviewing live game]

    -

    Optional owner

    owner?: number | {
        id: number;
        username: string;
    }

    Sets the owner of the review

    -

    Type declaration

    • id: number
    • username: string

    Optional pen

    pen?: string

    pen color / pen start

    -

    Optional player_update

    player_update?: JGOFPlayerSummary

    Updated information about the players, such as name etc.

    -

    Optional pp

    pp?: [number, number]

    pen point

    -

    Optional remove-chat

    remove-chat?: string

    Remove's the given chat by id

    -

    Optional review_id

    review_id?: number

    The review ID. This is used when sending from the client to the server, +

  • player_id: number

    • Optional clearpen

    clearpen?: boolean

    Clears the pen drawings on the node

    +

    Optional controller

    controller?: number | {
        id: number;
        username: string;
    }

    Sets the controller of the review

    +

    Type declaration

    • id: number
    • username: string

    Optional delete

    delete?: number

    Delete

    +

    Optional f

    f?: number

    from (move number)

    +

    Optional gamedata

    gamedata?: GobanEngineConfig

    Initial gamedata to review

    +

    Optional k

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

    Marks made

    +

    Type declaration

    • [mark: string]: string

    Optional m

    m?: string

    Moves made

    +

    Optional om

    om?: [number, number, number]

    official move [reviewing live game]

    +

    Optional owner

    owner?: number | {
        id: number;
        username: string;
    }

    Sets the owner of the review

    +

    Type declaration

    • id: number
    • username: string

    Optional pen

    pen?: string

    pen color / pen start

    +

    Optional player_update

    player_update?: JGOFPlayerSummary

    Updated information about the players, such as name etc.

    +

    Optional pp

    pp?: [number, number]

    pen point

    +

    Optional remove-chat

    remove-chat?: string

    Remove's the given chat by id

    +

    Optional review_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)

    -

    Optional t

    t?: string

    text note for the current node

    -

    Optional t+

    t+?: string

    text append to the current node

    -

    Optional ts

    ts?: number

    timestamp (ms)

    -

    Optional undo

    undo?: boolean

    official undo [reviewing live game]

    -

    Settings

    Member Visibility

    Theme

    On This Page

    chatclearpencontrollerdeletefgamedatakmomownerpenplayer_updateppremove-chatreview_idtt+tsundo
    \ No newline at end of file +

    Optional t

    t?: string

    text note for the current node

    +

    Optional t+

    t+?: string

    text append to the current node

    +

    Optional ts

    ts?: number

    timestamp (ms)

    +

    Optional undo

    undo?: boolean

    official undo [reviewing live game]

    +

    Settings

    Member Visibility

    Theme

    On This Page

    chatclearpencontrollerdeletefgamedatakmomownerpenplayer_updateppremove-chatreview_idtt+tsundo
    \ No newline at end of file diff --git a/docs/interfaces/SVGRendererGobanConfig.html b/docs/interfaces/SVGRendererGobanConfig.html index 65b1092c..901e6139 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);
        is_game_record?: 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);
        is_game_record?: 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? allow_ko? allow_self_capture? allow_superko? @@ -117,13 +117,13 @@ white_prisoners? width? winner? -

    Properties

    Optional aga_handicap_scoring

    aga_handicap_scoring?: boolean

    Optional allow_ko

    allow_ko?: boolean

    Optional allow_self_capture

    allow_self_capture?: boolean

    Optional allow_superko

    allow_superko?: boolean

    Optional auth

    auth?: string

    Optional automatic_stone_removal

    automatic_stone_removal?: boolean

    Optional black_player_id

    black_player_id?: number

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_div

    board_div?: HTMLElement

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional bounds

    bounds?: GobanBounds

    Optional chat_log

    chat_log?: GobanChatLog

    Optional circle_radius

    circle_radius?: number

    Optional clock

    clock?: GameClock

    Optional connect_to_chat

    connect_to_chat?: number | boolean

    Optional disable_analysis

    disable_analysis?: boolean

    Optional display_width

    display_width?: number

    Optional dont_draw_last_move

    dont_draw_last_move?: boolean

    Optional dont_show_messages

    dont_show_messages?: boolean

    Optional double_click_submit

    double_click_submit?: boolean

    Optional draw_bottom_labels

    draw_bottom_labels?: boolean

    Optional draw_left_labels

    draw_left_labels?: boolean

    Optional draw_right_labels

    draw_right_labels?: boolean

    Optional draw_top_labels

    draw_top_labels?: boolean

    Optional end_time

    end_time?: number

    Optional errors

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

    Type declaration

    • error: string
    • stack: any

    Optional free_handicap_placement

    free_handicap_placement?: boolean

    Optional game_date

    game_date?: string

    Optional game_id

    game_id?: string | number

    Optional game_name

    game_name?: string

    Optional game_type

    game_type?: "temporary"

    Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Optional group_ids

    group_ids?: number[]

    Optional handicap

    handicap?: number

    Optional handicap_rank_difference

    handicap_rank_difference?: number

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional interactive

    interactive?: boolean

    Optional isInPushedAnalysis

    isInPushedAnalysis?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerController

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerOwner

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional is_game_record

    is_game_record?: boolean

    Optional isobranch_hash

    isobranch_hash?: string

    Optional komi

    komi?: number

    Optional ladder

    ladder?: number

    Optional ladder_id

    ladder_id?: number

    Optional last_move_opacity

    last_move_opacity?: number

    Optional last_move_radius

    last_move_radius?: number

    Optional latencies

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

    Type declaration

    • [player_id: string]: number

    Optional leavePushedAnalysis

    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void

      • Returns void

    Optional malkovich_log

    malkovich_log?: GobanChatLog

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional mode

    mode?: GobanModes

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Optional moves

    moves?: GobanMovesArray

    Optional name

    name?: string

    Optional needs_sealing

    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    -

    Optional ogs

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

    Type declaration

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

    Optional ogs_import

    ogs_import?: boolean

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

    -

    Optional onError

    onError?: ((err) => void)

    Type declaration

      • (err): void

      • Parameters

        • err: Error

        Returns void

    Optional onScoreEstimationUpdated

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

    Type declaration

      • (winning_color, points): void

      • Parameters

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

        Returns void

    Optional one_click_submit

    one_click_submit?: boolean

    Optional opponent_plays_first_after_resume

    opponent_plays_first_after_resume?: boolean

    Optional original_disable_analysis

    original_disable_analysis?: boolean

    Optional original_sgf

    original_sgf?: string

    Optional outcome

    outcome?: string

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    Optional phase

    phase?: GobanEnginePhase

    Optional player

    player?: JGOFNumericPlayerColor

    Optional player_id

    player_id?: number

    Optional player_pool

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

    Type declaration

    Optional players

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

    Type declaration

    Optional puzzle_autoplace_delay

    puzzle_autoplace_delay?: number

    Optional puzzle_collection

    puzzle_collection?: number

    Optional puzzle_description

    puzzle_description?: string

    Optional puzzle_opponent_move_mode

    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

    Optional puzzle_player_move_mode

    puzzle_player_move_mode?: PuzzlePlayerMoveMode

    Optional puzzle_rank

    puzzle_rank?: number

    Optional puzzle_type

    puzzle_type?: string

    Optional ranked

    ranked?: boolean

    Optional removal

    removal?: boolean[][]

    Optional removed

    removed?: string | JGOFMove[]

    Removed stones in stone removal phase +

    Properties

    Optional aga_handicap_scoring

    aga_handicap_scoring?: boolean

    Optional allow_ko

    allow_ko?: boolean

    Optional allow_self_capture

    allow_self_capture?: boolean

    Optional allow_superko

    allow_superko?: boolean

    Optional auth

    auth?: string

    Optional automatic_stone_removal

    automatic_stone_removal?: boolean

    Optional black_player_id

    black_player_id?: number

    Optional black_prisoners

    black_prisoners?: number

    Optional board

    board?: JGOFNumericPlayerColor[][]

    Optional board_div

    board_div?: HTMLElement

    Optional board_is_repeating

    board_is_repeating?: boolean

    Optional bounds

    bounds?: GobanBounds

    Optional chat_log

    chat_log?: GobanChatLog

    Optional circle_radius

    circle_radius?: number

    Optional clock

    clock?: GameClock

    Optional connect_to_chat

    connect_to_chat?: number | boolean

    Optional disable_analysis

    disable_analysis?: boolean

    Optional display_width

    display_width?: number

    Optional dont_draw_last_move

    dont_draw_last_move?: boolean

    Optional dont_show_messages

    dont_show_messages?: boolean

    Optional double_click_submit

    double_click_submit?: boolean

    Optional draw_bottom_labels

    draw_bottom_labels?: boolean

    Optional draw_left_labels

    draw_left_labels?: boolean

    Optional draw_right_labels

    draw_right_labels?: boolean

    Optional draw_top_labels

    draw_top_labels?: boolean

    Optional end_time

    end_time?: number

    Optional errors

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

    Type declaration

    • error: string
    • stack: any

    Optional free_handicap_placement

    free_handicap_placement?: boolean

    Optional game_date

    game_date?: string

    Optional game_id

    game_id?: string | number

    Optional game_name

    game_name?: string

    Optional game_type

    game_type?: "temporary"

    Optional getPuzzlePlacementSetting

    getPuzzlePlacementSetting?: (() => PuzzlePlacementSetting)

    Type declaration

    Optional group_ids

    group_ids?: number[]

    Optional handicap

    handicap?: number

    Optional handicap_rank_difference

    handicap_rank_difference?: number

    Optional height

    height?: number

    Optional initial_player

    initial_player?: PlayerColor

    Optional initial_state

    initial_state?: GobanEngineInitialState

    Optional interactive

    interactive?: boolean

    Optional isInPushedAnalysis

    isInPushedAnalysis?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerController

    isPlayerController?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional isPlayerOwner

    isPlayerOwner?: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    Optional is_game_record

    is_game_record?: boolean

    Optional isobranch_hash

    isobranch_hash?: string

    Optional komi

    komi?: number

    Optional ladder

    ladder?: number

    Optional ladder_id

    ladder_id?: number

    Optional last_move_opacity

    last_move_opacity?: number

    Optional last_move_radius

    last_move_radius?: number

    Optional latencies

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

    Type declaration

    • [player_id: string]: number

    Optional leavePushedAnalysis

    leavePushedAnalysis?: (() => void)

    Type declaration

      • (): void

      • Returns void

    Optional malkovich_log

    malkovich_log?: GobanChatLog

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional mode

    mode?: GobanModes

    Optional move_tree

    move_tree?: MoveTreeJson

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Optional moves

    moves?: GobanMovesArray

    Optional name

    name?: string

    Optional needs_sealing

    needs_sealing?: JGOFSealingIntersection[]

    Intersections that need to be sealed before scoring should happen

    +

    Optional ogs

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

    Type declaration

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

    Optional ogs_import

    ogs_import?: boolean

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

    +

    Optional onError

    onError?: ((err) => void)

    Type declaration

      • (err): void

      • Parameters

        • err: Error

        Returns void

    Optional onScoreEstimationUpdated

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

    Type declaration

      • (winning_color, points): void

      • Parameters

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

        Returns void

    Optional one_click_submit

    one_click_submit?: boolean

    Optional opponent_plays_first_after_resume

    opponent_plays_first_after_resume?: boolean

    Optional original_disable_analysis

    original_disable_analysis?: boolean

    Optional original_sgf

    original_sgf?: string

    Optional outcome

    outcome?: string

    Optional pause_control

    pause_control?: AdHocPauseControl

    Optional paused_since

    paused_since?: number

    Optional phase

    phase?: GobanEnginePhase

    Optional player

    player?: JGOFNumericPlayerColor

    Optional player_id

    player_id?: number

    Optional player_pool

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

    Type declaration

    Optional players

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

    Type declaration

    Optional puzzle_autoplace_delay

    puzzle_autoplace_delay?: number

    Optional puzzle_collection

    puzzle_collection?: number

    Optional puzzle_description

    puzzle_description?: string

    Optional puzzle_opponent_move_mode

    puzzle_opponent_move_mode?: PuzzleOpponentMoveMode

    Optional puzzle_player_move_mode

    puzzle_player_move_mode?: PuzzlePlayerMoveMode

    Optional puzzle_rank

    puzzle_rank?: number

    Optional puzzle_type

    puzzle_type?: string

    Optional ranked

    ranked?: boolean

    Optional removal

    removal?: boolean[][]

    Optional removed

    removed?: string | JGOFMove[]

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

    -

    Optional rengo

    rengo?: boolean

    Optional rengo_casual_mode

    rengo_casual_mode?: boolean

    Optional rengo_teams

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

    Type declaration

    Optional review_id

    review_id?: number

    Optional reviews

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

    Type declaration

    Optional rules

    rules?: GobanEngineRules

    Optional score

    score?: Score

    Optional score_handicap

    score_handicap?: boolean

    Optional score_passes

    score_passes?: boolean

    Optional score_prisoners

    score_prisoners?: boolean

    Optional score_stones

    score_stones?: boolean

    Optional score_territory

    score_territory?: boolean

    Optional score_territory_in_seki

    score_territory_in_seki?: boolean

    Optional server_socket

    server_socket?: GobanSocket<ClientToServer, ServerToClient>

    Optional spectator_log

    spectator_log?: GobanChatLog

    Optional square_size

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

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Optional start_time

    start_time?: number

    Optional strict_seki_mode

    strict_seki_mode?: boolean

    Optional superko_algorithm

    superko_algorithm?: GobanEngineSuperKoAlgorithm

    Optional throw_all_errors

    throw_all_errors?: boolean

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

    Optional rengo

    rengo?: boolean

    Optional rengo_casual_mode

    rengo_casual_mode?: boolean

    Optional rengo_teams

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

    Type declaration

    Optional review_id

    review_id?: number

    Optional reviews

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

    Type declaration

    Optional rules

    rules?: GobanEngineRules

    Optional score

    score?: Score

    Optional score_handicap

    score_handicap?: boolean

    Optional score_passes

    score_passes?: boolean

    Optional score_prisoners

    score_prisoners?: boolean

    Optional score_stones

    score_stones?: boolean

    Optional score_territory

    score_territory?: boolean

    Optional score_territory_in_seki

    score_territory_in_seki?: boolean

    Optional server_socket

    server_socket?: GobanSocket<ClientToServer, ServerToClient>

    Optional spectator_log

    spectator_log?: GobanChatLog

    Optional square_size

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

    Type declaration

      • (goban): number

      • Parameters

        Returns number

    Optional stalling_score_estimate

    stalling_score_estimate?: StallingScoreEstimate

    Optional start_time

    start_time?: number

    Optional strict_seki_mode

    strict_seki_mode?: boolean

    Optional superko_algorithm

    superko_algorithm?: GobanEngineSuperKoAlgorithm

    Optional throw_all_errors

    throw_all_errors?: boolean

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

    -

    Optional time_control

    time_control?: JGOFTimeControl

    Optional time_per_move

    time_per_move?: number

    Optional title_div

    title_div?: HTMLElement

    Optional tournament_id

    tournament_id?: number

    Optional username

    username?: string

    Optional variation_stone_opacity

    variation_stone_opacity?: number

    Optional visual_undo_request_indicator

    visual_undo_request_indicator?: boolean

    Optional white_must_pass_last

    white_must_pass_last?: boolean

    Optional white_player_id

    white_player_id?: number

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Optional winner

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

    Settings

    Member Visibility

    Theme

    On This Page

    aga_handicap_scoringallow_koallow_self_captureallow_superkoauthautomatic_stone_removalblack_player_idblack_prisonersboardboard_divboard_is_repeatingboundschat_logcircle_radiusclockconnect_to_chatdisable_analysisdisplay_widthdont_draw_last_movedont_show_messagesdouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegame_typegetPuzzlePlacementSettinggroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwneris_game_recordisobranch_hashkomiladderladder_idlast_move_opacitylast_move_radiuslatenciesleavePushedAnalysismalkovich_logmarksmodemove_treemove_tree_containermovesnameneeds_sealingogsogs_importonErroronScoreEstimationUpdatedone_click_submitopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomepause_controlpaused_sincephaseplayerplayer_idplayer_poolplayerspuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typerankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekiserver_socketspectator_logsquare_sizestalling_score_estimatestart_timestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetitle_divtournament_idusernamevariation_stone_opacityvisual_undo_request_indicatorwhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner
    \ No newline at end of file +

    Optional time_control

    time_control?: JGOFTimeControl

    Optional time_per_move

    time_per_move?: number

    Optional title_div

    title_div?: HTMLElement

    Optional tournament_id

    tournament_id?: number

    Optional username

    username?: string

    Optional variation_stone_opacity

    variation_stone_opacity?: number

    Optional visual_undo_request_indicator

    visual_undo_request_indicator?: boolean

    Optional white_must_pass_last

    white_must_pass_last?: boolean

    Optional white_player_id

    white_player_id?: number

    Optional white_prisoners

    white_prisoners?: number

    Optional width

    width?: number

    Optional winner

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

    Settings

    Member Visibility

    Theme

    On This Page

    aga_handicap_scoringallow_koallow_self_captureallow_superkoauthautomatic_stone_removalblack_player_idblack_prisonersboardboard_divboard_is_repeatingboundschat_logcircle_radiusclockconnect_to_chatdisable_analysisdisplay_widthdont_draw_last_movedont_show_messagesdouble_click_submitdraw_bottom_labelsdraw_left_labelsdraw_right_labelsdraw_top_labelsend_timeerrorsfree_handicap_placementgame_dategame_idgame_namegame_typegetPuzzlePlacementSettinggroup_idshandicaphandicap_rank_differenceheightinitial_playerinitial_stateinteractiveisInPushedAnalysisisPlayerControllerisPlayerOwneris_game_recordisobranch_hashkomiladderladder_idlast_move_opacitylast_move_radiuslatenciesleavePushedAnalysismalkovich_logmarksmodemove_treemove_tree_containermovesnameneeds_sealingogsogs_importonErroronScoreEstimationUpdatedone_click_submitopponent_plays_first_after_resumeoriginal_disable_analysisoriginal_sgfoutcomepause_controlpaused_sincephaseplayerplayer_idplayer_poolplayerspuzzle_autoplace_delaypuzzle_collectionpuzzle_descriptionpuzzle_opponent_move_modepuzzle_player_move_modepuzzle_rankpuzzle_typerankedremovalremovedrengorengo_casual_moderengo_teamsreview_idreviewsrulesscorescore_handicapscore_passesscore_prisonersscore_stonesscore_territoryscore_territory_in_sekiserver_socketspectator_logsquare_sizestalling_score_estimatestart_timestrict_seki_modesuperko_algorithmthrow_all_errorstime_controltime_per_movetitle_divtournament_idusernamevariation_stone_opacityvisual_undo_request_indicatorwhite_must_pass_lastwhite_player_idwhite_prisonerswidthwinner
    \ No newline at end of file diff --git a/docs/interfaces/SVGStoneParameters.html b/docs/interfaces/SVGStoneParameters.html index 8a7b3e73..d2b5b8d9 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? gradient? id stroke? stroke_scale? url? -

    Properties

    Optional fill

    fill?: string

    Optional gradient

    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

    id: string

    Optional stroke

    stroke?: string

    Optional stroke_scale

    stroke_scale?: number

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    fillgradientidstrokestroke_scaleurl
    \ No newline at end of file +

    Properties

    Optional fill

    fill?: string

    Optional gradient

    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

    id: string

    Optional stroke

    stroke?: string

    Optional stroke_scale

    stroke_scale?: number

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    fillgradientidstrokestroke_scaleurl
    \ No newline at end of file diff --git a/docs/interfaces/SVGStop.html b/docs/interfaces/SVGStop.html index b79202c1..5f6dca72 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

    color offset -

    Properties

    color

    color: string

    offset

    offset: number

    Settings

    Member Visibility

    Theme

    On This Page

    coloroffset
    \ No newline at end of file +

    Properties

    color

    color: string

    offset

    offset: number

    Settings

    Member Visibility

    Theme

    On This Page

    coloroffset
    \ No newline at end of file diff --git a/docs/interfaces/Score.html b/docs/interfaces/Score.html index ff994cce..38bf5c3f 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

    black white -

    Properties

    black

    black: PlayerScore

    white

    white: PlayerScore

    Settings

    Member Visibility

    Theme

    On This Page

    blackwhite
    \ No newline at end of file +

    Properties

    black

    black: PlayerScore

    white

    white: PlayerScore

    Settings

    Member Visibility

    Theme

    On This Page

    blackwhite
    \ No newline at end of file diff --git a/docs/interfaces/ScoreEstimateRequest.html b/docs/interfaces/ScoreEstimateRequest.html index eea70e18..95cc49f2 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

    autoscore? black_prisoners? board_state height @@ -11,4 +11,4 @@

    Properties

    Optional autoscore

    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.

    -

    Optional black_prisoners

    black_prisoners?: number

    board_state

    board_state: JGOFNumericPlayerColor[][]

    height

    height: number

    jwt

    jwt: string

    Optional komi

    komi?: number

    player_to_move

    player_to_move: "black" | "white"

    rules

    rules: GobanEngineRules

    Optional white_prisoners

    white_prisoners?: number

    width

    width: number

    Settings

    Member Visibility

    Theme

    On This Page

    autoscoreblack_prisonersboard_stateheightjwtkomiplayer_to_moveruleswhite_prisonerswidth
    \ No newline at end of file +

    Optional black_prisoners

    black_prisoners?: number

    board_state

    board_state: JGOFNumericPlayerColor[][]

    height

    height: number

    jwt

    jwt: string

    Optional komi

    komi?: number

    player_to_move

    player_to_move: "black" | "white"

    rules

    rules: GobanEngineRules

    Optional white_prisoners

    white_prisoners?: number

    width

    width: number

    Settings

    Member Visibility

    Theme

    On This Page

    autoscoreblack_prisonersboard_stateheightjwtkomiplayer_to_moveruleswhite_prisonerswidth
    \ No newline at end of file diff --git a/docs/interfaces/ScoreEstimateResponse.html b/docs/interfaces/ScoreEstimateResponse.html index cb6ba46c..2612451f 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? autoscored_needs_sealing? autoscored_removed? ownership score? win_rate?

    Properties

    Optional autoscored_board_state

    autoscored_board_state?: JGOFNumericPlayerColor[][]

    Board state after autoscoring logic has been run. Only defined if autoscore was true in the request.

    -

    Optional autoscored_needs_sealing

    autoscored_needs_sealing?: JGOFSealingIntersection[]

    Coordinates that still need sealing

    -

    Optional autoscored_removed

    autoscored_removed?: JGOFMove[]

    Intersections that are dead or dame. Only defined if autoscore was true in the request.

    -

    ownership

    ownership: number[][]

    Matrix of ownership estimates ranged from -1 (white) to 1 (black)

    -

    Optional score

    score?: number

    Estimated score

    -

    Optional win_rate

    win_rate?: number

    Estimated win rate

    -

    Settings

    Member Visibility

    Theme

    On This Page

    autoscored_board_stateautoscored_needs_sealingautoscored_removedownershipscorewin_rate
    \ No newline at end of file +

    Optional autoscored_needs_sealing

    autoscored_needs_sealing?: JGOFSealingIntersection[]

    Coordinates that still need sealing

    +

    Optional autoscored_removed

    autoscored_removed?: JGOFMove[]

    Intersections that are dead or dame. Only defined if autoscore was true in the request.

    +

    ownership

    ownership: number[][]

    Matrix of ownership estimates ranged from -1 (white) to 1 (black)

    +

    Optional score

    score?: number

    Estimated score

    +

    Optional win_rate

    win_rate?: number

    Estimated win rate

    +

    Settings

    Member Visibility

    Theme

    On This Page

    autoscored_board_stateautoscored_needs_sealingautoscored_removedownershipscorewin_rate
    \ No newline at end of file diff --git a/docs/interfaces/ScoringLocations.html b/docs/interfaces/ScoringLocations.html index b2221f09..2e9a2034 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

    black white -

    Properties

    black

    black: {
        locations: JGOFIntersection[];
        stones: number;
        territory: number;
    }

    Type declaration

    white

    white: {
        locations: JGOFIntersection[];
        stones: number;
        territory: number;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    blackwhite
    \ No newline at end of file +

    Properties

    black

    black: {
        locations: JGOFIntersection[];
        stones: number;
        territory: number;
    }

    Type declaration

    white

    white: {
        locations: JGOFIntersection[];
        stones: number;
        territory: number;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    blackwhite
    \ No newline at end of file diff --git a/docs/interfaces/StateUpdateEvents.html b/docs/interfaces/StateUpdateEvents.html index 3506f9cb..08fe0a70 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 analyze_tool cur_move cur_review_move @@ -18,4 +18,4 @@ undo_canceled undo_requested winner -

    Properties

    analyze_subtool

    analyze_subtool: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    analyze_tool

    analyze_tool: ((d) => void)

    Type declaration

    cur_move

    cur_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    cur_review_move

    cur_review_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    last_official_move

    last_official_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    mode

    mode: ((d) => void)

    Type declaration

    outcome

    outcome: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    paused

    paused: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: boolean

        Returns void

    phase

    phase: ((d) => void)

    Type declaration

    review_controller_id

    review_controller_id: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    review_owner_id

    review_owner_id: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    rules

    rules: ((d) => void)

    Type declaration

    score_estimate

    score_estimate: ((d) => void)

    Type declaration

    stalling_score_estimate

    stalling_score_estimate: ((data?) => void)

    Type declaration

    strict_seki_mode

    strict_seki_mode: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: boolean

        Returns void

    submit_move

    submit_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

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

        Returns void

    title

    title: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    undo_canceled

    undo_canceled: (() => void)

    Type declaration

      • (): void

      • Returns void

    undo_requested

    undo_requested: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    winner

    winner: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    analyze_subtoolanalyze_toolcur_movecur_review_movelast_official_movemodeoutcomepausedphasereview_controller_idreview_owner_idrulesscore_estimatestalling_score_estimatestrict_seki_modesubmit_movetitleundo_canceledundo_requestedwinner
    \ No newline at end of file +

    Properties

    analyze_subtool

    analyze_subtool: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    analyze_tool

    analyze_tool: ((d) => void)

    Type declaration

    cur_move

    cur_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    cur_review_move

    cur_review_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    last_official_move

    last_official_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        Returns void

    mode

    mode: ((d) => void)

    Type declaration

    outcome

    outcome: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    paused

    paused: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: boolean

        Returns void

    phase

    phase: ((d) => void)

    Type declaration

    review_controller_id

    review_controller_id: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    review_owner_id

    review_owner_id: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    rules

    rules: ((d) => void)

    Type declaration

    score_estimate

    score_estimate: ((d) => void)

    Type declaration

    stalling_score_estimate

    stalling_score_estimate: ((data?) => void)

    Type declaration

    strict_seki_mode

    strict_seki_mode: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: boolean

        Returns void

    submit_move

    submit_move: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

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

        Returns void

    title

    title: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: string

        Returns void

    undo_canceled

    undo_canceled: (() => void)

    Type declaration

      • (): void

      • Returns void

    undo_requested

    undo_requested: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    winner

    winner: ((d) => void)

    Type declaration

      • (d): void

      • Parameters

        • d: undefined | number

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    analyze_subtoolanalyze_toolcur_movecur_review_movelast_official_movemodeoutcomepausedphasereview_controller_idreview_owner_idrulesscore_estimatestalling_score_estimatestrict_seki_modesubmit_movetitleundo_canceledundo_requestedwinner
    \ No newline at end of file diff --git a/docs/interfaces/ThemesInterface.html b/docs/interfaces/ThemesInterface.html index d606f9fa..890d59d4 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

    black board white -

    Properties

    black

    black: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    board

    board: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    white

    white: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    blackboardwhite
    \ No newline at end of file +

    Properties

    black

    black: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    board

    board: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    white

    white: {
        [name: string]: typeof GobanTheme;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    blackboardwhite
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.AbsoluteClock.html b/docs/interfaces/_internal_.AbsoluteClock.html index da02f602..866ec640 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

    thinking_time -

    Properties

    thinking_time

    thinking_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    thinking_time
    \ No newline at end of file +AbsoluteClock | goban

    Interface AbsoluteClock

    interface AbsoluteClock {
        thinking_time: number;
    }

    Properties

    thinking_time +

    Properties

    thinking_time

    thinking_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    thinking_time
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.AnalysisComment.html b/docs/interfaces/_internal_.AnalysisComment.html index 70da552f..2bea6b67 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? from? marks? moves? name? pen_marks? type -

    Properties

    Optional branch_move

    branch_move?: number

    Optional from

    from?: number

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional moves

    moves?: string

    Optional name

    name?: string

    Optional pen_marks

    pen_marks?: unknown[]

    type

    type: "analysis"

    Settings

    Member Visibility

    Theme

    On This Page

    branch_movefrommarksmovesnamepen_markstype
    \ No newline at end of file +

    Properties

    Optional branch_move

    branch_move?: number

    Optional from

    from?: number

    Optional marks

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

    Type declaration

    • [mark: string]: string

    Optional moves

    moves?: string

    Optional name

    name?: string

    Optional pen_marks

    pen_marks?: unknown[]

    type

    type: "analysis"

    Settings

    Member Visibility

    Theme

    On This Page

    branch_movefrommarksmovesnamepen_markstype
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.AutoscoreResults.html b/docs/interfaces/_internal_.AutoscoreResults.html index 99c8a3ef..b50d272e 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 removed result sealed_result -

    Properties

    needs_sealing

    needs_sealing: JGOFSealingIntersection[]

    removed

    removed: JGOFMove[]

    result

    result: JGOFNumericPlayerColor[][]

    sealed_result

    sealed_result: JGOFNumericPlayerColor[][]

    Settings

    Member Visibility

    Theme

    On This Page

    needs_sealingremovedresultsealed_result
    \ No newline at end of file +

    Properties

    needs_sealing

    needs_sealing: JGOFSealingIntersection[]

    removed

    removed: JGOFMove[]

    result

    result: JGOFNumericPlayerColor[][]

    sealed_result

    sealed_result: JGOFNumericPlayerColor[][]

    Settings

    Member Visibility

    Theme

    On This Page

    needs_sealingremovedresultsealed_result
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.BoardStateWithIsobranchHash.html b/docs/interfaces/_internal_.BoardStateWithIsobranchHash.html index 9b10dde7..deb9f04a 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 board board_is_repeating goban_callback? @@ -19,26 +19,26 @@ getRawStoneString setRemoved toggleSingleGroupRemoval -

    Properties

    black_prisoners

    black_prisoners: number

    board

    board: JGOFNumericPlayerColor[][]

    board_is_repeating

    board_is_repeating: boolean

    Protected Optional goban_callback

    goban_callback?: GobanBase

    Readonly height

    height: number = 19

    Optional isobranch_hash

    isobranch_hash?: string

    The isobranch hash is a hash of the board state. This field is used by +

    Properties

    black_prisoners

    black_prisoners: number

    board

    board: JGOFNumericPlayerColor[][]

    board_is_repeating

    board_is_repeating: boolean

    Protected Optional goban_callback

    goban_callback?: GobanBase

    Readonly height

    height: number = 19

    Optional isobranch_hash

    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.

    -

    player

    player: JGOFNumericPlayerColor

    removal

    removal: boolean[][]

    white_prisoners

    white_prisoners: number

    Readonly width

    width: number = 19

    Methods

    boardEquals

    clearRemoved

    cloneBoard

    cloneBoardState

    computeScoringLocations

    player

    player: JGOFNumericPlayerColor

    removal

    removal: boolean[][]

    white_prisoners

    white_prisoners: number

    Readonly width

    width: number = 19

    Methods

    boardEquals

    clearRemoved

    cloneBoard

    cloneBoardState

    computeScoringLocations

    countLiberties

    foreachNeighbor

    getNeighboringRawStoneStrings

    countLiberties

    foreachNeighbor

    getNeighboringRawStoneStrings

    getRawStoneString

    setRemoved

    getRawStoneString

    setRemoved

    • setRemoved(x, y, removed, emit_stone_removal_updated?): void

    • Sets a position as being removed or not removed. If emit_stone_removal_updated is set to false, the "stone-removal.updated" event will not be emitted, and it is up to the caller to emit this event appropriately.

      -

      Parameters

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

      Returns void

    toggleSingleGroupRemoval

    • toggleSingleGroupRemoval(x, y, force_removal?): {
          group: RawStoneString;
          removed: boolean;
      }

    • Toggles a group of stones for removal or restoration.

      +

      Parameters

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

      Returns void

    toggleSingleGroupRemoval

    • toggleSingleGroupRemoval(x, y, force_removal?): {
          group: RawStoneString;
          removed: boolean;
      }

    • Toggles a group of stones for removal or restoration.

      By default, if we are marking a group for removal but the group is almost certainly alive (two eyes, etc), this will result in a no-op, unless force_removal is set to true.

      -

      Parameters

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

      Returns {
          group: RawStoneString;
          removed: boolean;
      }

    Settings

    Member Visibility

    Theme

    On This Page

    black_prisonersboardboard_is_repeatinggoban_callbackheightisobranch_hashplayerremovalwhite_prisonerswidthboardEqualsclearRemovedcloneBoardcloneBoardStatecomputeScoringLocationscountLibertiesforeachNeighborgetNeighboringRawStoneStringsgetRawStoneStringsetRemovedtoggleSingleGroupRemoval
    \ No newline at end of file +

    Parameters

    Returns {
        group: RawStoneString;
        removed: boolean;
    }

    Settings

    Member Visibility

    Theme

    On This Page

    black_prisonersboardboard_is_repeatinggoban_callbackheightisobranch_hashplayerremovalwhite_prisonerswidthboardEqualsclearRemovedcloneBoardcloneBoardStatecomputeScoringLocationscountLibertiesforeachNeighborgetNeighboringRawStoneStringsgetRawStoneStringsetRemovedtoggleSingleGroupRemoval
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.ByoYomiClock.html b/docs/interfaces/_internal_.ByoYomiClock.html index 3005c094..09a5a711 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 period_time_left? periods thinking_time -

    Properties

    period_time

    period_time: number

    Optional period_time_left

    period_time_left?: number

    periods

    periods: number

    thinking_time

    thinking_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    period_timeperiod_time_leftperiodsthinking_time
    \ No newline at end of file +

    Properties

    period_time

    period_time: number

    Optional period_time_left

    period_time_left?: number

    periods

    periods: number

    thinking_time

    thinking_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    period_timeperiod_time_leftperiodsthinking_time
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.CanadianClock.html b/docs/interfaces/_internal_.CanadianClock.html index 4e649005..b6027015 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 moves_left thinking_time -

    Properties

    block_time

    block_time: number

    moves_left

    moves_left: number

    thinking_time

    thinking_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    block_timemoves_leftthinking_time
    \ No newline at end of file +

    Properties

    block_time

    block_time: number

    moves_left

    moves_left: number

    thinking_time

    thinking_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    block_timemoves_leftthinking_time
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.ErrorResponse.html b/docs/interfaces/_internal_.ErrorResponse.html index cfc03742..59fb4a3f 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

    code message -

    Properties

    code

    code: string

    message

    message: string

    Settings

    Member Visibility

    Theme

    On This Page

    codemessage
    \ No newline at end of file +

    Properties

    code

    code: string

    message

    message: string

    Settings

    Member Visibility

    Theme

    On This Page

    codemessage
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.FischerClock.html b/docs/interfaces/_internal_.FischerClock.html index e6bd7efe..be4cda49 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 thinking_time -

    Properties

    skip_bonus

    skip_bonus: boolean

    thinking_time

    thinking_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    skip_bonusthinking_time
    \ No newline at end of file +

    Properties

    skip_bonus

    skip_bonus: boolean

    thinking_time

    thinking_time: number

    Settings

    Member Visibility

    Theme

    On This Page

    skip_bonusthinking_time
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.GameListPlayer.html b/docs/interfaces/_internal_.GameListPlayer.html index 80e97eca..f1ae5998 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 id professional rank ratings username -

    Properties

    accepted

    accepted: boolean

    id

    id: number

    professional

    professional: boolean

    rank

    rank: number

    ratings

    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

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    acceptedidprofessionalrankratingsusername
    \ No newline at end of file +

    Properties

    accepted

    accepted: boolean

    id

    id: number

    professional

    professional: boolean

    rank

    rank: number

    ratings

    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

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    acceptedidprofessionalrankratingsusername
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.GobanSVGInterface.html b/docs/interfaces/_internal_.GobanSVGInterface.html index 2bc43cfd..101d250d 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 move_tree_container?

    Methods

    clearAnalysisDrawing clearMessage @@ -13,4 +13,4 @@ setLastMoveOpacity setMoveTreeContainer showMessage -

    Properties

    engine

    engine: GobanEngine

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Methods

    clearAnalysisDrawing

    clearMessage

    destroy

    disablePen

    drawPenMarks

    drawSquare

    enablePen

    move_tree_bindEvents

    move_tree_redraw

    setByoYomiLabel

    setLastMoveOpacity

    setMoveTreeContainer

    • setMoveTreeContainer(container): void

    • Parameters

      • container: HTMLElement

      Returns void

    showMessage

    • showMessage(message_id_or_error, parameters?, timeout?): void

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    enginemove_tree_containerclearAnalysisDrawingclearMessagedestroydisablePendrawPenMarksdrawSquareenablePenmove_tree_bindEventsmove_tree_redrawsetByoYomiLabelsetLastMoveOpacitysetMoveTreeContainershowMessage
    \ No newline at end of file +

    Properties

    engine

    engine: GobanEngine

    Optional move_tree_container

    move_tree_container?: HTMLElement

    Methods

    clearAnalysisDrawing

    clearMessage

    destroy

    disablePen

    drawPenMarks

    drawSquare

    enablePen

    move_tree_bindEvents

    move_tree_redraw

    setByoYomiLabel

    setLastMoveOpacity

    setMoveTreeContainer

    • setMoveTreeContainer(container): void

    • Parameters

      • container: HTMLElement

      Returns void

    showMessage

    • showMessage(message_id_or_error, parameters?, timeout?): void

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    enginemove_tree_containerclearAnalysisDrawingclearMessagedestroydisablePendrawPenMarksdrawSquareenablePenmove_tree_bindEventsmove_tree_redrawsetByoYomiLabelsetLastMoveOpacitysetMoveTreeContainershowMessage
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.GobanSocketOptions.html b/docs/interfaces/_internal_.GobanSocketOptions.html index af9a9a2d..d51a8696 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? ping_interval? quiet? timeout_delay?

    Properties

    Optional dont_ping

    dont_ping?: boolean

    Don't automatically send pings

    -

    Optional ping_interval

    ping_interval?: number

    Optional quiet

    quiet?: boolean

    Don't log connection/disconnect things

    -

    Optional timeout_delay

    timeout_delay?: number

    Settings

    Member Visibility

    Theme

    On This Page

    dont_pingping_intervalquiettimeout_delay
    \ No newline at end of file +

    Optional ping_interval

    ping_interval?: number

    Optional quiet

    quiet?: boolean

    Don't log connection/disconnect things

    +

    Optional timeout_delay

    timeout_delay?: number

    Settings

    Member Visibility

    Theme

    On This Page

    dont_pingping_intervalquiettimeout_delay
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.JGOFPlayerClockWithTimedOut.html b/docs/interfaces/_internal_.JGOFPlayerClockWithTimedOut.html index e2b4621b..7a58b4bb 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? main_time moves_left? period_time_left? @@ -6,9 +6,9 @@ timed_out

    Properties

    Optional block_time_left

    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

    main_time: number

    Main time left on the clock, in milliseconds.

    -

    Optional moves_left

    moves_left?: number

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

    main_time

    main_time: number

    Main time left on the clock, in milliseconds.

    +

    Optional moves_left

    moves_left?: number

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

    -

    Optional period_time_left

    period_time_left?: number

    Used with byo-yomi time control. Time left on the period time, in milliseconds.

    -

    Optional periods_left

    periods_left?: number

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

    -

    timed_out

    timed_out: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    block_time_leftmain_timemoves_leftperiod_time_leftperiods_lefttimed_out
    \ No newline at end of file +

    Optional period_time_left

    period_time_left?: number

    Used with byo-yomi time control. Time left on the period time, in milliseconds.

    +

    Optional periods_left

    periods_left?: number

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

    +

    timed_out

    timed_out: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    block_time_leftmain_timemoves_leftperiod_time_leftperiods_lefttimed_out
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.MoveTreeViewPortInterface.html b/docs/interfaces/_internal_.MoveTreeViewPortInterface.html index 0b7d8f09..7da56099 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 maxy minx miny offset_x offset_y -

    Properties

    maxx

    maxx: number

    maxy

    maxy: number

    minx

    minx: number

    miny

    miny: number

    offset_x

    offset_x: number

    offset_y

    offset_y: number

    Settings

    Member Visibility

    Theme

    On This Page

    maxxmaxyminxminyoffset_xoffset_y
    \ No newline at end of file +

    Properties

    maxx

    maxx: number

    maxy

    maxy: number

    minx

    minx: number

    miny

    miny: number

    offset_x

    offset_x: number

    offset_y

    offset_y: number

    Settings

    Member Visibility

    Theme

    On This Page

    maxxmaxyminxminyoffset_xoffset_y
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.ReviewComment.html b/docs/interfaces/_internal_.ReviewComment.html index 663b5fb0..622cb3e5 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

    review_id type -

    Properties

    review_id

    review_id: number

    type

    type: "review"

    Settings

    Member Visibility

    Theme

    On This Page

    review_idtype
    \ No newline at end of file +

    Properties

    review_id

    review_id: number

    type

    type: "review"

    Settings

    Member Visibility

    Theme

    On This Page

    review_idtype
    \ No newline at end of file diff --git a/docs/interfaces/_internal_.ViewPortInterface.html b/docs/interfaces/_internal_.ViewPortInterface.html index b75b81a5..643a5c10 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 maxy minx miny offset_x offset_y -

    Properties

    maxx

    maxx: number

    maxy

    maxy: number

    minx

    minx: number

    miny

    miny: number

    offset_x

    offset_x: number

    offset_y

    offset_y: number

    Settings

    Member Visibility

    Theme

    On This Page

    maxxmaxyminxminyoffset_xoffset_y
    \ No newline at end of file +

    Properties

    maxx

    maxx: number

    maxy

    maxy: number

    minx

    minx: number

    miny

    miny: number

    offset_x

    offset_x: number

    offset_y

    offset_y: number

    Settings

    Member Visibility

    Theme

    On This Page

    maxxmaxyminxminyoffset_xoffset_y
    \ No newline at end of file diff --git a/docs/interfaces/protocol.AIServerToClient.html b/docs/interfaces/protocol.AIServerToClient.html index 6d1c5dc2..018bafa7 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

    net/pong +
      • (data): void

      • Parameters

        • data: any

        Returns void

    Properties

    net/pong

    Properties

    net/pong

    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

    Settings

    Member Visibility

    Theme

    On This Page

    net/pong
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    net/pong
    \ No newline at end of file diff --git a/docs/interfaces/protocol.AutomatchPreferences.html b/docs/interfaces/protocol.AutomatchPreferences.html index 2a08bef4..70555020 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 lower_rank_diff rules size_speed_options @@ -6,4 +6,4 @@ timestamp? upper_rank_diff uuid -

    Properties

    handicap

    handicap: {
        condition: AutomatchCondition;
        value: "enabled" | "disabled";
    }

    Type declaration

    lower_rank_diff

    lower_rank_diff: number

    rules

    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_speed_options: {
        size: Size;
        speed: Speed;
    }[]

    Type declaration

    time_control

    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

    Optional timestamp

    timestamp?: number

    upper_rank_diff

    upper_rank_diff: number

    uuid

    uuid: string

    Settings

    Member Visibility

    Theme

    On This Page

    handicaplower_rank_diffrulessize_speed_optionstime_controltimestampupper_rank_diffuuid
    \ No newline at end of file +

    Properties

    handicap

    handicap: {
        condition: AutomatchCondition;
        value: "enabled" | "disabled";
    }

    Type declaration

    lower_rank_diff

    lower_rank_diff: number

    rules

    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_speed_options: {
        size: Size;
        speed: Speed;
    }[]

    Type declaration

    time_control

    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

    Optional timestamp

    timestamp?: number

    upper_rank_diff

    upper_rank_diff: number

    uuid

    uuid: string

    Settings

    Member Visibility

    Theme

    On This Page

    handicaplower_rank_diffrulessize_speed_optionstime_controltimestampupper_rank_diffuuid
    \ No newline at end of file diff --git a/docs/interfaces/protocol.ClientToAIServer.html b/docs/interfaces/protocol.ClientToAIServer.html index 4875992d..0b358092 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

    ai-analyze-position +
    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

    ai-analyze-position ai-analyze-subscribe ai-analyze-unsubscribe ai-analyze-variation @@ -19,20 +19,20 @@
  • rules: RuleSet

    Ruleset to use

  • uuid: string

    UUID identifying the request

  • white_prisoners: number

    Number of captures white has

    -

    • Returns any

    ai-analyze-subscribe

    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

    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

    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

    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

    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

    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

    ai-relay-analyzed-position: ((data) => any)

    Relay an already analyzed position out to any other viewers

    +

    Returns void

    ai-relay-analyzed-position

    ai-relay-analyzed-position: ((data) => any)

    Relay an already analyzed position out to any other viewers

    Type declaration

      • (data): any

      • Parameters

        • data: {
              channel_id: string;
              data: any;
          }
          • channel_id: string

            Channel identifier, for instance ai-position-analysis-stream-review-

            -
          • data: any

        Returns any

    ai-review-connect

    ai-review-connect: ((data) => void)

    Type declaration

      • (data): void

      • Parameters

        • data: {
              ai_review_id: string | number;
              game_id: string | number;
              uuid: string;
          }
          • ai_review_id: string | number

            The AI review id we're basing our analysis off of

            +
          • data: any

        Returns any

    ai-review-connect

    ai-review-connect: ((data) => void)

    Type declaration

      • (data): void

      • Parameters

        • data: {
              ai_review_id: string | number;
              game_id: string | number;
              uuid: string;
          }
          • ai_review_id: string | number

            The AI review id we're basing our analysis off of

          • game_id: string | number

            The game id we're reviewing

          • uuid: string

            AI UUID

            -

        Returns void

    ai-review-disconnect

    ai-review-disconnect: ((data) => void)

    Type declaration

      • (data): void

      • Parameters

        • data: {
              uuid: string;
          }
          • uuid: string

            AI UUID

            -

        Returns void

    authenticate

    authenticate: ((data) => undefined | {
        id: number;
        username: string;
    })

    Authenticate with the server.

    +

    Returns void

    ai-review-disconnect

    ai-review-disconnect: ((data) => void)

    Type declaration

      • (data): void

      • Parameters

        • data: {
              uuid: string;
          }
          • uuid: string

            AI UUID

            +

        Returns void

    authenticate

    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

    net/ping: ((data) => void)

    Sends a ping to the server. This message should be +

    Returns undefined | {
        id: number;
        username: string;
    }

    net/ping

    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

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

    Settings

    Member Visibility

    Theme

    On This Page

    ai-analyze-positionai-analyze-subscribeai-analyze-unsubscribeai-analyze-variationai-relay-analyzed-positionai-review-connectai-review-disconnectauthenticatenet/ping
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    ai-analyze-positionai-analyze-subscribeai-analyze-unsubscribeai-analyze-variationai-relay-analyzed-positionai-review-connectai-review-disconnectauthenticatenet/ping
    \ No newline at end of file diff --git a/docs/interfaces/protocol.ClientToServer.html b/docs/interfaces/protocol.ClientToServer.html index 8e88f689..dd564e4f 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

    authenticate +
    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

    authenticate automatch/cancel automatch/find_match automatch/list @@ -88,79 +88,79 @@
  • 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

    automatch/cancel: ((data) => void)

    Cancel a match request

    -

    Type declaration

      • (data): void

      • Parameters

        • data: {
              uuid: string;
          }
          • uuid: string

        Returns void

    automatch/find_match

    automatch/find_match: ((data) => void)

    Request a match via the automatch system

    -

    Type declaration

    automatch/list

    automatch/list: ((data) => void)

    Get active automatch entries for the current user

    -

    Type declaration

      • (data): void

      • Parameters

        • data: {}

          Returns void

      bot/config

      bot/config: ((config) => void)

      Updates the config for the bot

      -

      Type declaration

        • (config): void

        • Parameters

          • config: any

          Returns void

      bot/status

      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

      challenge/keepalive: ((data) => void)

      Message to let the server know the client is still interested +

      Returns undefined | {
          id: number;
          username: string;
      }

      automatch/cancel

      automatch/cancel: ((data) => void)

      Cancel a match request

      +

      Type declaration

        • (data): void

        • Parameters

          • data: {
                uuid: string;
            }
            • uuid: string

          Returns void

      automatch/find_match

      automatch/find_match: ((data) => void)

      Request a match via the automatch system

      +

      Type declaration

      automatch/list

      automatch/list: ((data) => void)

      Get active automatch entries for the current user

      +

      Type declaration

        • (data): void

        • Parameters

          • data: {}

            Returns void

        bot/config

        bot/config: ((config) => void)

        Updates the config for the bot

        +

        Type declaration

          • (config): void

          • Parameters

            • config: any

            Returns void

        bot/status

        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

        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

        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

        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

        chat/part: ((data) => void)

        Leave a channel

        +

        Returns void

        chat/part

        chat/part: ((data) => void)

        Leave a channel

        Type declaration

          • (data): void

          • Parameters

            • data: {
                  channel: string;
              }
              • channel: string

                Channel to leave

                -

            Returns void

        chat/pm

        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

        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

        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

        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

        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

        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

        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

        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

        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

        chat/remove_all: ((data) => void)

        Moderator only command to remove all chat messages for a given player

        +

        Returns void

        chat/remove

        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

        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

        chat/send: ((data) => void)

        Sends a chat message to the given channel

        +

        Returns void

        chat/send

        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

        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

        game/annul: ((data) => void)

        In Japanese rules, if the game is found to be repeating, the players +

        Returns void

        chat/topic

        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

        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

        game/cancel: ((data) => void)

        Cancels a game. This is effectively the same as resign, except the +

        Returns void

        game/cancel

        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

        game/chat: ((data) => void)

        Sends a chat message to a game

        +

        Returns void

        game/chat

        game/chat: ((data) => void)

        Sends a chat message to a game

        Type declaration

        game/chat/remove

        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

        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

        game/conditional_moves/set: ((data) => void)

        Sets conditional moves to be made on behalf of the player in response +

        Returns void

        game/chat/remove

        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

        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

        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

        game/connect: ((data) => void)

        Connect to a game. Once connected, the client will receive game +

        Returns void

        game/connect

        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

        game/delayed_resign: ((data) => void)

        Type declaration

          • (data): void

          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                -

            Returns void

        game/disconnect

        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

        game/latency: ((data) => void)

        Update your latency information for a particular game. This is used +

        Returns void

        game/delayed_resign

        game/delayed_resign: ((data) => void)

        Type declaration

          • (data): void

          • Parameters

            • data: {
                  game_id: number;
              }
              • game_id: number

                The game id

                +

            Returns void

        game/disconnect

        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

        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

        game/log: ((data) => {
            data: any;
            event: string;
            timestamp: string;
        }[])

        Returns an event log for the given game. This is primarily +

        Returns void

        game/log

        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

        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

        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

        game/pause: ((data) => void)

        Pauses the game clocks

        +

        Returns void

        game/pause

        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

        game/prevent_escaping: ((data) => void)

        Request the server end a game that someone has left without resigning +

        Returns void

        game/prevent_escaping

        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

        game/prevent_stalling: ((data) => void)

        Request the server end a game that is being stalled by one of the +

        Returns void

        game/prevent_stalling

        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

        game/removed_stones/accept: ((data) => void)

        Accepts the stones as removed. Once both players have accepted the same +

        Returns void

        game/removed_stones/accept

        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

        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

        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

        game/removed_stones/set: ((data) => void)

        Sets removed stones in the stone removal phase.

        +

        Returns void

        game/removed_stones/set

        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

        game/resign: ((data) => void)

        Resigns from the game

        +

        Returns void

        game/resign

        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

        game/resume: ((data) => void)

        Resumes the game clocks

        +

        Returns void

        game/resume

        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

        game/timed_out: ((data) => void)

        Inform the server that the client believes it's clock has timed out +

        Returns void

        game/timed_out

        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

        game/undo/accept: ((data) => void)

        Accepts an undo

        +

        Returns void

        game/undo/accept

        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

        game/undo/cancel: ((data) => void)

        Cancels an undo request

        +

        Returns void

        game/undo/cancel

        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

        game/undo/request: ((data) => void)

        Requests an undo

        +

        Returns void

        game/undo/request

        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

        gamelist/count/subscribe: ((data) => void)

        Connects to the game list count. +

        Returns void

        gamelist/count/subscribe

        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

        gamelist/count/unsubscribe: ((data) => void)

        Disconnects from the game list count

        +

        Returns void

        gamelist/count/unsubscribe

        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

        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

        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

        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

          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

          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

            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

            net/ping: ((data) => void)

            Sends a ping to the server. This message should be +

            Returns void

            net/ping

            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

            notification/delete: ((data) => void)

            Deletes a notification

            -

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      notification_id: string;
                  }
                  • notification_id: string

                Returns void

            remote_storage/remove

            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

            notification/delete: ((data) => void)

            Deletes a notification

            +

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      notification_id: string;
                  }
                  • notification_id: string

                Returns void

            remote_storage/remove

            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

            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

            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

            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

            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

            review/append: ((data) => void)

            Append a review action to the review log.

            -

            Type declaration

            review/chat

            review/chat: ((data) => void)

            Sends a chat message to a review

            +

            Returns {
                error?: string;
                retry?: boolean;
            } | {
                success: true;
            }

            review/append

            review/append: ((data) => void)

            Append a review action to the review log.

            +

            Type declaration

            review/chat

            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

            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

            review/connect: ((data) => void)

            Connects to a review

            +

            Returns void

            review/chat/remove

            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

            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

            review/disconnect: ((data) => void)

            Disconnects from a review

            +

            Returns void

            review/disconnect

            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

            seek_graph/connect: ((data) => void)

            Subscribes to the seek graph events. The channel is required to be "global" +

            Returns void

            seek_graph/connect

            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

            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

            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

            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

            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

            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

            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

            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

            Settings

            Member Visibility

            Theme

            On This Page

            authenticateautomatch/cancelautomatch/find_matchautomatch/listbot/configbot/statuschallenge/keepalivechat/joinchat/partchat/pmchat/pm/closechat/pm/loadchat/pm/superchatchat/removechat/remove_allchat/sendchat/topicgame/annulgame/cancelgame/chatgame/chat/removegame/clear_delayed_resigngame/conditional_moves/setgame/connectgame/delayed_resigngame/disconnectgame/latencygame/loggame/movegame/pausegame/prevent_escapinggame/prevent_stallinggame/removed_stones/acceptgame/removed_stones/rejectgame/removed_stones/setgame/resigngame/resumegame/timed_outgame/undo/acceptgame/undo/cancelgame/undo/requestgamelist/count/subscribegamelist/count/unsubscribegamelist/queryhostinfoitcnet/pingnotification/deleteremote_storage/removeremote_storage/setremote_storage/syncreview/appendreview/chatreview/chat/removereview/connectreview/disconnectseek_graph/connectseek_graph/disconnectstats/onlineui-pushes/subscribeui-pushes/unsubscribeuser/monitor
            \ No newline at end of file +

            Returns number

            ui-pushes/subscribe

            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

            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

            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

            Settings

            Member Visibility

            Theme

            On This Page

            authenticateautomatch/cancelautomatch/find_matchautomatch/listbot/configbot/statuschallenge/keepalivechat/joinchat/partchat/pmchat/pm/closechat/pm/loadchat/pm/superchatchat/removechat/remove_allchat/sendchat/topicgame/annulgame/cancelgame/chatgame/chat/removegame/clear_delayed_resigngame/conditional_moves/setgame/connectgame/delayed_resigngame/disconnectgame/latencygame/loggame/movegame/pausegame/prevent_escapinggame/prevent_stallinggame/removed_stones/acceptgame/removed_stones/rejectgame/removed_stones/setgame/resigngame/resumegame/timed_outgame/undo/acceptgame/undo/cancelgame/undo/requestgamelist/count/subscribegamelist/count/unsubscribegamelist/queryhostinfoitcnet/pingnotification/deleteremote_storage/removeremote_storage/setremote_storage/syncreview/appendreview/chatreview/chat/removereview/connectreview/disconnectseek_graph/connectseek_graph/disconnectstats/onlineui-pushes/subscribeui-pushes/unsubscribeuser/monitor
            \ No newline at end of file diff --git a/docs/interfaces/protocol.ClientToServerBase.html b/docs/interfaces/protocol.ClientToServerBase.html index 9e5ff785..0ebbdfa1 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

            authenticate +
            interface ClientToServerBase {
                authenticate: ((data) => undefined | {
                    id: number;
                    username: string;
                });
                net/ping: ((data) => void);
            }

            Hierarchy (view full)

            Properties

            authenticate net/ping

            Properties

            authenticate

            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

            net/ping: ((data) => void)

            Sends a ping to the server. This message should be +

            Returns undefined | {
                id: number;
                username: string;
            }

            net/ping

            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

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

            Settings

            Member Visibility

            Theme

            On This Page

            authenticatenet/ping
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            authenticatenet/ping
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatAnalysisMessage.html b/docs/interfaces/protocol.GameChatAnalysisMessage.html index 14198f96..36675607 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? engine_analysis? from? marks? @@ -6,4 +6,4 @@ name? pen_marks? type -

            Properties

            Optional branch_move

            branch_move?: number

            Optional engine_analysis

            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

            Optional from

            from?: number

            Optional marks

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

            Type declaration

            • [mark: string]: string

            Optional moves

            moves?: string

            Optional name

            name?: string

            Optional pen_marks

            pen_marks?: unknown[]

            type

            type: "analysis"

            Settings

            Member Visibility

            Theme

            On This Page

            branch_moveengine_analysisfrommarksmovesnamepen_markstype
            \ No newline at end of file +

            Properties

            Optional branch_move

            branch_move?: number

            Optional engine_analysis

            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

            Optional from

            from?: number

            Optional marks

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

            Type declaration

            • [mark: string]: string

            Optional moves

            moves?: string

            Optional name

            name?: string

            Optional pen_marks

            pen_marks?: unknown[]

            type

            type: "analysis"

            Settings

            Member Visibility

            Theme

            On This Page

            branch_moveengine_analysisfrommarksmovesnamepen_markstype
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatLine.html b/docs/interfaces/protocol.GameChatLine.html index 4e3fd9d6..57cdc37f 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

            body channel chat_id date @@ -7,4 +7,4 @@ moves? player_id username? -

            Properties

            body

            body: string | AnalysisComment | ReviewComment

            channel

            channel: string

            chat_id

            chat_id: string

            date

            date: number

            Optional from

            from?: number

            move_number

            move_number: number

            Optional moves

            moves?: string

            player_id

            player_id: number

            Optional username

            username?: string

            Settings

            Member Visibility

            Theme

            On This Page

            bodychannelchat_iddatefrommove_numbermovesplayer_idusername
            \ No newline at end of file +

            Properties

            body

            body: string | AnalysisComment | ReviewComment

            channel

            channel: string

            chat_id

            chat_id: string

            date

            date: number

            Optional from

            from?: number

            move_number

            move_number: number

            Optional moves

            moves?: string

            player_id

            player_id: number

            Optional username

            username?: string

            Settings

            Member Visibility

            Theme

            On This Page

            bodychannelchat_iddatefrommove_numbermovesplayer_idusername
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatMessage.html b/docs/interfaces/protocol.GameChatMessage.html index d8104342..eb30d3c8 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

            channel line -

            Properties

            channel

            channel: "main" | "malkovich" | "hidden" | "personal" | "spectator" | "shadowban"

            line

            line: GameChatLine

            Settings

            Member Visibility

            Theme

            On This Page

            channelline
            \ No newline at end of file +

            Properties

            channel

            channel: "main" | "malkovich" | "hidden" | "personal" | "spectator" | "shadowban"

            line

            line: GameChatLine

            Settings

            Member Visibility

            Theme

            On This Page

            channelline
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatReviewMessage.html b/docs/interfaces/protocol.GameChatReviewMessage.html index 4e2ba13a..4969b15b 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

            review_id type -

            Properties

            review_id

            review_id: number

            type

            type: "review"

            Settings

            Member Visibility

            Theme

            On This Page

            review_idtype
            \ No newline at end of file +

            Properties

            review_id

            review_id: number

            type

            type: "review"

            Settings

            Member Visibility

            Theme

            On This Page

            review_idtype
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameChatTranslatedMessage.html b/docs/interfaces/protocol.GameChatTranslatedMessage.html index 5f49a07d..eb569a4a 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

            en type -

            Properties

            en

            en: string

            type

            type: "translated"

            Settings

            Member Visibility

            Theme

            On This Page

            entype
            \ No newline at end of file +

            Properties

            en

            en: string

            type

            type: "translated"

            Settings

            Member Visibility

            Theme

            On This Page

            entype
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameClock.html b/docs/interfaces/protocol.GameClock.html index 28550c1e..21e97080 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 black_time? current_player expiration @@ -15,4 +15,4 @@ title white_player_id white_time? -

            Properties

            black_player_id

            black_player_id: number

            Optional black_time

            black_time?: ClockTime

            current_player

            current_player: number

            expiration

            expiration: number

            Optional expiration_delta

            expiration_delta?: number

            game_id

            game_id: number

            last_move

            last_move: number

            Optional now

            now?: number

            Optional pause

            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

            Optional pause_delta

            pause_delta?: number

            Optional paused_since

            paused_since?: number

            Optional start_mode

            start_mode?: boolean

            Optional stone_removal_expiration

            stone_removal_expiration?: number

            Optional stone_removal_mode

            stone_removal_mode?: boolean

            title

            title: string

            white_player_id

            white_player_id: number

            Optional white_time

            white_time?: ClockTime

            Settings

            Member Visibility

            Theme

            On This Page

            black_player_idblack_timecurrent_playerexpirationexpiration_deltagame_idlast_movenowpausepause_deltapaused_sincestart_modestone_removal_expirationstone_removal_modetitlewhite_player_idwhite_time
            \ No newline at end of file +

            Properties

            black_player_id

            black_player_id: number

            Optional black_time

            black_time?: ClockTime

            current_player

            current_player: number

            expiration

            expiration: number

            Optional expiration_delta

            expiration_delta?: number

            game_id

            game_id: number

            last_move

            last_move: number

            Optional now

            now?: number

            Optional pause

            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

            Optional pause_delta

            pause_delta?: number

            Optional paused_since

            paused_since?: number

            Optional start_mode

            start_mode?: boolean

            Optional stone_removal_expiration

            stone_removal_expiration?: number

            Optional stone_removal_mode

            stone_removal_mode?: boolean

            title

            title: string

            white_player_id

            white_player_id: number

            Optional white_time

            white_time?: ClockTime

            Settings

            Member Visibility

            Theme

            On This Page

            black_player_idblack_timecurrent_playerexpirationexpiration_deltagame_idlast_movenowpausepause_deltapaused_sincestart_modestone_removal_expirationstone_removal_modetitlewhite_player_idwhite_time
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameListEntry.html b/docs/interfaces/protocol.GameListEntry.html index 6823d89f..07d67ca3 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? black bot_game? clock_expiration @@ -30,4 +30,4 @@ tournament_id? white width -

            Properties

            Optional _participants

            _participants?: number[]

            black

            black: GameListPlayer

            Optional bot_game

            bot_game?: boolean

            clock_expiration

            clock_expiration: number

            dropped_player

            dropped_player: number

            Optional group_ids

            group_ids?: number[]

            Optional group_ids_map

            group_ids_map?: {
                [id: string]: boolean;
            }

            Type declaration

            • [id: string]: boolean

            Optional handicap

            handicap?: number

            height

            height: number

            id

            id: number

            Optional in_beginning

            in_beginning?: boolean

            Optional in_end

            in_end?: boolean

            Optional in_middle

            in_middle?: boolean

            Optional kidsgo_game

            kidsgo_game?: boolean

            Optional komi

            komi?: number

            Optional ladder_id

            ladder_id?: number

            Optional malkovich_present

            malkovich_present?: boolean

            move_number

            move_number: number

            name

            name: string

            paused

            paused: boolean

            phase

            phase: string

            player_to_move

            player_to_move: number

            private

            private: boolean

            Optional ranked

            ranked?: boolean

            rengo

            rengo: boolean

            rengo_casual_mode

            rengo_casual_mode: boolean

            rengo_teams

            rengo_teams: {
                black: User[];
                white: User[];
            }

            Type declaration

            Optional socket_id

            socket_id?: any

            time_per_move

            time_per_move: number

            Optional tournament_id

            tournament_id?: number

            white

            white: GameListPlayer

            width

            width: number

            Settings

            Member Visibility

            Theme

            On This Page

            _participantsblackbot_gameclock_expirationdropped_playergroup_idsgroup_ids_maphandicapheightidin_beginningin_endin_middlekidsgo_gamekomiladder_idmalkovich_presentmove_numbernamepausedphaseplayer_to_moveprivaterankedrengorengo_casual_moderengo_teamssocket_idtime_per_movetournament_idwhitewidth
            \ No newline at end of file +

            Properties

            Optional _participants

            _participants?: number[]

            black

            black: GameListPlayer

            Optional bot_game

            bot_game?: boolean

            clock_expiration

            clock_expiration: number

            dropped_player

            dropped_player: number

            Optional group_ids

            group_ids?: number[]

            Optional group_ids_map

            group_ids_map?: {
                [id: string]: boolean;
            }

            Type declaration

            • [id: string]: boolean

            Optional handicap

            handicap?: number

            height

            height: number

            id

            id: number

            Optional in_beginning

            in_beginning?: boolean

            Optional in_end

            in_end?: boolean

            Optional in_middle

            in_middle?: boolean

            Optional kidsgo_game

            kidsgo_game?: boolean

            Optional komi

            komi?: number

            Optional ladder_id

            ladder_id?: number

            Optional malkovich_present

            malkovich_present?: boolean

            move_number

            move_number: number

            name

            name: string

            paused

            paused: boolean

            phase

            phase: string

            player_to_move

            player_to_move: number

            private

            private: boolean

            Optional ranked

            ranked?: boolean

            rengo

            rengo: boolean

            rengo_casual_mode

            rengo_casual_mode: boolean

            rengo_teams

            rengo_teams: {
                black: User[];
                white: User[];
            }

            Type declaration

            Optional socket_id

            socket_id?: any

            time_per_move

            time_per_move: number

            Optional tournament_id

            tournament_id?: number

            white

            white: GameListPlayer

            width

            width: number

            Settings

            Member Visibility

            Theme

            On This Page

            _participantsblackbot_gameclock_expirationdropped_playergroup_idsgroup_ids_maphandicapheightidin_beginningin_endin_middlekidsgo_gamekomiladder_idmalkovich_presentmove_numbernamepausedphaseplayer_to_moveprivaterankedrengorengo_casual_moderengo_teamssocket_idtime_per_movetournament_idwhitewidth
            \ No newline at end of file diff --git a/docs/interfaces/protocol.GameListWhere.html b/docs/interfaces/protocol.GameListWhere.html index 01f499d1..665aa031 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

            hide_13x13? +
            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? hide_19x19? hide_9x9? hide_beginning? @@ -19,4 +19,4 @@ players? rengo_only? tournament_id? -

            Properties

            Optional hide_13x13

            hide_13x13?: boolean

            Optional hide_19x19

            hide_19x19?: boolean

            Optional hide_9x9

            hide_9x9?: boolean

            Optional hide_beginning

            hide_beginning?: boolean

            Optional hide_bot_games

            hide_bot_games?: boolean

            Optional hide_end

            hide_end?: boolean

            Optional hide_even

            hide_even?: boolean

            Optional hide_handicap

            hide_handicap?: boolean

            Optional hide_ladder

            hide_ladder?: boolean

            Optional hide_middle

            hide_middle?: boolean

            Optional hide_open

            hide_open?: boolean

            Optional hide_other

            hide_other?: boolean

            Optional hide_ranked

            hide_ranked?: boolean

            Optional hide_tournament

            hide_tournament?: boolean

            Optional hide_unranked

            hide_unranked?: boolean

            Optional ladder_id

            ladder_id?: number

            Optional malk_only

            malk_only?: boolean

            Optional players

            players?: number[]

            Optional rengo_only

            rengo_only?: boolean

            Optional tournament_id

            tournament_id?: number

            Settings

            Member Visibility

            Theme

            On This Page

            hide_13x13hide_19x19hide_9x9hide_beginninghide_bot_gameshide_endhide_evenhide_handicaphide_ladderhide_middlehide_openhide_otherhide_rankedhide_tournamenthide_unrankedladder_idmalk_onlyplayersrengo_onlytournament_id
            \ No newline at end of file +

            Properties

            Optional hide_13x13

            hide_13x13?: boolean

            Optional hide_19x19

            hide_19x19?: boolean

            Optional hide_9x9

            hide_9x9?: boolean

            Optional hide_beginning

            hide_beginning?: boolean

            Optional hide_bot_games

            hide_bot_games?: boolean

            Optional hide_end

            hide_end?: boolean

            Optional hide_even

            hide_even?: boolean

            Optional hide_handicap

            hide_handicap?: boolean

            Optional hide_ladder

            hide_ladder?: boolean

            Optional hide_middle

            hide_middle?: boolean

            Optional hide_open

            hide_open?: boolean

            Optional hide_other

            hide_other?: boolean

            Optional hide_ranked

            hide_ranked?: boolean

            Optional hide_tournament

            hide_tournament?: boolean

            Optional hide_unranked

            hide_unranked?: boolean

            Optional ladder_id

            ladder_id?: number

            Optional malk_only

            malk_only?: boolean

            Optional players

            players?: number[]

            Optional rengo_only

            rengo_only?: boolean

            Optional tournament_id

            tournament_id?: number

            Settings

            Member Visibility

            Theme

            On This Page

            hide_13x13hide_19x19hide_9x9hide_beginninghide_bot_gameshide_endhide_evenhide_handicaphide_ladderhide_middlehide_openhide_otherhide_rankedhide_tournamenthide_unrankedladder_idmalk_onlyplayersrengo_onlytournament_id
            \ No newline at end of file diff --git a/docs/interfaces/protocol.Glicko2.html b/docs/interfaces/protocol.Glicko2.html index b2d5292e..c5fd82ff 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 games_played? rating volatility -

            Properties

            deviation

            deviation: number

            Optional games_played

            games_played?: number

            rating

            rating: number

            volatility

            volatility: number

            Settings

            Member Visibility

            Theme

            On This Page

            deviationgames_playedratingvolatility
            \ No newline at end of file +

            Properties

            deviation

            deviation: number

            Optional games_played

            games_played?: number

            rating

            rating: number

            volatility

            volatility: number

            Settings

            Member Visibility

            Theme

            On This Page

            deviationgames_playedratingvolatility
            \ No newline at end of file diff --git a/docs/interfaces/protocol.SeekgraphChallengeMessage.html b/docs/interfaces/protocol.SeekgraphChallengeMessage.html index fbe69b5f..704a2e5f 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 challenger_color disable_analysis game_id @@ -28,32 +28,32 @@ uuid width

            Properties

            challenge_id

            challenge_id: number

            The ID of the challenge

            -

            challenger_color

            challenger_color: "black" | "white" | "automatic"

            Color the accepting player will be

            -

            disable_analysis

            disable_analysis: boolean

            If analysis is disabled

            -

            game_id

            game_id: number

            The game ID

            -

            handicap

            handicap: null | number

            The game handicap

            -

            height

            height: number

            Board height

            -

            invite_only

            invite_only: boolean

            If the game is only joinable by invitation

            -

            komi

            komi: null | number

            Komi

            -

            max_rank

            max_rank: number

            Maximum rank allowed to accept the game

            -

            min_rank

            min_rank: number

            Minimum rank allowed to accept the game

            -

            name

            name: string

            Game name

            -

            professional

            professional: boolean

            If they are a professional player

            -

            ranked

            ranked: boolean

            If the game is ranked

            -

            ranking

            ranking: number

            Their ranking *

            -

            rengo

            rengo: boolean

            If it's a rengo game

            -

            rengo_auto_start

            rengo_auto_start: boolean

            If the rengo game will automatically start

            -

            rengo_black_team

            rengo_black_team: number[]

            Player ids of the players on the Black team

            -

            rengo_casual_mode

            rengo_casual_mode: boolean

            If the game is a casual rengo game

            -

            rengo_nominees

            rengo_nominees: number[]

            Player ids of people that have been nominated to play

            -

            rengo_participants

            rengo_participants: number[]

            All player ids involved in the game

            -

            rengo_white_team

            rengo_white_team: number[]

            Player ids of the players on the White team

            -

            rules

            rules: string

            Rules being used

            -

            time_control

            time_control: string

            Time control system type

            -

            time_control_parameters

            time_control_parameters: JGOFTimeControl

            Time control parameters

            -

            time_per_move

            time_per_move: number

            Average time per move

            -

            user_id

            user_id: number

            User id of the player who is looking for a game

            -

            username

            username: string

            Username of the player looking for the game

            -

            uuid

            uuid: string

            A UUID for the invitation

            -

            width

            width: number

            Board width

            -

            Settings

            Member Visibility

            Theme

            On This Page

            challenge_idchallenger_colordisable_analysisgame_idhandicapheightinvite_onlykomimax_rankmin_ranknameprofessionalrankedrankingrengorengo_auto_startrengo_black_teamrengo_casual_moderengo_nomineesrengo_participantsrengo_white_teamrulestime_controltime_control_parameterstime_per_moveuser_idusernameuuidwidth
            \ No newline at end of file +

            challenger_color

            challenger_color: "black" | "white" | "automatic"

            Color the accepting player will be

            +

            disable_analysis

            disable_analysis: boolean

            If analysis is disabled

            +

            game_id

            game_id: number

            The game ID

            +

            handicap

            handicap: null | number

            The game handicap

            +

            height

            height: number

            Board height

            +

            invite_only

            invite_only: boolean

            If the game is only joinable by invitation

            +

            komi

            komi: null | number

            Komi

            +

            max_rank

            max_rank: number

            Maximum rank allowed to accept the game

            +

            min_rank

            min_rank: number

            Minimum rank allowed to accept the game

            +

            name

            name: string

            Game name

            +

            professional

            professional: boolean

            If they are a professional player

            +

            ranked

            ranked: boolean

            If the game is ranked

            +

            ranking

            ranking: number

            Their ranking *

            +

            rengo

            rengo: boolean

            If it's a rengo game

            +

            rengo_auto_start

            rengo_auto_start: boolean

            If the rengo game will automatically start

            +

            rengo_black_team

            rengo_black_team: number[]

            Player ids of the players on the Black team

            +

            rengo_casual_mode

            rengo_casual_mode: boolean

            If the game is a casual rengo game

            +

            rengo_nominees

            rengo_nominees: number[]

            Player ids of people that have been nominated to play

            +

            rengo_participants

            rengo_participants: number[]

            All player ids involved in the game

            +

            rengo_white_team

            rengo_white_team: number[]

            Player ids of the players on the White team

            +

            rules

            rules: string

            Rules being used

            +

            time_control

            time_control: string

            Time control system type

            +

            time_control_parameters

            time_control_parameters: JGOFTimeControl

            Time control parameters

            +

            time_per_move

            time_per_move: number

            Average time per move

            +

            user_id

            user_id: number

            User id of the player who is looking for a game

            +

            username

            username: string

            Username of the player looking for the game

            +

            uuid

            uuid: string

            A UUID for the invitation

            +

            width

            width: number

            Board width

            +

            Settings

            Member Visibility

            Theme

            On This Page

            challenge_idchallenger_colordisable_analysisgame_idhandicapheightinvite_onlykomimax_rankmin_ranknameprofessionalrankedrankingrengorengo_auto_startrengo_black_teamrengo_casual_moderengo_nomineesrengo_participantsrengo_white_teamrulestime_controltime_control_parameterstime_per_moveuser_idusernameuuidwidth
            \ No newline at end of file diff --git a/docs/interfaces/protocol.SeekgraphDeleteMessage.html b/docs/interfaces/protocol.SeekgraphDeleteMessage.html index d07c5dd8..3093b901 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

            challenge_id delete

            Properties

            challenge_id

            challenge_id: number

            The ID of the challenge

            -

            delete

            delete: true

            The entry should be deleted if this field exists and is true

            -

            Settings

            Member Visibility

            Theme

            On This Page

            challenge_iddelete
            \ No newline at end of file +

            delete

            delete: true

            The entry should be deleted if this field exists and is true

            +

            Settings

            Member Visibility

            Theme

            On This Page

            challenge_iddelete
            \ No newline at end of file diff --git a/docs/interfaces/protocol.SeekgraphStartedMessage.html b/docs/interfaces/protocol.SeekgraphStartedMessage.html index b0baf278..a1ba41d8 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 challenge_id creator game_id @@ -12,16 +12,16 @@ time_control_parameters white

            Properties

            black

            black: User

            Black player

            -

            challenge_id

            challenge_id: number

            The ID of the challenge

            -

            creator

            creator: number

            Player ID of the creator

            -

            game_id

            game_id: number

            The game id

            -

            Optional game_started

            game_started?: true

            If exists and is true, the game has been started and the entry should be removed from the seek graph

            -

            Optional rengo

            rengo?: true

            Rengo game if true

            -

            Optional rengo_auto_start

            rengo_auto_start?: boolean

            Whether the rengo game with automatically start

            -

            Optional rengo_black_team

            rengo_black_team?: number[]

            Player ids of the players on the Black team

            -

            Optional rengo_casual_mode

            rengo_casual_mode?: boolean

            Wether it's a Casual mode rengo game

            -

            Optional rengo_white_team

            rengo_white_team?: number[]

            Player ids of the players on the White team

            -

            time_control

            time_control: string

            Time control system

            -

            time_control_parameters

            time_control_parameters: JGOFTimeControl

            Time control parameters

            -

            white

            white: User

            White player

            -

            Settings

            Member Visibility

            Theme

            On This Page

            blackchallenge_idcreatorgame_idgame_startedrengorengo_auto_startrengo_black_teamrengo_casual_moderengo_white_teamtime_controltime_control_parameterswhite
            \ No newline at end of file +

            challenge_id

            challenge_id: number

            The ID of the challenge

            +

            creator

            creator: number

            Player ID of the creator

            +

            game_id

            game_id: number

            The game id

            +

            Optional game_started

            game_started?: true

            If exists and is true, the game has been started and the entry should be removed from the seek graph

            +

            Optional rengo

            rengo?: true

            Rengo game if true

            +

            Optional rengo_auto_start

            rengo_auto_start?: boolean

            Whether the rengo game with automatically start

            +

            Optional rengo_black_team

            rengo_black_team?: number[]

            Player ids of the players on the Black team

            +

            Optional rengo_casual_mode

            rengo_casual_mode?: boolean

            Wether it's a Casual mode rengo game

            +

            Optional rengo_white_team

            rengo_white_team?: number[]

            Player ids of the players on the White team

            +

            time_control

            time_control: string

            Time control system

            +

            time_control_parameters

            time_control_parameters: JGOFTimeControl

            Time control parameters

            +

            white

            white: User

            White player

            +

            Settings

            Member Visibility

            Theme

            On This Page

            blackchallenge_idcreatorgame_idgame_startedrengorengo_auto_startrengo_black_teamrengo_casual_moderengo_white_teamtime_controltime_control_parameterswhite
            \ No newline at end of file diff --git a/docs/interfaces/protocol.ServerToClient.html b/docs/interfaces/protocol.ServerToClient.html index 865a2dbf..f1528941 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

            ERROR +

            Properties

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

            Properties

            ERROR

            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

            HUP: (() => void)

            The client should reload

            -

            Type declaration

              • (): void

              • Returns void

            active-bots

            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

            active_game: ((data) => void)

            Message to inform the client of an active game, or a change to an existing game

            -

            Type declaration

            automatch/cancel

            automatch/cancel: ((data) => void)

            An automatch request was canceled

            -

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      uuid: string;
                  }
                  • uuid: string

                Returns void

            automatch/entry

            automatch/entry: ((data) => void)

            An automatch request is active

            -

            Type declaration

            automatch/start

            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

            chat-join: ((data) => void)

            User(s) joined a chat channel

            +

            Type declaration

              • (data): void

              • Parameters

                • data: string | {
                      errcode: string;
                  }

                Returns void

            HUP

            HUP: (() => void)

            The client should reload

            +

            Type declaration

              • (): void

              • Returns void

            active-bots

            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

            active_game: ((data) => void)

            Message to inform the client of an active game, or a change to an existing game

            +

            Type declaration

            automatch/cancel

            automatch/cancel: ((data) => void)

            An automatch request was canceled

            +

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      uuid: string;
                  }
                  • uuid: string

                Returns void

            automatch/entry

            automatch/entry: ((data) => void)

            An automatch request is active

            +

            Type declaration

            automatch/start

            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

            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

            chat-message: ((data) => void)

            Chat message was received

            +

            Returns void

            chat-message

            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

            chat-message-removed: ((data) => void)

            A chat message should be removed from the display

            +

            Returns void

            chat-message-removed

            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

            chat-part: ((data) => void)

            User left a chat channel

            +

            Returns void

            chat-part

            chat-part: ((data) => void)

            User left a chat channel

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      channel: string;
                      user: User;
                  }
                  • channel: string

                    The channel

                  • user: User

                    User that left

                    -

                Returns void

            chat-topic

            chat-topic: ((data) => void)

            Channel topic was updated

            +

            Returns void

            chat-topic

            chat-topic: ((data) => void)

            Channel topic was updated

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      channel: string;
                      country?: string;
                      id: number;
                      professional: boolean;
                      ranking: number;
                      timestamp: number;
                      topic: string;
                      ui_class: string;
                      username: string;
                  }
                  • channel: string

                    The channel

                  • Optional country?: string

                    Country of the user that changed the topic

                  • id: number

                    User id of the user that changed the topic

                    @@ -90,40 +90,40 @@
                  • topic: string

                    The new topic

                  • ui_class: string

                    UI class of the user that changed the topic

                  • username: string

                    Username of the user that changed the topic

                    -

                Returns void

            chat-update-user

            chat-update-user: ((data) => void)

            A user's profile was updated

            +

            Returns void

            chat-update-user

            chat-update-user: ((data) => void)

            A user's profile was updated

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      channel: string;
                      old_player_id: number;
                      user: User;
                  }
                  • channel: string

                    The channel

                  • old_player_id: number

                    Player id entry that was update. This might change in the case of a guest logging in, in this case this will switch from being a negative (guest) id, to some positive id. It is not expected that a non guest id should change using this system.

                  • user: User

                    New user details

                    -

                Returns void

            game/:id/auto_resign

            game/:id/auto_resign: ((data) => void)

            Informs the client the player is scheduled to resign if not cleared

            +

            Returns void

            game/:id/auto_resign

            game/:id/auto_resign: ((data) => void)

            Informs the client the player is scheduled to resign if not cleared

            Type declaration

              • (data): void

              • Parameters

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

                    When the auto resign will happen

                  • game_id: number

                    The game id

                  • player_id: number

                    The player id

                    -

                Returns void

            game/:id/chat

            game/:id/chat: ((data) => void)

            A game chat message

            -

            Type declaration

            game/:id/chat/remove

            game/:id/chat/remove: ((data) => void)

            Game chat lines should be removed

            +

            Returns void

            game/:id/chat

            game/:id/chat: ((data) => void)

            A game chat message

            +

            Type declaration

            game/:id/chat/remove

            game/:id/chat/remove: ((data) => void)

            Game chat lines should be removed

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      chat_ids: string[];
                      game_id: number;
                  }
                  • chat_ids: string[]

                    The chat ids

                  • game_id: number

                    The game id

                    -

                Returns void

            game/:id/clear_auto_resign

            game/:id/clear_auto_resign: ((data) => void)

            The auto resign for the given player has been cleared

            +

            Returns void

            game/:id/clear_auto_resign

            game/:id/clear_auto_resign: ((data) => void)

            The auto resign for the given player has been cleared

            Type declaration

              • (data): void

              • Parameters

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

                    The game id

                  • player_id: number

                    The player id

                    -

                Returns void

            game/:id/clock

            game/:id/clock: ((data) => void)

            Game clock update

            -

            Type declaration

              • (data): void

              • Parameters

                Returns void

            game/:id/conditional_moves

            game/:id/conditional_moves: ((data) => void)

            Update the conditional moves currently active

            +

            Returns void

            game/:id/clock

            game/:id/clock: ((data) => void)

            Game clock update

            +

            Type declaration

              • (data): void

              • Parameters

                Returns void

            game/:id/conditional_moves

            game/:id/conditional_moves: ((data) => void)

            Update the conditional moves currently active

            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/:id/error

            game/:id/error: ((data) => void)

            Error that should be displayed to the user

            -

            Type declaration

              • (data): void

              • Parameters

                • data: string

                Returns void

            game/:id/gamedata

            game/:id/gamedata: ((data) => void)

            Update the entire game state

            -

            Type declaration

            game/:id/latency

            game/:id/latency: ((data) => void)

            Update latency information for a player

            +

            Returns void

            game/:id/error

            game/:id/error: ((data) => void)

            Error that should be displayed to the user

            +

            Type declaration

              • (data): void

              • Parameters

                • data: string

                Returns void

            game/:id/gamedata

            game/:id/gamedata: ((data) => void)

            Update the entire game state

            +

            Type declaration

            game/:id/latency

            game/:id/latency: ((data) => void)

            Update latency information for a player

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      game_id: number;
                      latency: number;
                      player_id: number;
                  }
                  • game_id: number

                    The game id

                  • latency: number

                    The latency in milliseconds

                  • player_id: number

                    The player id

                    -

                Returns void

            game/:id/phase

            game/:id/phase: ((data) => void)

            The phase has changed for the game

            -

            Type declaration

              • (data): void

              • Parameters

                • data: "play" | "stone removal" | "finished"

                Returns void

            game/:id/removed_stones

            game/:id/removed_stones: ((data) => void)

            Update the state of the stone removal phase

            -

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      all_removed: string;
                      removed: boolean;
                      stones: string;
                  } | {
                      strict_seki_mode: boolean;
                  }

                Returns void

            game/:id/removed_stones_accepted

            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

            game/:id/phase: ((data) => void)

            The phase has changed for the game

            +

            Type declaration

              • (data): void

              • Parameters

                • data: "play" | "stone removal" | "finished"

                Returns void

            game/:id/removed_stones

            game/:id/removed_stones: ((data) => void)

            Update the state of the stone removal phase

            +

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      all_removed: string;
                      removed: boolean;
                      stones: string;
                  } | {
                      strict_seki_mode: boolean;
                  }

                Returns void

            game/:id/removed_stones_accepted

            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

              • (data): void

              • Parameters

                • data: {
                      end_time: number;
                      outcome: string;
                      phase: "finished";
                      player_id: number;
                      players: {
                          black: User | {
                              accepted_stones: string;
                              accepted_strict_seki_mode: boolean;
                          };
                          white: User | {
                              accepted_stones: string;
                              accepted_strict_seki_mode: boolean;
                          };
                      };
                      score: Score;
                      stones: string;
                      strict_seki_mode: boolean;
                      winner: number;
                  }
                  • end_time: number

                    Timestamp in ms

                    @@ -135,26 +135,26 @@
                  • stones: string
                  • strict_seki_mode: boolean

                    True if Japanese strict seki mode was true. This will probably always be false and may be removed in the future.

                  • winner: number

                    Player id of the winner

                    -

                Returns void

            game/:id/reset-chats

            game/:id/reset-chats: (() => void)

            The chat log should be reset.

            -

            Type declaration

              • (): void

              • Returns void

            game/:id/stalling_score_estimate

            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

            game/:id/undo_accepted: ((data) => void)

            Undo move has been accepted, the parameter is the new move number

            -

            Type declaration

              • (data): void

              • Parameters

                • data: number

                Returns void

            game/:id/undo_canceled

            game/:id/undo_canceled: ((data) => void)

            Undo request has been canceled, the parameter is the move number of the original request

            -

            Type declaration

              • (data): void

              • Parameters

                • data: number

                Returns void

            game/:id/undo_requested

            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

              • (data): void

              • Parameters

                • data: number

                Returns void

            gamelist-count

            gamelist-count: ((data) => void)

            Update number of live and correspondence games are currently being +

            Returns void

            game/:id/reset-chats

            game/:id/reset-chats: (() => void)

            The chat log should be reset.

            +

            Type declaration

              • (): void

              • Returns void

            game/:id/stalling_score_estimate

            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

            game/:id/undo_accepted: ((data) => void)

            Undo move has been accepted, the parameter is the new move number

            +

            Type declaration

              • (data): void

              • Parameters

                • data: number

                Returns void

            game/:id/undo_canceled

            game/:id/undo_canceled: ((data) => void)

            Undo request has been canceled, the parameter is the move number of the original request

            +

            Type declaration

              • (data): void

              • Parameters

                • data: number

                Returns void

            game/:id/undo_requested

            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

              • (data): void

              • Parameters

                • data: number

                Returns void

            gamelist-count

            gamelist-count: ((data) => void)

            Update number of live and correspondence games are currently being played

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      correspondence: number;
                      live: number;
                  }
                  • correspondence: number

                    Number of correspondence games

                  • live: number

                    Number of live games

                    -

                Returns void

            gamelist-count-:channel

            gamelist-count-:channel: ((data) => void)

            Update number of live and correspondence games are currently being +

            Returns void

            gamelist-count-:channel

            gamelist-count-:channel: ((data) => void)

            Update number of live and correspondence games are currently being played in a particular channel

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      correspondence: number;
                      live: number;
                  }
                  • correspondence: number

                    Number of correspondence games

                  • live: number

                    Number of live games

                    -

                Returns void

            hostinfo

            hostinfo: ((data) => void)

            General host information for the termination server you +

            Returns void

            hostinfo

            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

              • (data): void

              • Parameters

                • data: {
                      clients: number;
                      hostname: string;
                      uptime: number;
                  }
                  • clients: number

                    Number of clients connected, if available

                  • hostname: string

                    The hostname of the server

                  • uptime: number

                    Number of seconds the server has been running

                    -

                Returns void

            incident-report

            incident-report: ((data) => void)

            Incident report update

            -

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      cleared_by_user?: boolean;
                      created: string;
                      id: number;
                      moderator?: User;
                      moderator_note: string;
                      report_type: string;
                      reported_conversation?: string;
                      reported_game?: number;
                      reported_review?: number;
                      reported_user?: User;
                      reporter_note: string;
                      reporter_note_translation: {
                          source_language: string;
                          source_text: string;
                          target_language: string;
                          target_text: string;
                      };
                      reporting_user?: User;
                      source: string;
                      state: "pending" | "claimed" | "resolved";
                      system_note: string;
                      updated: string;
                      url: string;
                      was_helpful: boolean;
                  }
                  • Optional cleared_by_user?: boolean
                  • created: string
                  • id: number
                  • Optional moderator?: User
                  • moderator_note: string
                  • report_type: string
                  • Optional reported_conversation?: string
                  • Optional reported_game?: number
                  • Optional reported_review?: number
                  • Optional reported_user?: User
                  • reporter_note: string
                  • reporter_note_translation: {
                        source_language: string;
                        source_text: string;
                        target_language: string;
                        target_text: string;
                    }
                    • source_language: string
                    • source_text: string
                    • target_language: string
                    • target_text: string
                  • Optional reporting_user?: User
                  • source: string
                  • state: "pending" | "claimed" | "resolved"
                  • system_note: string
                  • updated: string
                  • url: string
                  • was_helpful: boolean

                Returns void

            itc

            itc: ((data) => void)

            "Inter Tab Communication" message. This is a client utility to enable +

            Returns void

            incident-report

            incident-report: ((data) => void)

            Incident report update

            +

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      cleared_by_user?: boolean;
                      created: string;
                      id: number;
                      moderator?: User;
                      moderator_note: string;
                      report_type: string;
                      reported_conversation?: string;
                      reported_game?: number;
                      reported_review?: number;
                      reported_user?: User;
                      reporter_note: string;
                      reporter_note_translation: {
                          source_language: string;
                          source_text: string;
                          target_language: string;
                          target_text: string;
                      };
                      reporting_user?: User;
                      source: string;
                      state: "pending" | "claimed" | "resolved";
                      system_note: string;
                      updated: string;
                      url: string;
                      was_helpful: boolean;
                  }
                  • Optional cleared_by_user?: boolean
                  • created: string
                  • id: number
                  • Optional moderator?: User
                  • moderator_note: string
                  • report_type: string
                  • Optional reported_conversation?: string
                  • Optional reported_game?: number
                  • Optional reported_review?: number
                  • Optional reported_user?: User
                  • reporter_note: string
                  • reporter_note_translation: {
                        source_language: string;
                        source_text: string;
                        target_language: string;
                        target_text: string;
                    }
                    • source_language: string
                    • source_text: string
                    • target_language: string
                    • target_text: string
                  • Optional reporting_user?: User
                  • source: string
                  • state: "pending" | "claimed" | "resolved"
                  • system_note: string
                  • updated: string
                  • url: string
                  • was_helpful: boolean

                Returns void

            itc

            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

              • (data): void

              • Parameters

                • data: {
                      data: any;
                      event: string;
                  }
                  • data: any

                    User defined data

                  • event: string

                    User defined event string

                    -

                Returns void

            net/pong

            net/pong: ((data) => void)

            Pong response from a ping

            +

            Returns void

            net/pong

            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

            notification

            notification: ((data) => void)

            A notification that should be displayed to the user +

            Returns void

            notification

            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

              • (data): void

              • Parameters

                • data: {
                      id: string;
                      type: string;
                      [key: string]: any;
                  }
                  • [key: string]: any

                    There are often more fields here

                  • id: string

                    The notification id

                  • type: string

                    The notification type

                    -

                Returns void

            private-message

            private-message: ((data) => void)

            A private message was received

            +

            Returns void

            private-message

            private-message: ((data) => void)

            A private message was received

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      from: User;
                      message: {
                          i: string;
                          m: string;
                          t: number;
                      };
                      superchat_enabled?: boolean;
                      to: User;
                  }
                  • from: User

                    Who sent the message

                  • message: {
                        i: string;
                        m: string;
                        t: number;
                    }

                    The message received

                    • i: string

                      Message id.

                      @@ -183,7 +183,7 @@ is when a moderator needs to talk with a player and ignoring the moderator is not suitable thing to do.

                    • to: User

                      Your user id

                      -

                Returns void

            private-superchat

            private-superchat: ((data) => void)

            Notify the client that a private message "super chat" has started. A +

            Returns void

            private-superchat

            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

            remote_storage/sync_complete: (() => void)

            Notification that the server has completed sending all remote storage +

            Returns void

            remote_storage/sync_complete

            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

              • (): void

              • Returns void

            remote_storage/update

            remote_storage/update: ((data) => void)

            Updates a key value pair

            +

            Type declaration

              • (): void

              • Returns void

            remote_storage/update

            remote_storage/update: ((data) => void)

            Updates a key value pair

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      key: string;
                      modified: string;
                      replication: RemoteStorageReplication;
                      value: any;
                  }
                  • key: string

                    Key for the k/v pair

                  • modified: string

                    Timestamp of the update

                  • replication: RemoteStorageReplication

                    Replication mode

                  • value: any

                    Value of of the k/v pair

                    -

                Returns void

            review/:id/full_state

            review/:id/full_state: ((data) => void)

            Replay of the entire full state of the review

            -

            Type declaration

            review/:id/r

            review/:id/r: ((data) => void)

            An incremental modification to the review stream

            -

            Type declaration

            score-estimator-enabled-state

            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

            review/:id/full_state: ((data) => void)

            Replay of the entire full state of the review

            +

            Type declaration

            review/:id/r

            review/:id/r: ((data) => void)

            An incremental modification to the review stream

            +

            Type declaration

            score-estimator-enabled-state

            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

              • (data): void

              • Parameters

                • data: {
                      game_id: number;
                      shared_ip_with_player: boolean;
                  }
                  • game_id: number

                    The game ID

                  • shared_ip_with_player: boolean

                    True if the client shares an IP with one of the players of the game

                    -

                Returns void

            seekgraph/global

            seekgraph/global: ((messages) => void)

            Type declaration

            ui-push

            ui-push: ((data) => void)

            A UI Push notification. The event and data are not well defined here, +

            Returns void

            seekgraph/global

            seekgraph/global: ((messages) => void)

            Type declaration

            ui-push

            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

              • (data): void

              • Parameters

                • data: {
                      data: string;
                      event: string;
                  }
                  • data: string

                    UI Push data

                  • event: string

                    UI Push event

                    -

                Returns void

            user/jwt

            user/jwt: ((jwt) => void)

            Update the user's JWT token

            -

            Type declaration

              • (jwt): void

              • Parameters

                • jwt: string

                Returns void

            user/state

            user/state: ((data) => void)

            Updates whether a user is online or not. Subscribe to these updates for +

            Returns void

            user/jwt

            user/jwt: ((jwt) => void)

            Update the user's JWT token

            +

            Type declaration

              • (jwt): void

              • Parameters

                • jwt: string

                Returns void

            user/state

            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

              • (data): void

              • Parameters

                • data: {
                      [player_id: number]: boolean;
                  }
                  • [player_id: number]: boolean

                Returns void

            user/update

            user/update: ((user) => void)

            Update user information. For other players, this has the standard User +

            Type declaration

              • (data): void

              • Parameters

                • data: {
                      [player_id: number]: boolean;
                  }
                  • [player_id: number]: boolean

                Returns void

            user/update

            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

              • (user): void

              • Parameters

                • user: User & {
                      [extra: string]: any;
                  }

                Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            ERRORHUPactive-botsactive_gameautomatch/cancelautomatch/entryautomatch/startchat-joinchat-messagechat-message-removedchat-partchat-topicchat-update-usergame/:id/auto_resigngame/:id/chatgame/:id/chat/removegame/:id/clear_auto_resigngame/:id/clockgame/:id/conditional_movesgame/:id/errorgame/:id/gamedatagame/:id/latencygame/:id/phasegame/:id/removed_stonesgame/:id/removed_stones_acceptedgame/:id/reset-chatsgame/:id/stalling_score_estimategame/:id/undo_acceptedgame/:id/undo_canceledgame/:id/undo_requestedgamelist-countgamelist-count-:channelhostinfoincident-reportitcnet/pongnotificationprivate-messageprivate-superchatremote_storage/sync_completeremote_storage/updatereview/:id/full_statereview/:id/rscore-estimator-enabled-stateseekgraph/globalui-pushuser/jwtuser/stateuser/update
            \ No newline at end of file +

            Type declaration

            Settings

            Member Visibility

            Theme

            On This Page

            ERRORHUPactive-botsactive_gameautomatch/cancelautomatch/entryautomatch/startchat-joinchat-messagechat-message-removedchat-partchat-topicchat-update-usergame/:id/auto_resigngame/:id/chatgame/:id/chat/removegame/:id/clear_auto_resigngame/:id/clockgame/:id/conditional_movesgame/:id/errorgame/:id/gamedatagame/:id/latencygame/:id/phasegame/:id/removed_stonesgame/:id/removed_stones_acceptedgame/:id/reset-chatsgame/:id/stalling_score_estimategame/:id/undo_acceptedgame/:id/undo_canceledgame/:id/undo_requestedgamelist-countgamelist-count-:channelhostinfoincident-reportitcnet/pongnotificationprivate-messageprivate-superchatremote_storage/sync_completeremote_storage/updatereview/:id/full_statereview/:id/rscore-estimator-enabled-stateseekgraph/globalui-pushuser/jwtuser/stateuser/update
            \ No newline at end of file diff --git a/docs/interfaces/protocol.StallingScoreEstimate.html b/docs/interfaces/protocol.StallingScoreEstimate.html index 8555381f..3273fa8a 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 move_number ownership predicted_winner removed score win_rate -

            Properties

            game_id

            game_id: number

            move_number

            move_number: number

            ownership

            ownership: any[]

            predicted_winner

            predicted_winner: "black" | "white"

            removed

            removed: string

            score

            score: number

            win_rate

            win_rate: number

            Settings

            Member Visibility

            Theme

            On This Page

            game_idmove_numberownershippredicted_winnerremovedscorewin_rate
            \ No newline at end of file +

            Properties

            game_id

            game_id: number

            move_number

            move_number: number

            ownership

            ownership: any[]

            predicted_winner

            predicted_winner: "black" | "white"

            removed

            removed: string

            score

            score: number

            win_rate

            win_rate: number

            Settings

            Member Visibility

            Theme

            On This Page

            game_idmove_numberownershippredicted_winnerremovedscorewin_rate
            \ No newline at end of file diff --git a/docs/interfaces/protocol.User.html b/docs/interfaces/protocol.User.html index 8a05c9d6..d82dbd79 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? id professional? ranking? ratings? ui_class? username -

            Properties

            Optional country

            country?: string

            id

            id: number

            Optional professional

            professional?: boolean

            Optional ranking

            ranking?: number

            Optional ratings

            ratings?: {
                [speed_size: string]: Glicko2;
            }

            Type declaration

            Optional ui_class

            ui_class?: string

            username

            username: string

            Settings

            Member Visibility

            Theme

            On This Page

            countryidprofessionalrankingratingsui_classusername
            \ No newline at end of file +

            Properties

            Optional country

            country?: string

            id

            id: number

            Optional professional

            professional?: boolean

            Optional ranking

            ranking?: number

            Optional ratings

            ratings?: {
                [speed_size: string]: Glicko2;
            }

            Type declaration

            Optional ui_class

            ui_class?: string

            username

            username: string

            Settings

            Member Visibility

            Theme

            On This Page

            countryidprofessionalrankingratingsui_classusername
            \ No newline at end of file diff --git a/docs/interfaces/translate.GobanStrings.html b/docs/interfaces/translate.GobanStrings.html index 0ecd06ea..70eb9867 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 %sh %sm %ss @@ -45,4 +45,4 @@ Worn Glass Your move Your move - opponent passed -

            Properties

            %sd

            %sd: string

            %sh

            %sh: string

            %sm

            %sm: string

            %ss

            %ss: string

            %swk

            %swk: string

            A stone has already been placed here

            A stone has already been placed here: string

            Anime

            Anime: string

            Black

            Black: string

            Black Walnut

            Black Walnut: string

            Black to move

            Black to move: string

            Book

            Book: string

            Bright Kaya

            Bright Kaya: string

            Control passed to %s

            Control passed to %s: string

            Custom

            Custom: string

            Enter the label you want to add to the board

            Enter the label you want to add to the board: string

            Error

            Error: string

            Error submitting move

            Error submitting move: string

            Game Finished

            Game Finished: string

            Glass

            Glass: string

            Granite

            Granite: string

            HNG

            HNG: string

            HNG Night

            HNG Night: string

            Illegal Ko Move

            Illegal Ko Move: string

            Illegal board repetition

            Illegal board repetition: string

            Kaya

            Kaya: string

            Loading...

            Loading...: string

            Move is suicidal

            Move is suicidal: string

            Night

            Night: string

            Night Play

            Night Play: string

            Persimmon

            Persimmon: string

            Plain

            Plain: string

            Processing...

            Processing...: string

            Red Oak

            Red Oak: string

            Review

            Review: string

            Self-capture is not allowed

            Self-capture is not allowed: string

            Shell

            Shell: string

            Slate

            Slate: string

            Stone Removal

            Stone Removal: string

            Stone Removal Phase

            Stone Removal Phase: string

            Submitting...

            Submitting...: string

            Synchronization error, reloading

            Synchronization error, reloading: string

            The game would be repeating with that move, please play somewhere else first

            The game would be repeating with that move, please play somewhere else first: string

            White

            White: string

            White to move

            White to move: string

            Worn Glass

            Worn Glass: string

            Your move

            Your move: string

            Your move - opponent passed

            Your move - opponent passed: string

            Settings

            Member Visibility

            Theme

            On This Page

            %sd%sh%sm%ss%swkA stone has already been placed hereAnimeBlackBlack WalnutBlack to moveBookBright KayaControl passed to %sCustomEnter the label you want to add to the boardErrorError submitting moveGame FinishedGlassGraniteHNGHNG NightIllegal Ko MoveIllegal board repetitionKayaLoading...Move is suicidalNightNight PlayPersimmonPlainProcessing...Red OakReviewSelf-capture is not allowedShellSlateStone RemovalStone Removal PhaseSubmitting...Synchronization error, reloadingThe game would be repeating with that move, please play somewhere else firstWhiteWhite to moveWorn GlassYour moveYour move - opponent passed
            \ No newline at end of file +

            Properties

            %sd

            %sd: string

            %sh

            %sh: string

            %sm

            %sm: string

            %ss

            %ss: string

            %swk

            %swk: string

            A stone has already been placed here

            A stone has already been placed here: string

            Anime

            Anime: string

            Black

            Black: string

            Black Walnut

            Black Walnut: string

            Black to move

            Black to move: string

            Book

            Book: string

            Bright Kaya

            Bright Kaya: string

            Control passed to %s

            Control passed to %s: string

            Custom

            Custom: string

            Enter the label you want to add to the board

            Enter the label you want to add to the board: string

            Error

            Error: string

            Error submitting move

            Error submitting move: string

            Game Finished

            Game Finished: string

            Glass

            Glass: string

            Granite

            Granite: string

            HNG

            HNG: string

            HNG Night

            HNG Night: string

            Illegal Ko Move

            Illegal Ko Move: string

            Illegal board repetition

            Illegal board repetition: string

            Kaya

            Kaya: string

            Loading...

            Loading...: string

            Move is suicidal

            Move is suicidal: string

            Night

            Night: string

            Night Play

            Night Play: string

            Persimmon

            Persimmon: string

            Plain

            Plain: string

            Processing...

            Processing...: string

            Red Oak

            Red Oak: string

            Review

            Review: string

            Self-capture is not allowed

            Self-capture is not allowed: string

            Shell

            Shell: string

            Slate

            Slate: string

            Stone Removal

            Stone Removal: string

            Stone Removal Phase

            Stone Removal Phase: string

            Submitting...

            Submitting...: string

            Synchronization error, reloading

            Synchronization error, reloading: string

            The game would be repeating with that move, please play somewhere else first

            The game would be repeating with that move, please play somewhere else first: string

            White

            White: string

            White to move

            White to move: string

            Worn Glass

            Worn Glass: string

            Your move

            Your move: string

            Your move - opponent passed

            Your move - opponent passed: string

            Settings

            Member Visibility

            Theme

            On This Page

            %sd%sh%sm%ss%swkA stone has already been placed hereAnimeBlackBlack WalnutBlack to moveBookBright KayaControl passed to %sCustomEnter the label you want to add to the boardErrorError submitting moveGame FinishedGlassGraniteHNGHNG NightIllegal Ko MoveIllegal board repetitionKayaLoading...Move is suicidalNightNight PlayPersimmonPlainProcessing...Red OakReviewSelf-capture is not allowedShellSlateStone RemovalStone Removal PhaseSubmitting...Synchronization error, reloadingThe game would be repeating with that move, please play somewhere else firstWhiteWhite to moveWorn GlassYour moveYour move - opponent passed
            \ No newline at end of file diff --git a/docs/modules/protocol.html b/docs/modules/protocol.html index c93694aa..b58b4e27 100644 --- a/docs/modules/protocol.html +++ b/docs/modules/protocol.html @@ -59,7 +59,7 @@ for backwards compatibility.

            -

            Index

            Enumerations

            RemoteStorageReplication +

            Index

            Enumerations

            RemoteStorageReplication

            Interfaces

            AIServerToClient AutomatchPreferences ClientToAIServer diff --git a/docs/modules/translate.html b/docs/modules/translate.html index 3ea9edfa..96c16e5c 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

            GobanStrings

            Functions

            _ interpolate setGobanTranslations diff --git a/docs/types/AdHocPackedMove.html b/docs/types/AdHocPackedMove.html index a470678a..9f33d57a 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;
            }?]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +AdHocPackedMove | goban

            Type alias AdHocPackedMove

            AdHocPackedMove: [number, number, number?, JGOFNumericPlayerColor?, {
                [index: string]: any;
            }?]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/AnalysisSubTool.html b/docs/types/AnalysisSubTool.html index da65b310..f3f49822 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +AnalysisSubTool | goban

            Type alias AnalysisSubTool

            AnalysisSubTool: "black" | "white" | "alternate" | "letters" | "numbers" | string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/AnalysisTool.html b/docs/types/AnalysisTool.html index 3c34dfdf..4bb88c4f 100644 --- a/docs/types/AnalysisTool.html +++ b/docs/types/AnalysisTool.html @@ -1 +1 @@ -AnalysisTool | goban

            Type alias AnalysisTool

            AnalysisTool: "stone" | "draw" | "label" | "score" | "removal"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +AnalysisTool | goban

            Type alias AnalysisTool

            AnalysisTool: "stone" | "draw" | "label" | "score" | "removal"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/BoardTransform.html b/docs/types/BoardTransform.html index 618e6ab0..58845bba 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

            Settings

            Member Visibility

            Theme

            \ 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/ConditionalMoveResponse.html b/docs/types/ConditionalMoveResponse.html index 4c134b83..480de2d5 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

            -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/DataArgument.html b/docs/types/DataArgument.html index abaea45f..e8f2add1 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +DataArgument | goban

            Type alias DataArgument<Entry>

            DataArgument<Entry>: Entry extends ((...args) => void)
                ? A[0]
                : never

            Type Parameters

            • Entry

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanChatLog.html b/docs/types/GobanChatLog.html index f2fd3d8a..04cb8e2f 100644 --- a/docs/types/GobanChatLog.html +++ b/docs/types/GobanChatLog.html @@ -1 +1 @@ -GobanChatLog | goban

            Type alias GobanChatLog

            GobanChatLog: GameChatLine[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanChatLog | goban

            Type alias GobanChatLog

            GobanChatLog: GameChatLine[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanEnginePhase.html b/docs/types/GobanEnginePhase.html index 77bb4eb1..1494b7a7 100644 --- a/docs/types/GobanEnginePhase.html +++ b/docs/types/GobanEnginePhase.html @@ -1 +1 @@ -GobanEnginePhase | goban

            Type alias GobanEnginePhase

            GobanEnginePhase: "play" | "stone removal" | "finished"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanEnginePhase | goban

            Type alias GobanEnginePhase

            GobanEnginePhase: "play" | "stone removal" | "finished"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanEngineRules.html b/docs/types/GobanEngineRules.html index d7b63f06..886906c7 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanEngineRules | goban

            Type alias GobanEngineRules

            GobanEngineRules: "chinese" | "aga" | "japanese" | "korean" | "ing" | "nz"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanEngineSuperKoAlgorithm.html b/docs/types/GobanEngineSuperKoAlgorithm.html index beeed3d4..0d3d45ae 100644 --- a/docs/types/GobanEngineSuperKoAlgorithm.html +++ b/docs/types/GobanEngineSuperKoAlgorithm.html @@ -1 +1 @@ -GobanEngineSuperKoAlgorithm | goban

            Type alias GobanEngineSuperKoAlgorithm

            GobanEngineSuperKoAlgorithm: "psk" | "csk" | "ssk" | "noresult" | "ing"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanEngineSuperKoAlgorithm | goban

            Type alias GobanEngineSuperKoAlgorithm

            GobanEngineSuperKoAlgorithm: "psk" | "csk" | "ssk" | "noresult" | "ing"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanErrorMessageId.html b/docs/types/GobanErrorMessageId.html index a388064b..8e5275c1 100644 --- a/docs/types/GobanErrorMessageId.html +++ b/docs/types/GobanErrorMessageId.html @@ -1 +1 @@ -GobanErrorMessageId | goban

            Type alias GobanErrorMessageId

            GobanErrorMessageId: GobanMoveErrorMessageId | GobanIOErrorMessageId

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanErrorMessageId | goban

            Type alias GobanErrorMessageId

            GobanErrorMessageId: GobanMoveErrorMessageId | GobanIOErrorMessageId

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanErrorMessageObject.html b/docs/types/GobanErrorMessageObject.html index 3734fc95..735c925c 100644 --- a/docs/types/GobanErrorMessageObject.html +++ b/docs/types/GobanErrorMessageObject.html @@ -1 +1 @@ -GobanErrorMessageObject | goban

            Type alias GobanErrorMessageObject

            GobanErrorMessageObject: GobanMoveErrorMessageObject | GobanIOErrorMessageObject

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanErrorMessageObject | goban

            Type alias GobanErrorMessageObject

            GobanErrorMessageObject: GobanMoveErrorMessageObject | GobanIOErrorMessageObject

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanIOErrorMessageId.html b/docs/types/GobanIOErrorMessageId.html index d5d5dd3a..a2ca3300 100644 --- a/docs/types/GobanIOErrorMessageId.html +++ b/docs/types/GobanIOErrorMessageId.html @@ -1 +1 @@ -GobanIOErrorMessageId | goban

            Type alias GobanIOErrorMessageId

            GobanIOErrorMessageId: "failed_to_load_sgf"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanIOErrorMessageId | goban

            Type alias GobanIOErrorMessageId

            GobanIOErrorMessageId: "failed_to_load_sgf"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanModes.html b/docs/types/GobanModes.html index 266c5840..16fdb651 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanModes | goban

            Type alias GobanModes

            GobanModes: "play" | "puzzle" | "score estimation" | "analyze" | "conditional"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanMoveErrorMessageId.html b/docs/types/GobanMoveErrorMessageId.html index 1a7aa870..79b2efcb 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"

            Settings

            Member Visibility

            Theme

            \ 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanMovesArray.html b/docs/types/GobanMovesArray.html index 2a665ab3..3a654ece 100644 --- a/docs/types/GobanMovesArray.html +++ b/docs/types/GobanMovesArray.html @@ -1 +1 @@ -GobanMovesArray | goban

            Type alias GobanMovesArray

            GobanMovesArray: AdHocPackedMove[] | JGOFMove[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanMovesArray | goban

            Type alias GobanMovesArray

            GobanMovesArray: AdHocPackedMove[] | JGOFMove[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanRenderer.html b/docs/types/GobanRenderer.html index 95bd8163..2fa03ae3 100644 --- a/docs/types/GobanRenderer.html +++ b/docs/types/GobanRenderer.html @@ -1 +1 @@ -GobanRenderer | goban

            Type alias GobanRenderer

            GobanRenderer: GobanCanvas | SVGRenderer

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanRenderer | goban

            Type alias GobanRenderer

            GobanRenderer: GobanCanvas | SVGRenderer

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/GobanRendererConfig.html b/docs/types/GobanRendererConfig.html index d13e77ac..66b6fe6b 100644 --- a/docs/types/GobanRendererConfig.html +++ b/docs/types/GobanRendererConfig.html @@ -1 +1 @@ -GobanRendererConfig | goban

            Type alias GobanRendererConfig

            GobanRendererConfig: CanvasRendererGobanConfig | SVGRendererGobanConfig

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GobanRendererConfig | goban

            Type alias GobanRendererConfig

            GobanRendererConfig: CanvasRendererGobanConfig | SVGRendererGobanConfig

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/JGOFTimeControl.html b/docs/types/JGOFTimeControl.html index 0d612bc7..b10a4a10 100644 --- a/docs/types/JGOFTimeControl.html +++ b/docs/types/JGOFTimeControl.html @@ -1 +1 @@ -JGOFTimeControl | goban

            Type alias JGOFTimeControl

            JGOFTimeControl: JGOFFischerTimeControl | JGOFByoYomiTimeControl | JGOFSimpleTimeControl | JGOFCanadianTimeControl | JGOFAbsoluteTimeControl | JGOFNoneTimeControl

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +JGOFTimeControl | goban

            Type alias JGOFTimeControl

            JGOFTimeControl: JGOFFischerTimeControl | JGOFByoYomiTimeControl | JGOFSimpleTimeControl | JGOFCanadianTimeControl | JGOFAbsoluteTimeControl | JGOFNoneTimeControl

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/JGOFTimeControlSpeed.html b/docs/types/JGOFTimeControlSpeed.html index d41a39a1..0ad2e695 100644 --- a/docs/types/JGOFTimeControlSpeed.html +++ b/docs/types/JGOFTimeControlSpeed.html @@ -1 +1 @@ -JGOFTimeControlSpeed | goban

            Type alias JGOFTimeControlSpeed

            JGOFTimeControlSpeed: "blitz" | "live" | "correspondence"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +JGOFTimeControlSpeed | goban

            Type alias JGOFTimeControlSpeed

            JGOFTimeControlSpeed: "blitz" | "live" | "correspondence"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/JGOFTimeControlSystem.html b/docs/types/JGOFTimeControlSystem.html index e0657b07..2cb015c5 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +JGOFTimeControlSystem | goban

            Type alias JGOFTimeControlSystem

            JGOFTimeControlSystem: "fischer" | "byoyomi" | "canadian" | "simple" | "absolute" | "none"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/LabelPosition.html b/docs/types/LabelPosition.html index 04a01248..34676dbe 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +LabelPosition | goban

            Type alias LabelPosition

            LabelPosition: "all" | "none" | "top-left" | "top-right" | "bottom-right" | "bottom-left"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/Matrix.html b/docs/types/Matrix.html index e267af16..eeb0177c 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +Matrix | goban

            Type alias Matrix<T>

            Matrix<T>: T[][]

            Type Parameters

            • T

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/MoveTreePenMarks.html b/docs/types/MoveTreePenMarks.html index 16b1614c..cc06664f 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[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +MoveTreePenMarks | goban

            Type alias MoveTreePenMarks

            MoveTreePenMarks: {
                color: string;
                points: number[];
            }[]

            Type declaration

            • color: string
            • points: number[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/NumberMatrix.html b/docs/types/NumberMatrix.html index bd022d9a..2611c0a1 100644 --- a/docs/types/NumberMatrix.html +++ b/docs/types/NumberMatrix.html @@ -1 +1 @@ -NumberMatrix | goban

            Type alias NumberMatrix

            NumberMatrix: Matrix<number>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +NumberMatrix | goban

            Type alias NumberMatrix

            NumberMatrix: Matrix<number>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/PlayerColor.html b/docs/types/PlayerColor.html index cecc9dbd..76889471 100644 --- a/docs/types/PlayerColor.html +++ b/docs/types/PlayerColor.html @@ -1 +1 @@ -PlayerColor | goban

            Type alias PlayerColor

            PlayerColor: "black" | "white"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +PlayerColor | goban

            Type alias PlayerColor

            PlayerColor: "black" | "white"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/ProtocolResponseType.html b/docs/types/ProtocolResponseType.html index 5749d538..8f92f974 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +ProtocolResponseType | goban

            Type alias ProtocolResponseType<Entry>

            ProtocolResponseType<Entry>: Entry extends ((...args) => infer R)
                ? R
                : never

            Type Parameters

            • Entry

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/PuzzleOpponentMoveMode.html b/docs/types/PuzzleOpponentMoveMode.html index 58b5d721..76533f65 100644 --- a/docs/types/PuzzleOpponentMoveMode.html +++ b/docs/types/PuzzleOpponentMoveMode.html @@ -1 +1 @@ -PuzzleOpponentMoveMode | goban

            Type alias PuzzleOpponentMoveMode

            PuzzleOpponentMoveMode: "manual" | "automatic"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +PuzzleOpponentMoveMode | goban

            Type alias PuzzleOpponentMoveMode

            PuzzleOpponentMoveMode: "manual" | "automatic"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/PuzzlePlacementSetting.html b/docs/types/PuzzlePlacementSetting.html index 34d51cb6..2ea4e205 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"

            Settings

            Member Visibility

            Theme

            \ 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/PuzzlePlayerMoveMode.html b/docs/types/PuzzlePlayerMoveMode.html index 069efe27..65797d8c 100644 --- a/docs/types/PuzzlePlayerMoveMode.html +++ b/docs/types/PuzzlePlayerMoveMode.html @@ -1 +1 @@ -PuzzlePlayerMoveMode | goban

            Type alias PuzzlePlayerMoveMode

            PuzzlePlayerMoveMode: "free" | "fixed"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +PuzzlePlayerMoveMode | goban

            Type alias PuzzlePlayerMoveMode

            PuzzlePlayerMoveMode: "free" | "fixed"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/RawStoneString.html b/docs/types/RawStoneString.html index de9105b6..194771dc 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

            -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/StringMatrix.html b/docs/types/StringMatrix.html index d76a2842..b0cee95d 100644 --- a/docs/types/StringMatrix.html +++ b/docs/types/StringMatrix.html @@ -1 +1 @@ -StringMatrix | goban

            Type alias StringMatrix

            StringMatrix: Matrix<string>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +StringMatrix | goban

            Type alias StringMatrix

            StringMatrix: Matrix<string>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/_internal_.ClockTime.html b/docs/types/_internal_.ClockTime.html index 50440810..65e4a99f 100644 --- a/docs/types/_internal_.ClockTime.html +++ b/docs/types/_internal_.ClockTime.html @@ -1 +1 @@ -ClockTime | goban

            Type alias ClockTime

            ClockTime: NoneClock | SimpleClock | AbsoluteClock | FischerClock | ByoYomiClock | CanadianClock

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +ClockTime | goban

            Type alias ClockTime

            ClockTime: NoneClock | SimpleClock | AbsoluteClock | FischerClock | ByoYomiClock | CanadianClock

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/_internal_.DebugOutput.html b/docs/types/_internal_.DebugOutput.html index 1f9338c3..44cb08b4 100644 --- a/docs/types/_internal_.DebugOutput.html +++ b/docs/types/_internal_.DebugOutput.html @@ -1,2 +1,2 @@ DebugOutput | goban

            Type alias DebugOutput

            DebugOutput: string
            -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/_internal_.LocalEstimator.html b/docs/types/_internal_.LocalEstimator.html index 3133e8fd..c45289a7 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Returns NumberMatrix

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/_internal_.MessageID.html b/docs/types/_internal_.MessageID.html index 73f17df8..8108788d 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"

            Settings

            Member Visibility

            Theme

            \ 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/_internal_.NoneClock.html b/docs/types/_internal_.NoneClock.html index fe731c6f..2b49b3f9 100644 --- a/docs/types/_internal_.NoneClock.html +++ b/docs/types/_internal_.NoneClock.html @@ -1 +1 @@ -NoneClock | goban

            Type alias NoneClock

            NoneClock: undefined

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +NoneClock | goban

            Type alias NoneClock

            NoneClock: undefined

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/_internal_.SimpleClock.html b/docs/types/_internal_.SimpleClock.html index 0d1901b0..7fddc829 100644 --- a/docs/types/_internal_.SimpleClock.html +++ b/docs/types/_internal_.SimpleClock.html @@ -1 +1 @@ -SimpleClock | goban

            Type alias SimpleClock

            SimpleClock: number

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +SimpleClock | goban

            Type alias SimpleClock

            SimpleClock: number

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/_internal_.StoneType.html b/docs/types/_internal_.StoneType.html index f220aa37..9eff1eba 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +StoneType | goban

            Type alias StoneType

            StoneType: {
                shadow: HTMLCanvasElement;
                stone: HTMLCanvasElement;
            }

            Type declaration

            • shadow: HTMLCanvasElement
            • stone: HTMLCanvasElement

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/_internal_.StoneTypeArray.html b/docs/types/_internal_.StoneTypeArray.html index 9c1089f9..2a255ff8 100644 --- a/docs/types/_internal_.StoneTypeArray.html +++ b/docs/types/_internal_.StoneTypeArray.html @@ -1 +1 @@ -StoneTypeArray | goban

            Type alias StoneTypeArray

            StoneTypeArray: StoneType[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +StoneTypeArray | goban

            Type alias StoneTypeArray

            StoneTypeArray: StoneType[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/protocol.AutomatchCondition.html b/docs/types/protocol.AutomatchCondition.html index 8bbe6848..2f9ea4f8 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +AutomatchCondition | goban

            Type alias AutomatchCondition

            AutomatchCondition: "required" | "preferred" | "no-preference"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/protocol.RuleSet.html b/docs/types/protocol.RuleSet.html index 0cfca618..143e8ac0 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +RuleSet | goban

            Type alias RuleSet

            RuleSet: "japanese" | "chinese" | "aga" | "korean" | "nz" | "ing"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/protocol.Size.html b/docs/types/protocol.Size.html index 0c66e2a3..53572c31 100644 --- a/docs/types/protocol.Size.html +++ b/docs/types/protocol.Size.html @@ -1 +1 @@ -Size | goban

            Type alias Size

            Size: "9x9" | "13x13" | "19x19"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +Size | goban

            Type alias Size

            Size: "9x9" | "13x13" | "19x19"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/protocol.Speed.html b/docs/types/protocol.Speed.html index cf1529b2..22179e10 100644 --- a/docs/types/protocol.Speed.html +++ b/docs/types/protocol.Speed.html @@ -1 +1 @@ -Speed | goban

            Type alias Speed

            Speed: "blitz" | "live" | "correspondence"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +Speed | goban

            Type alias Speed

            Speed: "blitz" | "live" | "correspondence"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/AUTOSCORE_TOLERANCE.html b/docs/variables/AUTOSCORE_TOLERANCE.html index e32f56d8..df739c65 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +AUTOSCORE_TOLERANCE | goban

            Variable AUTOSCORE_TOLERANCEConst

            AUTOSCORE_TOLERANCE: 0.1 = 0.1

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/AUTOSCORE_TRIALS.html b/docs/variables/AUTOSCORE_TRIALS.html index 9e2712ea..5f1c69ba 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +AUTOSCORE_TRIALS | goban

            Variable AUTOSCORE_TRIALSConst

            AUTOSCORE_TRIALS: 1000 = 1000

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/GOBAN_FONT.html b/docs/variables/GOBAN_FONT.html index b608ce6f..0d711d1f 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"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +GOBAN_FONT | goban

            Variable GOBAN_FONTConst

            GOBAN_FONT: "Verdana,Arial,sans-serif" = "Verdana,Arial,sans-serif"

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/MARK_TYPES.html b/docs/variables/MARK_TYPES.html index fac35cbd..c4333f51 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)[] = ...

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +MARK_TYPES | goban

            Variable MARK_TYPESConst

            MARK_TYPES: (keyof MarkInterface)[] = ...

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/SCORE_ESTIMATION_TOLERANCE.html b/docs/variables/SCORE_ESTIMATION_TOLERANCE.html index 7fc35d08..e6cd4691 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +SCORE_ESTIMATION_TOLERANCE | goban

            Variable SCORE_ESTIMATION_TOLERANCEConst

            SCORE_ESTIMATION_TOLERANCE: 0.3 = 0.3

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/SCORE_ESTIMATION_TRIALS.html b/docs/variables/SCORE_ESTIMATION_TRIALS.html index f6adbc07..0d2d05b3 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +SCORE_ESTIMATION_TRIALS | goban

            Variable SCORE_ESTIMATION_TRIALSConst

            SCORE_ESTIMATION_TRIALS: 1000 = 1000

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/THEMES.html b/docs/variables/THEMES.html index e3df7112..d5aefd5b 100644 --- a/docs/variables/THEMES.html +++ b/docs/variables/THEMES.html @@ -1 +1 @@ -THEMES | goban

            Variable THEMESConst

            THEMES: ThemesInterface = ...

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +THEMES | goban

            Variable THEMESConst

            THEMES: ThemesInterface = ...

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/THEMES_SORTED.html b/docs/variables/THEMES_SORTED.html index a173b4df..b8094c3f 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

            Settings

            Member Visibility

            Theme

            \ 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/callbacks.html b/docs/variables/callbacks.html index 3e5a5b34..757a5835 100644 --- a/docs/variables/callbacks.html +++ b/docs/variables/callbacks.html @@ -1 +1 @@ -callbacks | goban

            Variable callbacksConst

            callbacks: GobanCallbacks = ...

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +callbacks | goban

            Variable callbacksConst

            callbacks: GobanCallbacks = ...

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/remote_estimate_ownership.html b/docs/variables/remote_estimate_ownership.html index 49415fa6..5e0f4371 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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +remote_estimate_ownership | goban

            Variable remote_estimate_ownership

            remote_estimate_ownership: ((req) => Promise<ScoreEstimateResponse>) | undefined

            Type declaration

            Settings

            Member Visibility

            Theme

            \ No newline at end of file