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 @@ -
Any state matrices (board, removal, etc..) provided will be cloned and must have the same dimensionality.
-Optional
goban_callback: GobanBaseProtected
Optional
goban_Readonly
heightReadonly
widthPrivate
_floodReturns a clone of .board
-Clone the entire BoardState
-Computes scoring locations for the board. If area_scoring
is true, we
+
Optional
goban_callback: GobanBaseProtected
Optional
goban_Readonly
heightReadonly
widthPrivate
_floodReturns true if the .board
field from the other board is equal to this one
Returns a clone of .board
+Clone the entire BoardState
+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).
Returns an array of groups connected to the given group. This is a bit +
Returns an array of groups connected to the given group. This is a bit faster than using StoneGroupBuilder because we only compute the values we need.
-Returns an array of x/y pairs of all the same color
-Sets a position as being removed or not removed. If +
Returns an array of x/y pairs of all the same color
+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.
Toggles a group of stones for removal or restoration.
+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.
-Optional
parent: ConditionalMoveTreeOptional
parentStatic
decodeOptional
parent: ConditionalMoveTreeOptional
parentStatic
decodeYou can't create an instance of a Goban directly, you have to create an instance of one of the renderers, such as GobanSVG.
-Optional
preloaded_data: GobanConfigProtected
__board_Protected
Optional
__clock_Protected
__draw_Protected
__last_Protected
__update_Protected
analysis_Protected
analysis_Protected
Optional
analysis_Private
Optional
analysis_Private
analysis_Protected
bounded_Protected
bounded_Protected
boundsProtected
circle_Protected
Optional
colored_Protected
conditional_Protected
Optional
connectProtected
Optional
current_Protected
currently_Protected
dirty_Protected
disconnectedProtected
Optional
display_Protected
done_Protected
dont_Protected
Optional
edit_Abstract
engineProtected
errorReadonly
game_Protected
game_Protected
Optional
getReadonly
goban_Base fields *
-Protected
Optional
heatmapProtected
highlight_Protected
interactiveProtected
isProtected
isProtected
isProtected
label_Protected
label_Optional
last_Optional
last_Protected
Optional
last_Protected
Optional
last_Protected
last_Protected
last_Protected
last_Protected
Optional
last_Protected
last_Protected
Optional
last_Protected
last_Protected
leaveProtected
Optional
marked_Protected
Optional
move_Protected
no_Protected
Optional
onProtected
on_Protected
original_Protected
parentOptional
pause_Optional
paused_Protected
player_Protected
Optional
preloaded_Protected
puzzle_Protected
restrict_Protected
review_Readonly
review_Protected
scoring_Protected
Optional
sendProtected
shift_Protected
show_Protected
show_Protected
socketProtected
socket_Protected
square_Optional
stalling_Protected
stone_Protected
Optional
stone_Static
THEMESStatic
THEMES_Static
setSet's callback functions to be called in various situations. You can set any +
Optional
preloaded_data: GobanConfigProtected
__board_Protected
Optional
__clock_Protected
__draw_Protected
__last_Protected
__update_Protected
analysis_Protected
analysis_Protected
Optional
analysis_Private
Optional
analysis_Private
analysis_Protected
bounded_Protected
bounded_Protected
boundsProtected
circle_Protected
Optional
colored_Protected
conditional_Protected
Optional
connectProtected
Optional
current_Protected
currently_Protected
dirty_Protected
disconnectedProtected
Optional
display_Protected
done_Protected
dont_Protected
Optional
edit_Abstract
engineProtected
errorReadonly
game_Protected
game_Protected
Optional
getReadonly
goban_Base fields *
+Protected
Optional
heatmapProtected
highlight_Protected
interactiveProtected
isProtected
isProtected
isProtected
label_Protected
label_Optional
last_Optional
last_Protected
Optional
last_Protected
Optional
last_Protected
last_Protected
last_Protected
last_Protected
Optional
last_Protected
last_Protected
Optional
last_Protected
last_Protected
leaveProtected
Optional
marked_Protected
Optional
move_Protected
no_Protected
Optional
onProtected
on_Protected
original_Protected
parentOptional
pause_Optional
paused_Protected
player_Protected
Optional
preloaded_Protected
puzzle_Protected
restrict_Protected
review_Readonly
review_Protected
scoring_Protected
Optional
sendProtected
shift_Protected
show_Protected
show_Protected
socketProtected
socket_Protected
square_Optional
stalling_Protected
stone_Protected
Optional
stone_Static
THEMESStatic
THEMES_Static
setSet'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.
-Static
setTrue if the game is a game record of a real life game
-Protected
_socket_Protected
annulAbstract
clearAbstract
clearProtected
clearProtected
clearProtected
computeProtected
connectDecodes any of the various ways we express moves that we've accumulated over the years into +
Static
setTrue if the game is a game record of a real life game
+Protected
_socket_Protected
annulAbstract
clearAbstract
clearProtected
clearProtected
clearProtected
computeProtected
connectDecodes any of the various ways we express moves that we've accumulated over the years into
a unified JGOFMove[]
.
Decodes a move string like "A11"
into a move object like {x: 0, y: 10}
. Also
+
Protected
defaultProtected
Abstract
disableAbstract
disableProtected
disconnectAbstract
drawAbstract
drawOptional
isTrunkMove: booleanProtected
Abstract
enableAbstract
enableProtected
followProtected
getProtected
getProtected
getProtected
getProtected
getProtected
getProtected
getProtected
getProtected
getProtected
incrementProtected
isMarks scores on the board when in analysis mode. Note: this will not +
Protected
defaultProtected
Abstract
disableAbstract
disableProtected
disconnectAbstract
drawAbstract
drawOptional
isTrunkMove: booleanProtected
Abstract
enableAbstract
enableProtected
followProtected
getProtected
getProtected
getProtected
getProtected
getProtected
getProtected
getProtected
getProtected
getProtected
incrementProtected
isAbstract
move_Protected
onProtected
onProtected
onProtected
playProtected
post_Goban calls some abstract methods as part of the construction +
Abstract
move_Protected
onProtected
onProtected
onProtected
playProtected
post_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.
-Encodes an x,y pair or a move object like {x: 0, y: 0} into a move string like "A1"
-Protected
putProtected
putProtected
putAbstract
redrawProtected
scheduleProtected
sendOptional
cb: (() => void)Protected
sendWhen we think our clock has runout, send a message to the server +
Encodes an x,y pair or a move object like {x: 0, y: 0} into a move string like "A1"
+Protected
putProtected
putProtected
putAbstract
redrawProtected
scheduleProtected
sendOptional
cb: (() => void)Protected
sendCalled by engine when a location has been set to a color.
-Optional
circles: ColoredCircle[]Optional
dont_draw: booleanOptional
conditional_tree: ConditionalMoveTreeOptional
heatmap: NumberMatrixOptional
dont_draw: booleanProtected
setProtected
setProtected
setProtected
setCalled by engine when a location has been set to a color.
+Optional
circles: ColoredCircle[]Optional
dont_draw: booleanOptional
conditional_tree: ConditionalMoveTreeOptional
heatmap: NumberMatrixOptional
dont_draw: booleanProtected
setProtected
setProtected
setProtected
setThis 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.
-Optional
dont_draw: booleanOptional
dont_jump_to_official_move: booleanAbstract
setOptional
dont_jump_to_official_move: booleanAbstract
setProtected
setProtected
Abstract
setProtected
Abstract
setProtected
setAbstract
showOptional
parameters: { Optional
timeout: numberOptional
msg_override: ReviewMessageOptional
node_text: stringProtected
toggleProtected
updateProtected
updateProtected
xy2ijStatic
getCDNReleaseStatic
getStatic
getStatic
get
Returns true if the
-.board
field from the other board is equal to this one