readDice関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
What happened to each die of a roll, from its faces alone: which were rerolled, which exploded, which were dropped. Null when the faces are not ones this spec could have thrown, one too many or too few included.
インポート
import { readDice } from "@johnmorrisdotca/korokoro";
定義
function readDice(spec: RollSpec, faces: readonly unknown[]): DieRoll[] | null
引数
| 名前 | 型 | 説明 |
|---|---|---|
spec | RollSpec | Dice counts, sides, rules and modifier; omitted fields use the documented defaults. |
faces | readonly unknown[] | Physical face values, in the order thrown. |
戻り値
DieRoll[] | null
What happened to each die of a roll, from its faces alone: which were rerolled, which exploded, which were dropped. null when the faces are not ones this spec could have thrown, one too many or too few included.
例
import { readDice } from "@johnmorrisdotca/korokoro";
import { normalizeSpec } from "@johnmorrisdotca/korokoro";
const spec = normalizeSpec({ count: 2, sides: 6 });
console.log(readDice(spec, [2, 5])?.map((die) => die.status));[ 'kept', 'kept' ]出力(このページを作ったときに実行した結果)
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。