@dice-roller/rpg-dice-roller / modifiers / ModifierInput

Interface: ModifierInput<N>

Defined in: src/modifiers/types.ts:10

Context and modifier node supplied to a handler alongside its items.

Type Parameters

N

N extends ModifierNode = ModifierNode

Properties

ctx

readonly ctx: RollContext

Defined in: src/modifiers/types.ts:14

Roll mode, random generator, and safety limits for this evaluation.

---

die?

readonly optional die?: ResolvedDie

Defined in: src/modifiers/types.ts:16

The pool's die (pools only).

---

modifier

readonly modifier: N

Defined in: src/modifiers/types.ts:12

The modifier node from the AST.

---

rollDie?

readonly optional rollDie?: () => DieResult

Defined in: src/modifiers/types.ts:18

Rolls one more die of the pool (pools only), e.g. for explode and re-roll.

Returns

DieResult