@dice-roller/rpg-dice-roller / NumberGenerator

Interface: NumberGenerator

Defined in: src/random/NumberGenerator.ts:10

Generates numbers in a range from a RandomEngine.

Used by dice and modifier handlers. Each Roller has its own generator, using nativeMath by default. Passing the same stateful engine to multiple rollers shares that engine's state.

Properties

engine

readonly engine: RandomEngine = nativeMath

Defined in: src/random/NumberGenerator.ts:13

Methods

integer()

integer(min, max): number

Defined in: src/random/NumberGenerator.ts:18

Returns an integer between min and max, inclusive.

Parameters

min

number

max

number

Returns

number

---

real()

real(min, max, inclusive?): number

Defined in: src/random/NumberGenerator.ts:23

Returns a real number between min and max (max is excluded unless inclusive is true).

Parameters

min

number

max

number

inclusive?

boolean = false

Returns

number