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

modifiers

Modifier definitions, handlers, and registries for extending roll behavior.

Classes

Class	Description
ModifierRegistry	Modifier handlers by name.

Interfaces

Interface	Description
ModifierHandler	The behaviour of a modifier.
ModifierInput	Context and modifier node supplied to a handler alongside its items.

Type Aliases

Type Alias	Description
ModifierHandlerOf	The handler for the modifier with the given name.
ModifierTarget	What a modifier can be attached to.

Variables

Variable	Description
builtInModifierHandlers	The built-in handlers, in execution order. The array, handlers, and their target arrays are frozen.
criticalFailureHandler	cf, cf<3: flags rolls matching the compare point (the die's min by default) as critical-failure.
criticalSuccessHandler	cs, cs>18: flags rolls matching the compare point (the die's max by default) as critical-success.
dropHandler	d, dl, dh: drops the lowest / highest qty items (flag drop). d defaults to lowest.
explodeHandler	!, !!, !p, !!p: rolls another die whenever a roll matches the compare point (the die's max by default), up to ctx.limits.maxIterations times per roll (default 1000). At the limit the last extra roll is retained even if it matches.
keepHandler	k, kh, kl: keeps the highest / lowest qty items, and drops the rest (flag drop). k defaults to highest.
maxHandler	max5: lowers rolls above the value to the value (flag max).
minHandler	min2: raises rolls below the value to the value (flag min).
reRollHandler	r, ro: re-rolls rolls that match the compare point (the die's min by default), replacing the value (the initial value is kept).
sortHandler	s, sa, sd: sorts the items by value, ascending or descending. s defaults to ascending.
targetHandler	>=8, >=8f<=2: counts successes and failures.
uniqueHandler	u, uo: re-rolls rolls whose value an earlier roll already has (optionally only those matching the compare point), replacing the value (the initial value is kept). The first roll is never re-rolled.

Functions

Function	Description
matchesComparePoint	Whether the value matches the compare point, e.g. matchesComparePoint({ operator: ">=", value: 8 }, 9).