Reference · Rules, tiles and records
judgeWithWordsfunction
A GRID JUDGED AGAINST ITS LANGUAGE'S LIST, the one way the solo game, each
seat of a pass-and-play game and the server's check all ask it: a run is a
word when its tiles spell one the list holds (wordOf, so a wild reads as
the letter or kana it was given), and a run that is not is named as it
reads. A wild given no letter reads as whichever letter makes every run
through it a word (readWilds); where none does, the grid is judged as
laid and the run is named with its *. rules says whether the diagonals
are read (GridRules).
Import it
import { judgeWithWords } from "@johnmorrisdotca/kumimoji";
Definition
function judgeWithWords(tiles: Tiles, words: TileWords, rules?: GridRules): GridVerdict
Parameters
| Name | Type | Description |
|---|---|---|
tiles | Tiles | The map from row,column square names to internal tile codes. |
words | TileWords | The loaded native language word list and tile mappings. |
rules (optional) | GridRules | Whether diagonal runs are also judged. |
Returns
GridVerdict
A GRID JUDGED AGAINST ITS LANGUAGE'S LIST, the one way the solo game, each seat of a pass-and-play game and the server's check all ask it: a run is a word when its tiles spell one the list holds (wordOf, so a wild reads as the letter or kana it was given), and a run that is not is named as it reads. A wild given no letter reads as whichever letter makes every run through it a word (readWilds); where none does, the grid is judged as laid and the run is named with its *. rules says whether the diagonals are read (GridRules).
Examples
import { loadTileWordsFromModule } from "@johnmorrisdotca/kumimoji/words";
import { judgeWithWords } from "@johnmorrisdotca/kumimoji";
const words = await loadTileWordsFromModule("english");
const tiles = new Map([["0,0","c"],["0,1","a"],["0,2","t"]]);
console.log(judgeWithWords(tiles,words));{
sound: true,
tiles: 3,
misspelt: Set(0) {},
apart: Set(0) {},
notWords: []
}What it prints (run when this page was built)