Reference · Rules, tiles and records
encodePartyfunction
A table of players as text to keep. decodeParty reads it back, and given the word list's familyKey checks every tile held against the bag.
Import it
import { encodeParty } from "@johnmorrisdotca/kumimoji";
Definition
function encodeParty(game: PartyGame): string
Parameters
| Name | Type | Description |
|---|---|---|
game | PartyGame | The current immutable shared-bag party game. |
Returns
string
A table of players as text to keep. decodeParty reads it back, and given the word list's familyKey checks every tile held against the bag.
Examples
import { encodeParty, startParty } from "@johnmorrisdotca/kumimoji";
const settings = {size:3,level:"hard",seed:44,gameLength:"short",language:"english",doubleSet:false,diagonals:false,hints:false} as const;
const bag = "catdogsun";
const game = startParty(settings,bag,["Seat 1","Seat 2"]);
console.log(encodeParty(game));{"v":1,"settings":{"size":3,"level":"hard","seed":44,"gameLength":"short","language":"english","doubleSet":false,"diagonals":false,"hints":false},"bag":"catdogsun","returned":"","taken":6,"turn":0,"turns":0,"out":[],"lastTurns":null,"resigned":[],"resignRun":[],"ending":null,"startTable":"","traded":false,"passedBy":null,"players":[{"name":"Seat 1","hand":"cat","grid":""},{"name":"Seat 2","hand":"dog","grid":""}]}What it prints (run when this page was built)