Reference · Rules, tiles and records
kumimojiToTextfunction
A game as plain text, for a chat or a note: how it was set up, the
crossword as it lies, the hand, how many tiles are left, and the time. In
English unless given another table of strings (KUMIMOJI_STRINGS.ja). The
word list of the game's language must have been loaded, as for any judging.
Lines end with a line feed.
Import it
import { kumimojiToText } from "@johnmorrisdotca/kumimoji";
Definition
function kumimojiToText(saved: KumimojiSaved, strings?: KumimojiStrings): string
Parameters
| Name | Type | Description |
|---|---|---|
saved | KumimojiSaved | The original deal, current progress and elapsed time. |
strings (optional) | KumimojiStrings | The localized words for readable export. |
Returns
string
A game as plain text, for a chat or a note: how it was set up, the crossword as it lies, the hand, how many tiles are left, and the time. In English unless given another table of strings (KUMIMOJI_STRINGS.ja). The word list of the game's language must have been loaded, as for any judging. Lines end with a line feed.
Examples
import { deal, generateKumimoji, kumimojiToText } from "@johnmorrisdotca/kumimoji";
import { loadTileWordsFromModule } from "@johnmorrisdotca/kumimoji/words";
await loadTileWordsFromModule("english");
const play = deal("catdog",3);
const dealt = generateKumimoji(3,"hard",44);
const saved = {deal:dealt,play:deal(dealt.givens,dealt.size),elapsedMs:0};
console.log(kumimojiToText(saved));Kumimoji: English, a hand of 3, seed 44
(no tiles on the table)
Hand: N W O
In the bag: 2
Time: 0:00What it prints (run when this page was built)