NumberGenerator

Classes

NumberGenerator: The NumberGenerator is capable of generating random numbers.

maxEngine : Object: Engine that always returns the maximum value. Used internally for calculating max roll values.
minEngine : Object: Engine that always returns the minimum value. Used internally for calculating min roll values.
engines : Object: List of built-in number generator engines.

The NumberGenerator is capable of generating random numbers.

Kind: global class
See: This uses random-js. For details of the engines, check the documentation.
Since: 4.2.0

Create a NumberGenerator instance.

The engine can be any object that has a next() method, which returns a number.

Throws:

Param	Type	Default	Description
[engine]	`Engine` \| `Object`	`nativeMath`	The RNG engine to use

Example (Built-in engine)

new NumberGenerator(engines.nodeCrypto);

Example (Custom engine)

new NumberGenerator({
  next() {
    // return a random number
  },
});

The current engine.

Kind: instance property of NumberGenerator

Set the engine.

The engine can be any object that has a next() method, which returns a number.

Kind: instance property of NumberGenerator
Throws:

See: engines

Param	Type
engine	`Engine` \| `Object`

Example (Built-in engine)

numberGenerator.engine = engines.nodeCrypto;

Example (Custom engine)

numberGenerator.engine = {
  next() {
    // return a random number
  },
});

Generate a random integer within the inclusive range [min, max].

Kind: instance method of NumberGenerator
Returns: number - The random integer

Param	Type	Description
min	`number`	The minimum integer value, inclusive.
max	`number`	The maximum integer value, inclusive.

Returns a floating-point value within [min, max) or [min, max].

Kind: instance method of NumberGenerator
Returns: number - The random floating-point value

Param	Type	Default	Description
min	`number`		The minimum floating-point value, inclusive.
max	`number`		The maximum floating-point value.
[inclusive]	`boolean`	`false`	If `true`, `max` will be inclusive.