roll関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
Throw the dice. The source is crypto unless a seeded one is given. The
third argument is when the roll is made, in epoch milliseconds (now, unless
given), or options: { at, maxDice }. A spec asking for more than ten dice
is brought to ten unless maxDice says otherwise, up to MAX_DICE_BY_CODE.
インポート
import { roll } from "@johnmorrisdotca/korokoro";定義
function roll(spec: Partial<RollSpec>, source?: RandomSource, when?: number | RollOptions): Roll引数
| 名前 | 型 | 説明 |
|---|---|---|
spec | Partial<RollSpec> | Dice counts, sides, rules and modifier; omitted fields use the documented defaults. |
source (省略可) | RandomSource | A source of unsigned 32-bit integers; crypto by default where optional. |
when (省略可) | number | RollOptions | Epoch milliseconds, or roll options including the time and maximum dice. |
戻り値
Roll
The completed roll, including its spec, faces, kept mask, total, seed and timestamp.
例
import { roll } from "@johnmorrisdotca/korokoro";
import { normalizeSpec, seededSource } from "@johnmorrisdotca/korokoro";
const spec = normalizeSpec({ count: 2, sides: 6 });
console.log(roll(spec, seededSource("table"), 0).faces);[ 1, 2 ]出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。