Class GobanCoreAbstract

Hierarchy

Constructors

constructor

Properties

__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_estimate _submit_move? _title analysis_move_counter auto_scoring_done? bounded_height bounded_width bounds chat_log circle_radius clock_should_be_paused_for_move_submission colored_circles? conditional_path conditional_starting_color conditional_tree config connectToReviewSent? current_cmove? currently_my_cmove destroyed dirty_redraw disconnectedFromGame display_width? done_loading_review dont_draw_last_move double_click_submit draw_bottom_labels draw_left_labels draw_right_labels draw_top_labels edit_color? engine errorHandler game_id game_type getPuzzlePlacementSetting? goban_id heatmap? height highlight_movetree_moves interactive isInPushedAnalysis isPlayerController isPlayerOwner label_character label_mark last_clock? last_emitted_captured_stones last_emitted_clock? last_hover_square? last_move? last_move_radius last_paused_by_player_state last_paused_state last_phase? last_review_message last_sound_played_for_a_stone_placement? last_stone_sound leavePushedAnalysis move_selected? no_display onError? on_game_screen one_click_submit original_square_size pause_control? paused_since? pen_marks player_id post_config_constructor previous_mode puzzle_autoplace_delay restrict_moves_to_movetree review_had_gamedata review_id scoring_mode sendLatencyTimer? sent_timed_out_message shift_key_is_down show_move_numbers show_variation_move_numbers showing_scores socket socket_event_bindings square_size stone_placement_enabled variation_stone_transparency visual_undo_request_indicator width hooks

Accessors

analyze_subtool analyze_tool mode review_controller_id review_owner_id score_estimate submit_move title

Methods

_socket_on acceptRemovedStones acceptUndo annul autoScore cancelGame cancelUndo clearAnalysisDrawing clearMark clearMessage clearPendingResignation clearTransientMark computeMetrics computeNewPlayerClock computeThemeStoneRadius connect debouncedEmitCapturedStones defaultConfig deleteBranch deleteConditionalPath deleteConditionalSegment deleteCustomMark destroy disableDrawing disablePen disableStonePlacement disconnect drawPenMarks drawSquare editPlaceByPrettyCoord enableDrawing enablePen enableStonePlacement followConditionalPath followConditionalSegment getClockDrift getCoordinateDisplaySystem getCurrentConditionalPath getLastReviewMessage getLocation getMarks getNetworkLatency getPlayerRelativeLatency getSelectedThemes getShowMoveNumbers getShowVariationMoveNumbers getState getWidthForSquareSize giveReviewControl hideScores incrementLabelCharacter isAnalysisDisabled isCurrentUserAPlayer isLastOfficialMove jumpToLastOfficialMove load markDirty move_tree_redraw nextSibling pass pauseGame placeByPrettyCoord playMovementSound prevSibling putOrClearLabel redraw rejectRemovedStones requestUndo resign resumeGame saveConditionalMoves scheduleRedrawPenLayer sendChat sendMove sendPendingResignation sendTimedOut set setAnalyzeTool setBounds setColoredCircles setColoredMarks setConditionalTree setCoordinates setCustomMark setEditColor setForRemoval setGameClock setHeatmap setLabelCharacter setLabelCharacterFromMarks setLastOfficialMove setLastReviewMessage setLetterMark setMark setMarkByPrettyCoord setMarkColor setMarks setMode setModeDeferred setMoveTreeContainer setScoringMode setSquareSize setSquareSizeBasedOnDisplayWidth setState setStrictSekiMode setSubmit setSubscriptMark setThemes setTitle setToPreviousMode setTransientMark showFirst showMessage showNext showPrevious showScores syncReviewMove toggleMark updateMoveTree updateOrRedrawMoveTree updatePlayerToMoveTitle updateScoreEstimation updateTitleAndStonePlacement xy2ij getCDNReleaseBase getMoveTreeNumbering getSoundEnabled getSoundVolume setHooks

Constructors

constructor

  • Parameters

    • config: GobanConfig
    • Optional preloaded_data: GobanConfig

    Returns GobanCore

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_estimate

_score_estimate: 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 Optional auto_scoring_done

auto_scoring_done?: boolean = false

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?: ColoredCircle[][]

Protected conditional_path

conditional_path: string = ""

conditional_starting_color

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

conditional_tree

conditional_tree: GoConditionalMove = ...

config

config: GobanConfig

Protected Optional connectToReviewSent

connectToReviewSent?: boolean

Protected Optional current_cmove

current_cmove?: GoConditionalMove

Protected currently_my_cmove

currently_my_cmove: boolean = false

Protected destroyed

destroyed: boolean

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: GoEngine

Protected errorHandler

errorHandler: ((e: Error) => void)

Type declaration

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

Protected goban_id

goban_id: number

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

Private last_paused_by_player_state

last_paused_by_player_state: null | boolean = null

Private last_paused_state

last_paused_state: null | boolean = null

Protected Optional last_phase

last_phase?: GoEnginePhase

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 move_selected

move_selected?: JGOFIntersection

Protected no_display

no_display: boolean

Protected Optional onError

onError?: ((error: Error) => void)

Type declaration

    • (error: 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 | "auto" | ((goban: GobanCore) => 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 post_config_constructor

post_config_constructor: (() => GoEngine)

Type declaration

    • (): GoEngine

    • GobanCore calls some abstract methods as part of the construction process. Because our subsclasses 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 GoEngine

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

Protected Optional sendLatencyTimer

sendLatencyTimer?: Timer

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

Protected stone_placement_enabled

stone_placement_enabled: boolean

variation_stone_transparency

variation_stone_transparency: number

visual_undo_request_indicator

visual_undo_request_indicator: boolean

width

width: number

Static hooks

hooks: GobanHooks = ...

Accessors

analyze_subtool

  • get analyze_subtool(): string

  • Returns string

  • set analyze_subtool(analyze_subtool: string): void

  • Parameters

    • analyze_subtool: string

    Returns void

analyze_tool

mode

review_controller_id

  • get review_controller_id(): undefined | number

  • Returns undefined | number

  • set review_controller_id(review_controller_id: undefined | number): 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: undefined | number): void

  • Parameters

    • review_owner_id: undefined | number

    Returns void

score_estimate

submit_move

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

  • Returns undefined | (() => void)

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

  • Parameters

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

    Returns void

title

  • get title(): string

  • Returns string

  • set title(title: string): void

  • Parameters

    • title: string

    Returns void

Methods

Protected _socket_on

  • _socket_on<KeyT>(event: KeyT, cb: any): void

  • Type Parameters

    Parameters

    • event: KeyT
    • cb: any

    Returns void

acceptRemovedStones

acceptUndo

Protected annul

autoScore

cancelGame

cancelUndo

Abstract clearAnalysisDrawing

clearMark

  • Parameters

    • x: number
    • y: number
    • mark: string | number

    Returns void

Abstract clearMessage

Protected clearPendingResignation

Protected clearTransientMark

  • Parameters

    • x: number
    • y: number
    • mark: string | number

    Returns void

computeMetrics

Protected computeNewPlayerClock

  • Parameters

    Returns JGOFPlayerClockWithTimedOut

Protected computeThemeStoneRadius

Protected connect

debouncedEmitCapturedStones

Protected defaultConfig

deleteBranch

deleteConditionalPath

  • Parameters

    • movepath: string

    Returns void

Protected deleteConditionalSegment

  • Parameters

    • x: number
    • y: number

    Returns void

deleteCustomMark

  • Parameters

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

    Returns void

destroy

Protected Abstract disableDrawing

Abstract disablePen

disableStonePlacement

Protected disconnect

Abstract drawPenMarks

Abstract drawSquare

  • Parameters

    • i: number
    • j: number

    Returns void

editPlaceByPrettyCoord

Protected Abstract enableDrawing

Abstract enablePen

enableStonePlacement

followConditionalPath

  • Parameters

    • movepath: string

    Returns void

Protected followConditionalSegment

  • Parameters

    • x: number
    • y: number

    Returns void

Protected getClockDrift

Protected getCoordinateDisplaySystem

  • Returns "A1" | "1-1"

getCurrentConditionalPath

getLastReviewMessage

Protected getLocation

getMarks

Protected getNetworkLatency

getPlayerRelativeLatency

  • Parameters

    • player_id: number

    Returns number

Protected getSelectedThemes

Protected getShowMoveNumbers

Protected getShowVariationMoveNumbers

  • Returns boolean

Protected getState

Protected getWidthForSquareSize

  • Parameters

    • square_size: number

    Returns number

giveReviewControl

  • Parameters

    • player_id: number

    Returns void

hideScores

Protected incrementLabelCharacter

isAnalysisDisabled

  • Parameters

    • perGameSettingAppliesToNonPlayers: boolean = false

    Returns boolean

isCurrentUserAPlayer

Protected isLastOfficialMove

jumpToLastOfficialMove

load

markDirty

Abstract move_tree_redraw

  • Parameters

    • Optional no_warp: boolean

    Returns void

nextSibling

pass

pauseGame

placeByPrettyCoord

  • Parameters

    • coord: string

    Returns void

Protected playMovementSound

prevSibling

Protected putOrClearLabel

  • Parameters

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

    Returns boolean

Abstract redraw

  • Parameters

    • Optional force_clear: boolean

    Returns void

rejectRemovedStones

requestUndo

resign

resumeGame

saveConditionalMoves

Protected scheduleRedrawPenLayer

sendChat

  • Parameters

    • msg_body: string
    • type: string

    Returns void

Protected sendMove

  • Parameters

    • mv: MoveCommand
    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns boolean

Protected sendPendingResignation

sendTimedOut

set

setAnalyzeTool

setBounds

setColoredCircles

setColoredMarks

  • Parameters

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

    Returns void

setConditionalTree

setCoordinates

setCustomMark

  • Parameters

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

    Returns void

setEditColor

  • Parameters

    • color: "black" | "white"

    Returns void

setForRemoval

  • Parameters

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

    Returns void

setGameClock

setHeatmap

setLabelCharacter

  • Parameters

    • ch: string

    Returns void

Protected setLabelCharacterFromMarks

  • Parameters

    • Optional set_override: "letters" | "numbers"

    Returns void

Protected setLastOfficialMove

setLastReviewMessage

Protected setLetterMark

  • Parameters

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

    Returns void

setMark

  • Parameters

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

    Returns void

setMarkByPrettyCoord

  • Parameters

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

    Returns void

Protected setMarkColor

  • Parameters

    • x: number
    • y: number
    • color: string

    Returns void

setMarks

  • Parameters

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

    Returns void

setMode

  • Parameters

    • mode: GobanModes
    • Optional dont_jump_to_official_move: boolean

    Returns boolean

setModeDeferred

Abstract setMoveTreeContainer

  • Parameters

    • container: any

    Returns void

setScoringMode

setSquareSize

  • Parameters

    • new_ss: number
    • suppress_redraw: boolean = false

    Returns void

setSquareSizeBasedOnDisplayWidth

  • Parameters

    • display_width: number
    • suppress_redraw: boolean = false

    Returns void

Protected setState

  • Parameters

    • state: any

    Returns void

setStrictSekiMode

  • Parameters

    • tf: boolean

    Returns void

Protected setSubmit

  • Parameters

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

        • Returns void

    Returns void

setSubscriptMark

  • Parameters

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

    Returns void

Protected Abstract setThemes

Protected Abstract setTitle

  • Parameters

    • title: string

    Returns void

setToPreviousMode

  • Parameters

    • Optional dont_jump_to_official_move: boolean

    Returns boolean

Protected setTransientMark

  • Parameters

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

    Returns void

showFirst

  • Parameters

    • Optional dont_update_display: boolean

    Returns void

Abstract showMessage

  • Parameters

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

    Returns void

showNext

  • Parameters

    • Optional dont_update_display: boolean

    Returns void

showPrevious

  • Parameters

    • Optional dont_update_display: boolean

    Returns void

showScores

  • Parameters

    • score: Score
    • only_show_territory: boolean = false

    Returns void

syncReviewMove

Protected toggleMark

  • 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

  • Parameters

    • x: number
    • y: number

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

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

Static getCDNReleaseBase

Static getMoveTreeNumbering

Static getSoundEnabled

Static getSoundVolume

Static setHooks

Settings

Member Visibility

Theme

Generated using TypeDoc