@dice-roller/rpg-dice-roller / RollOptions

Interface: RollOptions<T>

Defined in: src/RollSettings.ts:22

How notation is parsed, rolled and presented. Every option is optional.

Type Parameters

T

T = string

the output type of the presenter

Properties

dice?

optional dice?: DieRegistry

Defined in: src/RollSettings.ts:26

Default: new DieRegistry() (the built-in dice).

---

engine?

optional engine?: RandomEngine

Defined in: src/RollSettings.ts:24

The source of randomness (default nativeMath).

---

limits?

optional limits?: Partial<RollLimits>

Defined in: src/RollSettings.ts:30

Safety limits: default maxQty 999 and maxIterations 1000; each must be a positive safe integer.

---

modifiers?

optional modifiers?: ModifierRegistry

Defined in: src/RollSettings.ts:28

Default: new ModifierRegistry() (the built-in modifiers).

---

presenter?

optional presenter?: Presenter<T>

Defined in: src/RollSettings.ts:32

Used by Roll.present() and Roller.present() (default: the default TextPresenter).