Class Goban

Hierarchy

GobanCore
- Goban

Index

Constructors

Constructors

constructor

new Goban(config: GobanConfig, preloaded_data?: JGOF | AdHocFormat): Goban
Parameters
- config: GobanConfig
- Optional preloaded_data: JGOF | AdHocFormat
Returns Goban
Overrides GobanCore.constructor
- Defined in GobanCanvas.ts:123

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` `Optional` auto_scoring_done

auto_scoring_done?: boolean = false

`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?: 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

`Private` ctx

ctx: CanvasRenderingContext2D

`Protected` `Optional` current_cmove

current_cmove?: GoConditionalMove

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

`Private` drawing_enabled

drawing_enabled: boolean = true

`Protected` `Optional` edit_color

edit_color?: "black" | "white"

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

- (): PuzzlePlacementSetting
- Returns PuzzlePlacementSetting

`Protected` goban_id

goban_id: number

`Private` handleShiftKey

handleShiftKey: ((ev: KeyboardEvent) => void)

Type declaration

- (ev: KeyboardEvent): 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

`Protected` last_move_radius

last_move_radius: number

`Private` `Optional` last_pen_position

last_pen_position?: [number, number]

`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

`Private` layer_offset_left

layer_offset_left: number = 0

`Private` layer_offset_top

layer_offset_top: number = 0

`Protected` leavePushedAnalysis

leavePushedAnalysis: (() => void)

Type declaration

- (): void
- Returns void

`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: 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)

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

`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

`Protected` `Optional` sendLatencyTimer

sendLatencyTimer?: Timer

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

`Protected` stone_placement_enabled

stone_placement_enabled: boolean

`Private` theme_black

theme_black: GoTheme

`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: GoTheme

`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: GoTheme

`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_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
Inherited from GobanCore.analyze_subtool
- Defined in GobanCore.ts:447
set analyze_subtool(analyze_subtool: string): void
Parameters
- analyze_subtool: string
Returns void
Inherited from GobanCore.analyze_subtool
- Defined in GobanCore.ts:450

analyze_tool

get analyze_tool(): AnalysisTool
Returns AnalysisTool
Inherited from GobanCore.analyze_tool
- Defined in GobanCore.ts:435
set analyze_tool(analyze_tool: AnalysisTool): void
Parameters
- analyze_tool: AnalysisTool
Returns void
Inherited from GobanCore.analyze_tool
- Defined in GobanCore.ts:438

mode

get mode(): GobanModes
Returns GobanModes
Inherited from GobanCore.mode
- Defined in GobanCore.ts:399
set mode(mode: GobanModes): void
Parameters
- mode: GobanModes
Returns void
Inherited from GobanCore.mode
- Defined in GobanCore.ts:402

review_controller_id

get review_controller_id(): undefined | number
Returns undefined | number
Inherited from GobanCore.review_controller_id
- Defined in GobanCore.ts:490
set review_controller_id(review_controller_id: undefined | number): void
Parameters
- review_controller_id: undefined | number
Returns void
Inherited from GobanCore.review_controller_id
- Defined in GobanCore.ts:493

review_owner_id

get review_owner_id(): undefined | number
Returns undefined | number
Inherited from GobanCore.review_owner_id
- Defined in GobanCore.ts:478
set review_owner_id(review_owner_id: undefined | number): void
Parameters
- review_owner_id: undefined | number
Returns void
Inherited from GobanCore.review_owner_id
- Defined in GobanCore.ts:481

score_estimate

get score_estimate(): null | ScoreEstimator
Returns null | ScoreEstimator
Inherited from GobanCore.score_estimate
- Defined in GobanCore.ts:459
set score_estimate(score_estimate: null | ScoreEstimator): void
Parameters
- score_estimate: null | ScoreEstimator
Returns void
Inherited from GobanCore.score_estimate
- Defined in GobanCore.ts:462

submit_move

get submit_move(): undefined | (() => void)
Returns undefined | (() => void)
Inherited from GobanCore.submit_move
- Defined in GobanCore.ts:423
set submit_move(submit_move: undefined | (() => void)): void
Parameters
- submit_move: undefined | (() => void)
Returns void
Inherited from GobanCore.submit_move
- Defined in GobanCore.ts:426

title

get title(): string
Returns string
Inherited from GobanCore.title
- Defined in GobanCore.ts:411
set title(title: string): void
Parameters
- title: string
Returns void
Inherited from GobanCore.title
- Defined in GobanCore.ts:414

Methods

`Private` __drawSquare

__drawSquare(i: number, j: number): void
Parameters
- i: number
- j: number
Returns void
- Defined in GobanCanvas.ts:1155

`Protected` _socket_on

_socket_on<KeyT>(event: KeyT, cb: any): void
Type Parameters
- KeyT extends keyof GobanSocketEvents
Parameters
- event: KeyT
- cb: any
Returns void
Inherited from GobanCore._socket_on
- Defined in GobanCore.ts:783

acceptRemovedStones

acceptRemovedStones(): void
Returns void
Inherited from GobanCore.acceptRemovedStones
- Defined in GobanCore.ts:2763

acceptUndo

acceptUndo(): void
Returns void
Inherited from GobanCore.acceptUndo
- Defined in GobanCore.ts:2740

`Protected` annul

annul(): void
Returns void
Inherited from GobanCore.annul
- Defined in GobanCore.ts:2713

`Private` attachPenCanvas

attachPenCanvas(): void
Returns void
- Defined in GobanCanvas.ts:275

`Private` attachShadowLayer

attachShadowLayer(): void
Returns void
- Defined in GobanCanvas.ts:233

autoScore

autoScore(): void
Returns void
Inherited from GobanCore.autoScore
- Defined in GobanCore.ts:3121

`Private` bindPointerBindings

bindPointerBindings(canvas: HTMLCanvasElement): void
Parameters
- canvas: HTMLCanvasElement
Returns void
- Defined in GobanCanvas.ts:293

cancelGame

cancelGame(): void
Returns void
Inherited from GobanCore.cancelGame
- Defined in GobanCore.ts:2708

cancelUndo

cancelUndo(): void
Returns void
Inherited from GobanCore.cancelUndo
- Defined in GobanCore.ts:2746

clearAnalysisDrawing

clearAnalysisDrawing(): void
Returns void
Overrides GobanCore.clearAnalysisDrawing
- Defined in GobanCanvas.ts:578

clearMark

clearMark(x: number, y: number, mark: string | number): void
Parameters
- x: number
- y: number
- mark: string | number
Returns void
Inherited from GobanCore.clearMark
- Defined in GobanCore.ts:3077

clearMessage

clearMessage(): void
Returns void
Overrides GobanCore.clearMessage
- Defined in GobanCanvas.ts:2782

`Protected` clearPendingResignation

clearPendingResignation(): void
Returns void
Inherited from GobanCore.clearPendingResignation
- Defined in GobanCore.ts:2703

`Protected` clearTransientMark

clearTransientMark(x: number, y: number, mark: string | number): void
Parameters
- x: number
- y: number
- mark: string | number
Returns void
Inherited from GobanCore.clearTransientMark
- Defined in GobanCore.ts:3093

computeMetrics

computeMetrics(): GobanMetrics
Returns GobanMetrics
Inherited from GobanCore.computeMetrics
- Defined in GobanCore.ts:1955

`Protected` computeNewPlayerClock

computeNewPlayerClock(original_player_clock: Readonly<AdHocPlayerClock>, is_current_player: boolean, time_elapsed: number, time_control: Readonly<JGOFTimeControl>): JGOFPlayerClockWithTimedOut
Parameters
- original_player_clock: Readonly<AdHocPlayerClock>
- is_current_player: boolean
- time_elapsed: number
- time_control: Readonly<JGOFTimeControl>
Returns JGOFPlayerClockWithTimedOut
Inherited from GobanCore.computeNewPlayerClock
- Defined in GobanCore.ts:3648

`Protected` computeThemeStoneRadius

computeThemeStoneRadius(): number
Returns number
Inherited from GobanCore.computeThemeStoneRadius
- Defined in GobanCore.ts:1992

`Protected` connect

connect(server_socket: GobanSocket<ClientToServer, ServerToClient>): void
Parameters
- server_socket: GobanSocket<ClientToServer, ServerToClient>
Returns void
Inherited from GobanCore.connect
- Defined in GobanCore.ts:877

debouncedEmitCapturedStones

debouncedEmitCapturedStones(removed_stones: JGOFIntersection[]): void
Parameters
- removed_stones: JGOFIntersection[]
Returns void
Inherited from GobanCore.debouncedEmitCapturedStones
- Defined in GobanCore.ts:3931

`Protected` defaultConfig

defaultConfig(): any
Returns any
Inherited from GobanCore.defaultConfig
- Defined in GobanCore.ts:850

deleteBranch

deleteBranch(): void
Returns void
Inherited from GobanCore.deleteBranch
- Defined in GobanCore.ts:2449

deleteConditionalPath

deleteConditionalPath(movepath: string): void
Parameters
- movepath: string
Returns void
Inherited from GobanCore.deleteConditionalPath
- Defined in GobanCore.ts:2598

`Protected` deleteConditionalSegment

deleteConditionalSegment(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
Inherited from GobanCore.deleteConditionalSegment
- Defined in GobanCore.ts:2560

deleteCustomMark

deleteCustomMark(x: number, y: number, mark: string, drawSquare?: boolean): void
Parameters
- x: number
- y: number
- mark: string
- Optional drawSquare: boolean
Returns void
Inherited from GobanCore.deleteCustomMark
- Defined in GobanCore.ts:2900

destroy

destroy(): void
Returns void
Overrides GobanCore.destroy
- Defined in GobanCanvas.ts:191

`Private` detachPenCanvas

detachPenCanvas(): void
Returns void
- Defined in GobanCanvas.ts:266

`Private` detachShadowLayer

detachShadowLayer(): void
Returns void
- Defined in GobanCanvas.ts:224

`Protected` disableDrawing

disableDrawing(): void
Returns void
Overrides GobanCore.disableDrawing
- Defined in GobanCanvas.ts:1136

disablePen

disablePen(): void
Returns void
Overrides GobanCore.disablePen
- Defined in GobanCanvas.ts:187

disableStonePlacement

disableStonePlacement(): void
Returns void
Inherited from GobanCore.disableStonePlacement
- Defined in GobanCore.ts:2365

`Protected` disconnect

disconnect(): void
Returns void
Inherited from GobanCore.disconnect
- Defined in GobanCore.ts:1762

drawPenMarks

drawPenMarks(penmarks: MoveTreePenMarks): void
Parameters
- penmarks: MoveTreePenMarks
Returns void
Overrides GobanCore.drawPenMarks
- Defined in GobanCanvas.ts:650

drawSquare

drawSquare(i: number, j: number): void
Parameters
- i: number
- j: number
Returns void
Overrides GobanCore.drawSquare
- Defined in GobanCanvas.ts:1147

`Private` drawingHash

drawingHash(i: number, j: number): string
Parameters
- i: number
- j: number
Returns string
- Defined in GobanCanvas.ts:2122

editPlaceByPrettyCoord

editPlaceByPrettyCoord(coord: string, color: JGOFNumericPlayerColor, isTrunkMove?: boolean): void
Parameters
- coord: string
- color: JGOFNumericPlayerColor
- Optional isTrunkMove: boolean
Returns void
Inherited from GobanCore.editPlaceByPrettyCoord
- Defined in GobanCore.ts:2907

`Protected` enableDrawing

enableDrawing(): void
Returns void
Overrides GobanCore.enableDrawing
- Defined in GobanCanvas.ts:1133

enablePen

enablePen(): void
Returns void
Overrides GobanCore.enablePen
- Defined in GobanCanvas.ts:184

enableStonePlacement

enableStonePlacement(): void
Returns void
Inherited from GobanCore.enableStonePlacement
- Defined in GobanCore.ts:2371

followConditionalPath

followConditionalPath(movepath: string): void
Parameters
- movepath: string
Returns void
Inherited from GobanCore.followConditionalPath
- Defined in GobanCore.ts:2525

`Protected` followConditionalSegment

followConditionalSegment(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
Inherited from GobanCore.followConditionalSegment
- Defined in GobanCore.ts:2533

`Protected` getClockDrift

getClockDrift(): number
Returns number
Inherited from GobanCore.getClockDrift
- Defined in GobanCore.ts:794

`Protected` getCoordinateDisplaySystem

getCoordinateDisplaySystem(): "A1" | "1-1"
Returns "A1" | "1-1"
Inherited from GobanCore.getCoordinateDisplaySystem
- Defined in GobanCore.ts:808

getCurrentConditionalPath

getCurrentConditionalPath(): string
Returns string
Inherited from GobanCore.getCurrentConditionalPath
- Defined in GobanCore.ts:2611

getLastReviewMessage

getLastReviewMessage(): ReviewMessage
Returns ReviewMessage
Inherited from GobanCore.getLastReviewMessage
- Defined in GobanCore.ts:3916

`Protected` getLocation

getLocation(): string
Returns string
Inherited from GobanCore.getLocation
- Defined in GobanCore.ts:863

getMarks

getMarks(x: number, y: number): MarkInterface
Parameters
- x: number
- y: number
Returns MarkInterface
Inherited from GobanCore.getMarks
- Defined in GobanCore.ts:2987

`Protected` getNetworkLatency

getNetworkLatency(): number
Returns number
Inherited from GobanCore.getNetworkLatency
- Defined in GobanCore.ts:801

getPlayerRelativeLatency

getPlayerRelativeLatency(player_id: number): number
Parameters
- player_id: number
Returns number
Inherited from GobanCore.getPlayerRelativeLatency
- Defined in GobanCore.ts:3906

`Protected` getSelectedThemes

getSelectedThemes(): GobanSelectedThemes
Returns GobanSelectedThemes
Inherited from GobanCore.getSelectedThemes
- Defined in GobanCore.ts:869

`Protected` getShowMoveNumbers

getShowMoveNumbers(): boolean
Returns boolean
Inherited from GobanCore.getShowMoveNumbers
- Defined in GobanCore.ts:814

`Protected` getShowVariationMoveNumbers

getShowVariationMoveNumbers(): boolean
Returns boolean
Inherited from GobanCore.getShowVariationMoveNumbers
- Defined in GobanCore.ts:820

`Protected` getState

getState(): {}
Returns {}
Inherited from GobanCore.getState
- Defined in GobanCore.ts:2825

`Protected` getWidthForSquareSize

getWidthForSquareSize(square_size: number): number
Parameters
- square_size: number
Returns number
Inherited from GobanCore.getWidthForSquareSize
- Defined in GobanCore.ts:1816

giveReviewControl

giveReviewControl(player_id: number): void
Parameters
- player_id: number
Returns void
Inherited from GobanCore.giveReviewControl
- Defined in GobanCore.ts:2830

hideScores

hideScores(): void
Returns void
Inherited from GobanCore.hideScores
- Defined in GobanCore.ts:2293

`Protected` incrementLabelCharacter

incrementLabelCharacter(): void
Returns void
Inherited from GobanCore.incrementLabelCharacter
- Defined in GobanCore.ts:3032

isAnalysisDisabled

isAnalysisDisabled(perGameSettingAppliesToNonPlayers?: boolean): boolean
Parameters
- perGameSettingAppliesToNonPlayers: boolean = false
Returns boolean
Inherited from GobanCore.isAnalysisDisabled
- Defined in GobanCore.ts:856

isCurrentUserAPlayer

isCurrentUserAPlayer(): boolean
Returns boolean
Inherited from GobanCore.isCurrentUserAPlayer
- Defined in GobanCore.ts:3307

`Protected` isLastOfficialMove

isLastOfficialMove(): boolean
Returns boolean
Inherited from GobanCore.isLastOfficialMove
- Defined in GobanCore.ts:2477

jumpToLastOfficialMove

jumpToLastOfficialMove(): void
Returns void
Inherited from GobanCore.jumpToLastOfficialMove
- Defined in GobanCore.ts:2460

load

load(config: GobanConfig): GoEngine
Parameters
- config: GobanConfig
Returns GoEngine
Inherited from GobanCore.load
- Defined in GobanCore.ts:2045

markDirty

markDirty(): void
Returns void
Inherited from GobanCore.markDirty
- Defined in GobanCore.ts:1983

move_tree_bindCanvasEvents

move_tree_bindCanvasEvents(canvas: HTMLCanvasElement): void
Parameters
- canvas: HTMLCanvasElement
Returns void
- Defined in GobanCanvas.ts:3208

move_tree_drawIsoBranchTo

move_tree_drawIsoBranchTo(ctx: CanvasRenderingContext2D, from_node: MoveTree, to_node: MoveTree, viewport: ViewPortInterface): void
Parameters
- ctx: CanvasRenderingContext2D
- from_node: MoveTree
- to_node: MoveTree
- viewport: ViewPortInterface
Returns void
- Defined in GobanCanvas.ts:3437

move_tree_drawPath

move_tree_drawPath(ctx: CanvasRenderingContext2D, node: MoveTree, viewport: ViewPortInterface): void
Parameters
- ctx: CanvasRenderingContext2D
- node: MoveTree
- viewport: ViewPortInterface
Returns void
- Defined in GobanCanvas.ts:3404

move_tree_drawRecursive

move_tree_drawRecursive(ctx: CanvasRenderingContext2D, node: MoveTree, active_path_number: number, viewport: ViewPortInterface): void
Parameters
- ctx: CanvasRenderingContext2D
- node: MoveTree
- active_path_number: number
- viewport: ViewPortInterface
Returns void
- Defined in GobanCanvas.ts:3365

move_tree_drawStone

move_tree_drawStone(ctx: CanvasRenderingContext2D, node: MoveTree, active_path_number: number, viewport: ViewPortInterface): void
Parameters
- ctx: CanvasRenderingContext2D
- node: MoveTree
- active_path_number: number
- viewport: ViewPortInterface
Returns void
- Defined in GobanCanvas.ts:3260

move_tree_hilightNode

move_tree_hilightNode(ctx: CanvasRenderingContext2D, node: MoveTree, color: string, viewport: ViewPortInterface): void
Parameters
- ctx: CanvasRenderingContext2D
- node: MoveTree
- color: string
- viewport: ViewPortInterface
Returns void
- Defined in GobanCanvas.ts:3388

move_tree_recursiveDrawPath

move_tree_recursiveDrawPath(ctx: CanvasRenderingContext2D, node: MoveTree, viewport: ViewPortInterface): void
Parameters
- ctx: CanvasRenderingContext2D
- node: MoveTree
- viewport: ViewPortInterface
Returns void
- Defined in GobanCanvas.ts:3496

move_tree_redraw

move_tree_redraw(no_warp?: boolean): void
Parameters
- Optional no_warp: boolean
Returns void
Overrides GobanCore.move_tree_redraw
- Defined in GobanCanvas.ts:3030

nextSibling

nextSibling(): void
Returns void
Inherited from GobanCore.nextSibling
- Defined in GobanCore.ts:2442

`Private` onLabelingMove

onLabelingMove(ev: TouchEvent | MouseEvent): void
Parameters
- ev: TouchEvent | MouseEvent
Returns void
- Defined in GobanCanvas.ts:2988

`Private` onLabelingStart

onLabelingStart(ev: TouchEvent | MouseEvent): void
Parameters
- ev: TouchEvent | MouseEvent
Returns void
- Defined in GobanCanvas.ts:2958

`Private` onMouseMove

onMouseMove(event: TouchEvent | MouseEvent): void
Parameters
- event: TouchEvent | MouseEvent
Returns void
- Defined in GobanCanvas.ts:1088

`Private` onMouseOut

onMouseOut(event: TouchEvent | MouseEvent): void
Parameters
- event: TouchEvent | MouseEvent
Returns void
- Defined in GobanCanvas.ts:1123

`Private` onPenMove

onPenMove(ev: TouchEvent | MouseEvent): void
Parameters
- ev: TouchEvent | MouseEvent
Returns void
- Defined in GobanCanvas.ts:618

`Private` onPenStart

onPenStart(ev: TouchEvent | MouseEvent): void
Parameters
- ev: TouchEvent | MouseEvent
Returns void
- Defined in GobanCanvas.ts:607

`Private` onTap

onTap(event: TouchEvent | MouseEvent, double_tap: boolean, right_click: boolean): void
Parameters
- event: TouchEvent | MouseEvent
- double_tap: boolean
- right_click: boolean
Returns void
- Defined in GobanCanvas.ts:681

pass

pass(): void
Returns void
Inherited from GobanCore.pass
- Defined in GobanCore.ts:2718

pauseGame

pauseGame(): void
Returns void
Inherited from GobanCore.pauseGame
- Defined in GobanCore.ts:2752

`Private` pen2xy

pen2xy(x: number, y: number): [number, number]
Parameters
- x: number
- y: number
Returns [number, number]
- Defined in GobanCanvas.ts:592

placeByPrettyCoord

placeByPrettyCoord(coord: string): void
Parameters
- coord: string
Returns void
Inherited from GobanCore.placeByPrettyCoord
- Defined in GobanCore.ts:2916

`Protected` playMovementSound

playMovementSound(): void
Returns void
Inherited from GobanCore.playMovementSound
- Defined in GobanCore.ts:2786

prevSibling

prevSibling(): void
Returns void
Inherited from GobanCore.prevSibling
- Defined in GobanCore.ts:2435

`Protected` putOrClearLabel

putOrClearLabel(x: number, y: number, mode?: "put" | "clear"): boolean
Parameters
- x: number
- y: number
- Optional mode: "put" | "clear"
Returns boolean
Inherited from GobanCore.putOrClearLabel
- Defined in GobanCore.ts:1866

redraw

redraw(force_clear?: boolean): void
Parameters
- Optional force_clear: boolean
Returns void
Overrides GobanCore.redraw
- Defined in GobanCanvas.ts:2463

rejectRemovedStones

rejectRemovedStones(): void
Returns void
Inherited from GobanCore.rejectRemovedStones
- Defined in GobanCore.ts:2774

requestUndo

requestUndo(): void
Returns void
Inherited from GobanCore.requestUndo
- Defined in GobanCore.ts:2734

resign

resign(): void
Returns void
Inherited from GobanCore.resign
- Defined in GobanCore.ts:2693

resumeGame

resumeGame(): void
Returns void
Inherited from GobanCore.resumeGame
- Defined in GobanCore.ts:2757

saveConditionalMoves

saveConditionalMoves(): void
Returns void
Inherited from GobanCore.saveConditionalMoves
- Defined in GobanCore.ts:2614

`Protected` scheduleRedrawPenLayer

scheduleRedrawPenLayer(): void
Returns void
Inherited from GobanCore.scheduleRedrawPenLayer
- Defined in GobanCore.ts:1780

sendChat

sendChat(msg_body: string, type: string): void
Parameters
- msg_body: string
- type: string
Returns void
Inherited from GobanCore.sendChat
- Defined in GobanCore.ts:1793

`Protected` sendMove

sendMove(mv: MoveCommand, cb?: (() => void)): boolean
Parameters
- mv: MoveCommand
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns boolean
Inherited from GobanCore.sendMove
- Defined in GobanCore.ts:3195

`Protected` sendPendingResignation

sendPendingResignation(): void
Returns void
Inherited from GobanCore.sendPendingResignation
- Defined in GobanCore.ts:2698

sendTimedOut

sendTimedOut(): void
Returns void
Inherited from GobanCore.sendTimedOut
- Defined in GobanCore.ts:3292

set

set(x: number, y: number, player: JGOFNumericPlayerColor): void
Parameters
- x: number
- y: number
- player: JGOFNumericPlayerColor
Returns void
Inherited from GobanCore.set
- Defined in GobanCore.ts:2246

setAnalyzeTool

setAnalyzeTool(tool: AnalysisTool, subtool: string): void
Parameters
- tool: AnalysisTool
- subtool: string
Returns void
Inherited from GobanCore.setAnalyzeTool
- Defined in GobanCore.ts:1848

setBounds

setBounds(bounds: GobanBounds): void
Parameters
- bounds: GobanBounds
Returns void
Inherited from GobanCore.setBounds
- Defined in GobanCore.ts:2015

setByoYomiLabel

setByoYomiLabel(label: string): void
Parameters
- label: string
Returns void
- Defined in GobanCanvas.ts:1139

setColoredCircles

setColoredCircles(circles: ColoredCircle[], dont_draw?: boolean): void
Parameters
- circles: ColoredCircle[]
- Optional dont_draw: boolean
Returns void
Inherited from GobanCore.setColoredCircles
- Defined in GobanCore.ts:2849

setColoredMarks

setColoredMarks(colored_marks: {
    [key: string]: {
        color: string;
        move: string;
    };
}): void
Parameters
- colored_marks: {
      [key: string]: {
          color: string;
          move: string;
      };
  }
  - [key: string]: {
    color: string;
    move: string;
    }
    - color: string
    - move: string
Returns void
Inherited from GobanCore.setColoredMarks
- Defined in GobanCore.ts:2865

setConditionalTree

setConditionalTree(conditional_tree?: GoConditionalMove): void
Parameters
- Optional conditional_tree: GoConditionalMove
Returns void
Inherited from GobanCore.setConditionalTree
- Defined in GobanCore.ts:2514

setCoordinates

setCoordinates(label_position: LabelPosition): void
Parameters
- label_position: LabelPosition
Returns void
Inherited from GobanCore.setCoordinates
- Defined in GobanCore.ts:1930

setCustomMark

setCustomMark(x: number, y: number, mark: string, drawSquare?: boolean): void
Parameters
- x: number
- y: number
- mark: string
- Optional drawSquare: boolean
Returns void
Inherited from GobanCore.setCustomMark
- Defined in GobanCore.ts:2894

setEditColor

setEditColor(color: "black" | "white"): void
Parameters
- color: "black" | "white"
Returns void
Inherited from GobanCore.setEditColor
- Defined in GobanCore.ts:2782

setForRemoval

setForRemoval(x: number, y: number, removed: number, emit_stone_removal_updated?: boolean): void
Parameters
- x: number
- y: number
- removed: number
- emit_stone_removal_updated: boolean = true
Returns void
Inherited from GobanCore.setForRemoval
- Defined in GobanCore.ts:2249

setGameClock

setGameClock(original_clock: null | AdHocClock): void
Parameters
- original_clock: null | AdHocClock
Returns void
Inherited from GobanCore.setGameClock
- Defined in GobanCore.ts:3311

setHeatmap

setHeatmap(heatmap: NumberMatrix, dont_draw?: boolean): void
Parameters
- heatmap: NumberMatrix
- Optional dont_draw: boolean
Returns void
Inherited from GobanCore.setHeatmap
- Defined in GobanCore.ts:2843

setLabelCharacter

setLabelCharacter(ch: string): void
Parameters
- ch: string
Returns void
Inherited from GobanCore.setLabelCharacter
- Defined in GobanCore.ts:3071

`Protected` setLabelCharacterFromMarks

setLabelCharacterFromMarks(set_override?: "letters" | "numbers"): void
Parameters
- Optional set_override: "letters" | "numbers"
Returns void
Inherited from GobanCore.setLabelCharacterFromMarks
- Defined in GobanCore.ts:3040

`Protected` setLastOfficialMove

setLastOfficialMove(): void
Returns void
Inherited from GobanCore.setLastOfficialMove
- Defined in GobanCore.ts:2473

setLastReviewMessage

setLastReviewMessage(m: ReviewMessage): void
Parameters
- m: ReviewMessage
Returns void
Inherited from GobanCore.setLastReviewMessage
- Defined in GobanCore.ts:3919

`Protected` setLetterMark

setLetterMark(x: number, y: number, mark: string, drawSquare?: boolean): void
Parameters
- x: number
- y: number
- mark: string
- Optional drawSquare: boolean
Returns void
Inherited from GobanCore.setLetterMark
- Defined in GobanCore.ts:2882

setMark

setMark(x: number, y: number, mark: string | number, dont_draw?: boolean): void
Parameters
- x: number
- y: number
- mark: string | number
- Optional dont_draw: boolean
Returns void
Inherited from GobanCore.setMark
- Defined in GobanCore.ts:2944

setMarkByPrettyCoord

setMarkByPrettyCoord(coord: string, mark: string | number, dont_draw?: boolean): void
Parameters
- coord: string
- mark: string | number
- Optional dont_draw: boolean
Returns void
Inherited from GobanCore.setMarkByPrettyCoord
- Defined in GobanCore.ts:2939

`Protected` setMarkColor

setMarkColor(x: number, y: number, color: string): void
Parameters
- x: number
- y: number
- color: string
Returns void
Inherited from GobanCore.setMarkColor
- Defined in GobanCore.ts:2878

setMarks

setMarks(marks: {
[mark: string]: string;
}, dont_draw?: boolean): void
Parameters
- marks: {
  [mark: string]: string;
  }
  - [mark: string]: string
- Optional dont_draw: boolean
Returns void
Inherited from GobanCore.setMarks
- Defined in GobanCore.ts:2834

setMode

setMode(mode: GobanModes, dont_jump_to_official_move?: boolean): boolean
Parameters
- mode: GobanModes
- Optional dont_jump_to_official_move: boolean
Returns boolean
Inherited from GobanCore.setMode
- Defined in GobanCore.ts:2631

setModeDeferred

setModeDeferred(mode: GobanModes): void
Parameters
- mode: GobanModes
Returns void
Inherited from GobanCore.setModeDeferred
- Defined in GobanCore.ts:2626

setMoveTreeContainer

setMoveTreeContainer(container: HTMLElement): void
Parameters
- container: HTMLElement
Returns void
Overrides GobanCore.setMoveTreeContainer
- Defined in GobanCanvas.ts:3025

`Private` setPenStyle

setPenStyle(color: string): void
Parameters
- color: string
Returns void
- Defined in GobanCanvas.ts:598

setScoringMode

setScoringMode(tf: boolean, prefer_remote?: boolean): MoveTree
Parameters
- tf: boolean
- prefer_remote: boolean = false
Returns MoveTree
Inherited from GobanCore.setScoringMode
- Defined in GobanCore.ts:3873

setSquareSize

setSquareSize(new_ss: number, suppress_redraw?: boolean): void
Parameters
- new_ss: number
- suppress_redraw: boolean = false
Returns void
Inherited from GobanCore.setSquareSize
- Defined in GobanCore.ts:1897

setSquareSizeBasedOnDisplayWidth

setSquareSizeBasedOnDisplayWidth(display_width: number, suppress_redraw?: boolean): void
Parameters
- display_width: number
- suppress_redraw: boolean = false
Returns void
Inherited from GobanCore.setSquareSizeBasedOnDisplayWidth
- Defined in GobanCore.ts:1904

`Protected` setState

setState(state: any): void
Parameters
- state: any
Returns void
Inherited from GobanCore.setState
- Defined in GobanCore.ts:2814

setStrictSekiMode

setStrictSekiMode(tf: boolean): void
Parameters
- tf: boolean
Returns void
Inherited from GobanCore.setStrictSekiMode
- Defined in GobanCore.ts:1939

`Protected` setSubmit

setSubmit(fn?: (() => void)): void
Parameters
- Optional fn: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from GobanCore.setSubmit
- Defined in GobanCore.ts:1978

setSubscriptMark

setSubscriptMark(x: number, y: number, mark: string, drawSquare?: boolean): void
Parameters
- x: number
- y: number
- mark: string
- drawSquare: boolean = true
Returns void
Inherited from GobanCore.setSubscriptMark
- Defined in GobanCore.ts:2888

`Protected` setThemes

setThemes(themes: GobanSelectedThemes, dont_redraw: boolean): void
Parameters
- themes: GobanSelectedThemes
- dont_redraw: boolean
Returns void
Overrides GobanCore.setThemes
- Defined in GobanCanvas.ts:2794

`Protected` setTitle

setTitle(title: string): void
Parameters
- title: string
Returns void
Overrides GobanCore.setTitle
- Defined in GobanCanvas.ts:3007

setToPreviousMode

setToPreviousMode(dont_jump_to_official_move?: boolean): boolean
Parameters
- Optional dont_jump_to_official_move: boolean
Returns boolean
Inherited from GobanCore.setToPreviousMode
- Defined in GobanCore.ts:2623

`Protected` setTransientMark

setTransientMark(x: number, y: number, mark: string | number, dont_draw?: boolean): void
Parameters
- x: number
- y: number
- mark: string | number
- Optional dont_draw: boolean
Returns void
Inherited from GobanCore.setTransientMark
- Defined in GobanCore.ts:2961

showFirst

showFirst(dont_update_display?: boolean): void
Parameters
- Optional dont_update_display: boolean
Returns void
Inherited from GobanCore.showFirst
- Defined in GobanCore.ts:2381

showMessage

showMessage(message_id_or_error: MessageID, parameters?: {
[key: string]: any;
}, timeout?: number): void
Parameters
- message_id_or_error: MessageID
- Optional parameters: {
  [key: string]: any;
  }
  - [key: string]: any
- timeout: number = 5000
Returns void
Overrides GobanCore.showMessage
- Defined in GobanCanvas.ts:2726

showNext

showNext(dont_update_display?: boolean): void
Parameters
- Optional dont_update_display: boolean
Returns void
Inherited from GobanCore.showNext
- Defined in GobanCore.ts:2409

showPrevious

showPrevious(dont_update_display?: boolean): void
Parameters
- Optional dont_update_display: boolean
Returns void
Inherited from GobanCore.showPrevious
- Defined in GobanCore.ts:2388

showScores

showScores(score: Score, only_show_territory?: boolean): void
Parameters
- score: Score
- only_show_territory: boolean = false
Returns void
Inherited from GobanCore.showScores
- Defined in GobanCore.ts:2268

syncReviewMove

syncReviewMove(msg_override?: ReviewMessage, node_text?: string): void
Parameters
- Optional msg_override: ReviewMessage
- Optional node_text: string
Returns void
Inherited from GobanCore.syncReviewMove
- Defined in GobanCore.ts:3789

`Protected` toggleMark

toggleMark(x: number, y: number, mark: string | number, force_label?: boolean, force_put?: boolean): boolean
Parameters
- x: number
- y: number
- mark: string | number
- Optional force_label: boolean
- Optional force_put: boolean
Returns boolean
Inherited from GobanCore.toggleMark
- Defined in GobanCore.ts:2993

`Protected` updateMoveTree

updateMoveTree(): void
Returns void
Inherited from GobanCore.updateMoveTree
- Defined in GobanCore.ts:2004

`Protected` updateOrRedrawMoveTree

updateOrRedrawMoveTree(): void
Returns void
Inherited from GobanCore.updateOrRedrawMoveTree
- Defined in GobanCore.ts:2007

updatePlayerToMoveTitle

updatePlayerToMoveTitle(): void
Returns void
Inherited from GobanCore.updatePlayerToMoveTitle
- Defined in GobanCore.ts:2305

updateScoreEstimation

updateScoreEstimation(): void
Returns void
Inherited from GobanCore.updateScoreEstimation
- Defined in GobanCore.ts:3109

updateTitleAndStonePlacement

updateTitleAndStonePlacement(): void
Returns void
Inherited from GobanCore.updateTitleAndStonePlacement
- Defined in GobanCore.ts:2481

`Protected` watchSelectedThemes

watchSelectedThemes(cb: ((themes: GobanSelectedThemes) => void)): {
remove: (() => any);
}
Parameters
- cb: ((themes: GobanSelectedThemes) => void)
  - - (themes: GobanSelectedThemes): void
    - Parameters
      
      themes: GobanSelectedThemes
      
      Returns void
Returns {
remove: (() => any);
}
- remove: (() => any)
  - - (): any
    - Returns any
- Defined in GobanCanvas.ts:3013

`Protected` xy2ij

xy2ij(x: number, y: number): {
    i: number;
    j: number;
    valid: boolean;
}
Parameters
- x: number
- y: number
Returns {
    i: number;
    j: number;
    valid: boolean;
}
- i: number
- j: number
- valid: boolean
Inherited from GobanCore.xy2ij
- Defined in GobanCore.ts:1821

`Private` xy2pen

xy2pen(x: number, y: number): [number, number]
Parameters
- x: number
- y: number
Returns [number, number]
- Defined in GobanCanvas.ts:584

`Static` getCDNReleaseBase

getCDNReleaseBase(): string
Returns string
Inherited from GobanCore.getCDNReleaseBase
- Defined in GobanCore.ts:832

`Static` getMoveTreeNumbering

getMoveTreeNumbering(): string
Returns string
Inherited from GobanCore.getMoveTreeNumbering
- Defined in GobanCore.ts:826

`Static` getSoundEnabled

getSoundEnabled(): boolean
Returns boolean
Inherited from GobanCore.getSoundEnabled
- Defined in GobanCore.ts:838

`Static` getSoundVolume

getSoundVolume(): number
Returns number
Inherited from GobanCore.getSoundVolume
- Defined in GobanCore.ts:844

`Static` setHooks

setHooks(hooks: GobanHooks): void
Parameters
- hooks: GobanHooks
Returns void
Inherited from GobanCore.setHooks
- Defined in GobanCore.ts:788

Class Goban

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: GobanConfig

Optional preloaded_data: JGOF | AdHocFormat

Returns Goban

Properties

Protected __board_redraw_pen_layer_timer

Private __borders_initialized

Protected Optional __clock_timer

Protected __draw_state

Protected __last_pt

Type declaration

i: number

j: number

valid: boolean

Private __set_board_height

Private __set_board_width

Protected __update_move_tree

Protected analysis_move_counter

Protected Optional auto_scoring_done

Private autoplaying_puzzle_move

Private board

Protected bounded_height

Protected bounded_width

Protected bounds

Private byoyomi_label

chat_log

Protected circle_radius

clock_should_be_paused_for_move_submission

Protected Optional colored_circles

Protected conditional_path

conditional_starting_color

conditional_tree

config

Protected Optional connectToReviewSent

Private ctx

Protected Optional current_cmove

Private Optional current_pen_mark

Type declaration

color: string

points: [number, number]

Protected currently_my_cmove

Protected destroyed

Protected dirty_redraw

Protected disconnectedFromGame

Protected Optional display_width

Protected done_loading_review

Protected dont_draw_last_move

double_click_submit

draw_bottom_labels

draw_left_labels

draw_right_labels

draw_top_labels

Private drawing_enabled

Protected Optional edit_color

engine

Protected errorHandler

Type declaration

Parameters

e: Error

Returns void

Readonly game_id

Protected game_type

Protected Optional getPuzzlePlacementSetting

Type declaration

Returns PuzzlePlacementSetting

Protected goban_id

Private handleShiftKey

Type declaration

Parameters

ev: KeyboardEvent

Returns void

`Optional` preloaded_data: JGOF | AdHocFormat

`Protected` __board_redraw_pen_layer_timer

`Private` __borders_initialized

`Protected` `Optional` __clock_timer

`Protected` __draw_state

`Protected` __last_pt

`Private` __set_board_height

`Private` __set_board_width

`Protected` __update_move_tree

`Protected` analysis_move_counter

`Protected` `Optional` auto_scoring_done

`Private` autoplaying_puzzle_move

`Private` board

`Protected` bounded_height

`Protected` bounded_width

`Protected` bounds

`Private` byoyomi_label

`Protected` circle_radius

`Protected` `Optional` colored_circles

`Protected` conditional_path

`Protected` `Optional` connectToReviewSent

`Private` ctx

`Protected` `Optional` current_cmove

`Private` `Optional` current_pen_mark

`Protected` currently_my_cmove

`Protected` destroyed

`Protected` dirty_redraw

`Protected` disconnectedFromGame

`Protected` `Optional` display_width

`Protected` done_loading_review

`Protected` dont_draw_last_move

`Private` drawing_enabled

`Protected` `Optional` edit_color

`Protected` errorHandler

`Readonly` game_id

`Protected` game_type

`Protected` `Optional` getPuzzlePlacementSetting

`Protected` goban_id

`Private` handleShiftKey

`Protected` `Optional` heatmap

`Protected` highlight_movetree_moves

`Protected` interactive

`Protected` isInPushedAnalysis

`Protected` isPlayerController

`Protected` isPlayerOwner

`Protected` label_character

`Protected` label_mark

`Private` `Optional` labeling_mode

`Optional` last_clock

`Optional` last_emitted_clock

`Protected` `Optional` last_hover_square

`Private` last_label_position

`Protected` `Optional` last_move

`Protected` last_move_radius

`Private` `Optional` last_pen_position

`Protected` `Optional` last_phase

`Protected` last_review_message

`Protected` `Optional` last_sound_played_for_a_stone_placement

`Protected` last_stone_sound

`Private` layer_offset_left

`Private` layer_offset_top

`Protected` leavePushedAnalysis

`Private` `Optional` message_div

`Private` `Optional` message_td

`Private` `Optional` message_text

`Private` `Optional` message_timeout

`Protected` metrics

`Protected` `Optional` move_selected

`Private` `Optional` move_tree_canvas

`Optional` move_tree_container

`Private` `Optional` move_tree_inner_container

`Protected` no_display

`Protected` `Optional` onError

`Protected` on_game_screen

`Protected` original_square_size

`Private` parent

`Optional` pause_control

`Optional` paused_since

`Private` `Optional` pen_ctx

`Private` `Optional` pen_layer