Skip to the content

Sugoroku双六

Play backgammon and its relatives with native rules, cube and match scoring, seeded dice and replayable records.

Sugoroku is the Japanese name 双六 for games of tables. About the name

Contents

Reference · Playable board

mountSugorokufunction

Mount a board into host.

Import it

import { mountSugoroku } from "@johnmorrisdotca/sugoroku/play";

Definition

function mountSugoroku(host: HTMLElement, options?: SugorokuMountOptions): SugorokuMount

Parameters

NameTypeDescription
hostHTMLElement

The HTMLElement that owns the native interface.

options (optional)SugorokuMountOptions

Native settings and callbacks for this mounted interface.

Returns

SugorokuMount

The native mounted handle, including controls and destroy() cleanup.

Examples

import { mountSugoroku } from "@johnmorrisdotca/sugoroku/play";
const show = (host: HTMLElement, options: Parameters<typeof mountSugoroku>[1]) => mountSugoroku(host, options);
console.log(typeof show); // function
function

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/sugoroku 1.1.1.