Class Random<G>

Type Parameters

G extends IRandomGenerator = IRandomGenerator

Hierarchy

Random

Index

Constructors

constructor

new Random<G>(generator: G): Random<G>
Type Parameters
- G extends IRandomGenerator<any> = IRandomGenerator<any>
Parameters
- generator: G
Returns Random<G>
- Defined in src/game/utilities/random/Random.ts:25

Properties

generator

generator: G

Methods

advance

advance(): Random<G>
Returns Random<G>
- Defined in src/game/utilities/random/Random.ts:229

bool

bool(): boolean
Generates a random boolean

Returns boolean
- Defined in src/game/utilities/random/Random.ts:99

chance

chance(decimal: number): boolean
Returns whether a chance passes, given a decimal number.

Example: chance(0.1) is a 1/10 chance, chance(0.8) is a 4/5 chance
Parameters
- decimal: number
Returns boolean
- Defined in src/game/utilities/random/Random.ts:116

choice

choice<A>(...from: A): A[number]
Chooses a random entry in an array and returns it
Type Parameters
- A extends any[]
Parameters
- Rest ...from: A
Returns A[number]
- Defined in src/game/utilities/random/Random.ts:124

clone

clone<T>(requiresSynchronization?: boolean, initialState?: T): Random<G>
Type Parameters
- T
Parameters
- Optional requiresSynchronization: boolean
- Optional initialState: T
Returns Random<G>
- Defined in src/game/utilities/random/Random.ts:213

float

float(): number
Generates a random number between 0 (inclusive) and 1 (exclusive)

Returns number
- Defined in src/game/utilities/random/Random.ts:32
float(max: number): number
Generates a random number between 0 (inclusive) and max (exclusive)
Parameters
- max: number
Returns number
- Defined in src/game/utilities/random/Random.ts:36
float(min: number, max: number): number
Generates a random number between min (inclusive) and max (exclusive)
Parameters
- min: number
- max: number
Returns number
- Defined in src/game/utilities/random/Random.ts:40
float(range: IRange): number
Generates a random number from the given range.
Parameters
- range: IRange
Returns number
- Defined in src/game/utilities/random/Random.ts:44

getElement

getElement<T>(array: T[]): T
Type Parameters
- T
Parameters
- array: T[]
Returns T
- Defined in src/game/utilities/random/Random.ts:174

int

int(max: number): number
Generates a random integer between 0 (inclusive) and max (exclusive)
Parameters
- max: number
Returns number
- Defined in src/game/utilities/random/Random.ts:69
int(min: number, max: number): number
Generates a random integer between min (inclusive) and max (exclusive)
Parameters
- min: number
- max: number
Returns number
- Defined in src/game/utilities/random/Random.ts:73
int(range: IRange): number
Generates a random integer from the given range.
Parameters
- range: IRange
Returns number
- Defined in src/game/utilities/random/Random.ts:77

intInRange

intInRange(min: number, max: number): number
Generates a random integer between min and max (inclusive)
Parameters
- min: number
- max: number
Returns number
- Defined in src/game/utilities/random/Random.ts:85
intInRange(range: IRange): number
Parameters
- range: IRange
Returns number
- Defined in src/game/utilities/random/Random.ts:86

intInRangeExponential

intInRangeExponential(min: number, max: number, steepness?: number): number
Generates a rounded number between a range of numbers using exponential interpolation with optional weight. Note: Thanks ChatGPT!

Returns
number between provided min/max, rounded.
Parameters
- min: number
  
  Minimum number of range.
- max: number
  
  Maximum number of range.
- steepness: number = 5
  
  Steepness of the curve.
Returns number
- Defined in src/game/utilities/random/Random.ts:225

percent

percent(minChance?: number, chanceOutOf?: number, ceil?: boolean): number
Get a percentage for something Returns a number between 1 and 100 (inclusive)
Parameters
- minChance: number = 0
- chanceOutOf: number = 100
- ceil: boolean = true
Returns number
- Defined in src/game/utilities/random/Random.ts:107

sampling

sampling<T>(arr: T[], count: number): T[]
Returns a new array containing random choices from a given array.
Type Parameters
- T = any
Parameters
- arr: T[]
  
  The array to return items from
- count: number
  
  The number of items to return in the array
  
  Note: Be careful. This method can be very slow if used on a big array with a high count.
Returns T[]
- Defined in src/game/utilities/random/Random.ts:136

shuffle

shuffle<T>(array: readonly T[]): T[]
Returns a new shuffled array
Type Parameters
- T
Parameters
- array: readonly T[]
Returns T[]
- Defined in src/game/utilities/random/Random.ts:156

shuffleInPlace

shuffleInPlace<T>(array: T[]): T[]
Modifies an array and shuffles it
Type Parameters
- T
Parameters
- array: T[]
Returns T[]
- Defined in src/game/utilities/random/Random.ts:163

weightedChoice

weightedChoice<T>(choices: WeightedOption<T>[]): T
Returns a random T from the given choices, where each choice is weighted by a number. Higher numbers = higher chance.
Type Parameters
- T
Parameters
- choices: WeightedOption<T>[]
Returns T
- Defined in src/game/utilities/random/Random.ts:181

withGenerator

withGenerator<T>(generator: G, execute: (() => T)): T
Type Parameters
- T
Parameters
- generator: G
- execute: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in src/game/utilities/random/Random.ts:198

Class Random<G>

Type Parameters

G extends IRandomGenerator = IRandomGenerator

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

G extends IRandomGenerator<any> = IRandomGenerator<any>

Parameters

generator: G

Returns Random<G>

Properties

generator

Methods

advance

Returns Random<G>

bool

Returns boolean

chance

Parameters

decimal: number

Returns boolean

choice

Type Parameters

A extends any[]

Parameters

Rest ...from: A

Returns A[number]

clone

Type Parameters

T

Parameters

Optional requiresSynchronization: boolean

Optional initialState: T

Returns Random<G>

float

Returns number

Parameters

max: number

Returns number

Parameters

min: number

max: number

Returns number

Parameters

range: IRange

Returns number

getElement

Type Parameters

T

Parameters

array: T[]

Returns T

int

Parameters

max: number

Returns number

Parameters

min: number

max: number

Returns number

Parameters

range: IRange

Returns number

intInRange

Parameters

min: number

max: number

Returns number

Parameters

range: IRange

Returns number

intInRangeExponential

Returns

Parameters

min: number

`Rest` ...from: A

`Optional` requiresSynchronization: boolean

`Optional` initialState: T