Reference · Redacted player and observer views
viewForPlayerfunction
A player view redacts opponent roles and suppresses the board during device handoff.
Import it
import { viewForPlayer } from "@johnmorrisdotca/gunjin/views";Also exported from: @johnmorrisdotca/gunjin
Definition
function viewForPlayer(match: AuthoritativeMatch, viewer: Player): PlayerViewParameters
| Name | Type | Description |
|---|---|---|
match | AuthoritativeMatch | The full authoritative match, held by a trusted host or the local hotseat owner. |
viewer | Player | The player, 0 or 1, whose own roles may be included in this view. |
Returns
PlayerView
The player view; pieces are null during setup/pass, ownSetup is null outside setup, and opponent kinds are null.
Examples
import type { Player } from "@johnmorrisdotca/gunjin";
import { createHasamiMatch, hasamiRoster, submitHasamiSetup } from "@johnmorrisdotca/gunjin/hasami";
import { acknowledgePass } from "@johnmorrisdotca/gunjin/stratego-lite";
import { viewForPlayer } from "@johnmorrisdotca/gunjin/views";
const home=(player: Player)=>hasamiRoster(7).map((kind,x)=>({kind,x,y:player===0?6:0}));
const base=createHasamiMatch({width:7,height:7});
const firstSetup=submitHasamiSetup(base,0,home(0),base.setupStep);
let ready=acknowledgePass(firstSetup,1,firstSetup.turn);
ready=submitHasamiSetup(ready,1,home(1),ready.setupStep);
ready=acknowledgePass(ready,0,ready.turn);
console.log(viewForPlayer(ready,0).pieces?.find(piece=>piece.owner===1));{ owner: 1, x: 0, y: 0, kind: null, hidden: true }What it prints (run when this page was built)