rulesForfunction
The rules a colour plays under: the variant's spec for that colour, with the handicap laid over it when the handicap belongs to that colour.
A handicap can only make a colour's game harder. It adds forbidden shapes, tightens the line rule, lengthens the line, cuts the stones per turn and removes captures; it never loosens anything the variant already imposes.
Import it
import { rulesFor } from "@johnmorrisdotca/narabe";
Definition
function rulesFor(settings: GameSettings, stone: Stone): ColourRules
Parameters
| Name | Type | Description |
|---|---|---|
settings | GameSettings | The native game settings to interpret. |
stone | Stone | The black or white colour being examined. |
Returns
ColourRules
The rules a colour plays under: the variant's spec for that colour, with the handicap laid over it when the handicap belongs to that colour. A handicap can only make a colour's game harder. It adds forbidden shapes, tightens the line rule, lengthens the line, cuts the stones per turn and removes captures; it never loosens anything the variant already imposes.
Examples
import { createGame, rulesFor } from "@johnmorrisdotca/narabe";
const state = createGame({variant:"freestyle",size:15});
console.log(rulesFor(state.settings,"black"));{
lineRule: 'atLeast',
forbidden: [],
captures: false,
stonesPerTurn: 1,
winLength: 5,
secondStoneExclusion: 0
}What it prints (run when this page was built)