Interface RNG

Utility functions that make use of (pseudo-)random number generation

interface RNG {
    randFloat(): number;
    randInt(max?: number, inclusive?: boolean): number;
    randRange(min: number, max: number, inclusive?: boolean): number;
}

Index

Methods

randFloat randInt randRange

Methods

randFloat

randFloat(): number
Generates a new floating point value from [0, 1)

Returns number
The generated float

randInt

randInt(max?: number, inclusive?: boolean): number
Generates a new integer
Parameters
- Optionalmax: number
  Maximum value to possibly generate
- Optionalinclusive: boolean
  Whether the maximum value should be included in possible results (default false)
Returns number
The generated integer

randRange

randRange(min: number, max: number, inclusive?: boolean): number
Generates a new integer within [min, max) or [min, max]
Parameters
- min: number
  Minimum value to possibly generate
- max: number
  Maximum value to possible generate
- Optionalinclusive: boolean
  Whether the maximum value should be included in possible results (default false)
Returns number
The generated integer