Class RNG

A seeded random number generator.

Index

Constructors

Methods

bellFloat float int item next randomSet randomString setSeed shuffle simple weighted

Constructors

constructor

new RNG(seed: string | number): RNG
Creates a new RNG instance.
Parameters
- seed: string | number
  The seed to use. Can be a number or a string.
Returns RNG
- Defined in local.ts:13

Methods

bellFloat

bellFloat(min: number, max: number): number
Returns a random float between min and max, with a bell curve distribution.
Parameters
- min: number
  The minimum value.
- max: number
  The maximum value.
Returns number
A random float between min and max.
- Defined in local.ts:71

float

float(min: number, max: number): number
Returns a random float between min and max.
Parameters
- min: number
  The minimum value.
- max: number
  The maximum value.
Returns number
A random float between min and max.
- Defined in local.ts:89

int

int(min: number, max: number): number
Returns a random integer between min and max (inclusive).
Parameters
- min: number
  The minimum value.
- max: number
  The maximum value.
Returns number
A random integer between min and max.
- Defined in local.ts:61

item

item<T>(items: T[]): T
Returns a random item from an array.
Type Parameters
- T
Parameters
- items: T[]
  The array of items.
Returns T
A random item from the array.
- Defined in local.ts:98

next

next(): number
Generates the next random number in the sequence.

Returns number
A random number between 0 and 1.
- Defined in local.ts:47

randomSet

randomSet<T>(itemCount: number, items: T[]): T[]
Returns a random set of items from an array.
Type Parameters
- T
Parameters
- itemCount: number
  The number of items to return.
- items: T[]
  The array of items.
Returns T[]
An array of random items from the original array.
- Defined in local.ts:108

randomString

randomString(length: number): string
Returns a random string of the specified length.
Parameters
- length: number
  The length of the string.
Returns string
A random string.
- Defined in local.ts:125

setSeed

setSeed(seed: string | number): void
Sets the seed for the random number generator.
Parameters
- seed: string | number
  The seed to use. Can be a number or a string.
Returns void
- Defined in local.ts:35

shuffle

shuffle<T>(items: T[]): T[]
Shuffles an array in place.
Type Parameters
- T
Parameters
- items: T[]
  The array to shuffle.
Returns T[]
The shuffled array.
- Defined in local.ts:140

simple

simple(max: number): number
Returns a random integer between 1 and max.
Parameters
- max: number
  The maximum value.
Returns number
A random integer between 1 and max.
- Defined in local.ts:155

weighted

weighted<T>(items: WeightedEntry<T>[]): T
Returns a random item from a weighted list.
Type Parameters
- T
Parameters
- items: WeightedEntry<T>[]
  The list of weighted entries.
Returns T
A random item from the list, selected based on weight.
- Defined in local.ts:164