Reference · Ripple Effect rules
encodeRipplefunction
Encode the Ripple board and current game as native resumable text.
Import it
import { encodeRipple } from "@johnmorrisdotca/kazu/ripple";Also exported from: @johnmorrisdotca/kazu
Definition
function encodeRipple(game: RippleGame): stringParameters
| Name | Type | Description |
|---|---|---|
game | RippleGame | The current immutable game state. |
Returns
string
Encode the Ripple board and current game as native resumable text.
Examples
import type { RippleBoard } from "@johnmorrisdotca/kazu/ripple";
import { encodeRipple, newRipple } from "@johnmorrisdotca/kazu/ripple";
const rippleBoard: RippleBoard = {"width":9,"height":9,"rooms":[0,0,0,1,1,1,2,2,2,0,0,0,1,1,1,2,2,2,0,0,0,1,1,1,2,2,2,3,3,3,4,4,4,5,5,5,3,3,3,4,4,4,5,5,5,3,3,3,4,4,4,5,5,5,6,6,6,7,7,7,8,8,8,6,6,6,7,7,7,8,8,8,6,6,6,7,7,7,8,8,8],"clues":[4,null,7,9,2,null,5,null,3,null,null,3,6,7,4,8,9,2,8,null,2,1,3,null,null,null,null,7,null,1,null,6,null,null,null,9,3,8,null,5,1,7,null,null,6,2,4,6,null,9,3,7,5,1,1,null,8,null,5,null,9,2,4,null,2,null,null,null,null,null,null,null,6,null,null,2,4,null,null,3,null]};
const rippleGame = newRipple(rippleBoard);
console.log(encodeRipple(rippleGame));{"version":1,"board":{"width":9,"height":9,"rooms":[0,0,0,1,1,1,2,2,2,0,0,0,1,1,1,2,2,2,0,0,0,1,1,1,2,2,2,3,3,3,4,4,4,5,5,5,3,3,3,4,4,4,5,5,5,3,3,3,4,4,4,5,5,5,6,6,6,7,7,7,8,8,8,6,6,6,7,7,7,8,8,8,6,6,6,7,7,7,8,8,8],"clues":[4,null,7,9,2,null,5,null,3,null,null,3,6,7,4,8,9,2,8,null,2,1,3,null,null,null,null,7,null,1,null,6,null,null,null,9,3,8,null,5,1,7,null,null,6,2,4,6,null,9,3,7,5,1,1,null,8,null,5,null,9,2,4,null,2,null,null,null,null,null,null,null,6,null,null,2,4,null,null,3,null]},"values":[4,0,7,9,2,0,5,0,3,0,0,3,6,7,4,8,9,2,8,0,2,1,3,0,0,0,0,7,0,1,0,6,0,0,0,9,3,8,0,5,1,7,0,0,6,2,4,6,0,9,3,7,5,1,1,0,8,0,5,0,9,2,4,0,2,0,0,0,0,0,0,0,6,0,0,2,4,0,0,3,0],"notes":[[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[]],"helped":false}What it prints (run when this page was built)