Class Random

Index

Constructors

Properties

Methods

angle bool chance choose float int range setGenerator shuffle sign vec2 vec3 vec4

Static

staticRandom angle bool chance choose float int range resetDefaultGenerator setDefaultGenerator shuffle sign vec2 vec3 vec4

Constructors

constructor

new Random(seed?: number): Random
A class with functions for randomness.
Parameters
- seed: number = ...
  Seed for RNG
Returns Random
- Defined in src/util/random.ts:35

Properties

seed

seed: number

RNG seed

Methods

angle

angle(): number
Generates a random angle [0-360).

Returns number
Random angle
- Defined in src/util/random.ts:201

bool

bool(): boolean
Returns a random bool.

Returns boolean
Random bool (true or false)
- Defined in src/util/random.ts:167

chance

chance(n: number, max: number): boolean
A roll of the dice. Ex: chance(2, 5) returns true 50% of the time
Parameters
- n: number
  Number of chances
- max: number
  Out of
Returns boolean
If fate smiled upon you
- Defined in src/util/random.ts:109

choose

choose<T>(...items: T[]): T
Returns a random element from passed arguments.
Type Parameters
- T
Parameters
- ...items: T[]
  Values to choose from
Returns T
Random item
- Defined in src/util/random.ts:220

float

float(n?: number): number
Generates a random number.
Parameters
- n: number = 1
  Upper bound (exclusive)
Returns number
Random number
- Defined in src/util/random.ts:86

int

int(n: number): number
Generates a random integer.
Parameters
- n: number
  Upper bound (exclusive)
Returns number
Random integer
- Defined in src/util/random.ts:129

range

range(a: number, b: number): number
Generates a random number within a given range.
Parameters
- a: number
  Lower bound (inclusive)
- b: number
  Upper bound (exclusive)
Returns number
Random number in range
- Defined in src/util/random.ts:150

setGenerator

setGenerator(randomFunc: (seed: number) => number): void
Sets the RNG function to use.
Parameters
- randomFunc: (seed: number) => number
  Function to use
Returns void
- Defined in src/util/random.ts:62

shuffle

shuffle<T>(arr: T[]): T[]
Shuffles an array in-place.
Type Parameters
- T
Parameters
- arr: T[]
  Array to shuffle
Returns T[]
arr
- Defined in src/util/random.ts:239

sign

sign(): -1 | 1
Generates a random sign.

Returns -1 | 1
Random sign (-1 or 1)
- Defined in src/util/random.ts:184

vec2

vec2(scale?: number): Vec2
Generates a random Vec2
Parameters
- scale: number = 1
  Scale of vector (optional)
Returns Vec2
Random Vec2
- Defined in src/util/random.ts:269

vec3

vec3(scale?: number): Vec3
Generates a random Vec3
Parameters
- scale: number = 1
  Scale of vector (optional)
Returns Vec3
Random Vec3
- Defined in src/util/random.ts:288

vec4

vec4(scale?: number): Vec4
Generates a random Vec4
Parameters
- scale: number = 1
  Scale of vector (optional)
Returns Vec4
Random Vec4
- Defined in src/util/random.ts:312

Static

`Static`staticRandom

staticRandom: Random = ...

`Static`angle

angle(): number
Generates a random angle [0-360).

Returns number
Random angle
- Defined in src/util/random.ts:193

`Static`bool

bool(): boolean
Returns a random boolean.

Returns boolean
Random boolean (true or false)
- Defined in src/util/random.ts:159

`Static`chance

chance(n: number, max: number): boolean
A roll of the dice. Ex: chance(2, 5) returns true 50% of the time
Parameters
- n: number
  Number of chances
- max: number
  Out of
Returns boolean
If fate smiled upon you
- Defined in src/util/random.ts:98

`Static`choose

choose<T>(...items: T[]): T
Returns a random element from passed arguments.
Type Parameters
- T
Parameters
- ...items: T[]
  Values to choose from
Returns T
Random item
- Defined in src/util/random.ts:211

`Static`float

float(n?: number): number
Generates a random number.
Parameters
- n: number = 1
  Upper bound (exclusive)
Returns number
Random number
- Defined in src/util/random.ts:77

`Static`int

int(n: number): number
Generates a random integer.
Parameters
- n: number
  Upper bound (exclusive)
Returns number
Random integer
- Defined in src/util/random.ts:120

`Static`range

range(a: number, b: number): number
Generates a random number within a given range.
Parameters
- a: number
  Lower bound (inclusive)
- b: number
  Upper bound (exclusive)
Returns number
Random number in range
- Defined in src/util/random.ts:140

`Static`resetDefaultGenerator

resetDefaultGenerator(): void
Sets the RNG function to the default (xorShift32).

Returns void
- Defined in src/util/random.ts:54

`Static`setDefaultGenerator

setDefaultGenerator(randomFunc: (seed: number) => number): void
Sets the default RNG function to use for instances of Random.
Parameters
- randomFunc: (seed: number) => number
  Function to use
Returns void
- Defined in src/util/random.ts:45

`Static`shuffle

shuffle<T>(arr: T[]): T[]
Shuffles an array in-place.
Type Parameters
- T
Parameters
- arr: T[]
  Array to shuffle
Returns T[]
arr
- Defined in src/util/random.ts:230

`Static`sign

sign(): -1 | 1
Generates a random sign.

Returns -1 | 1
Random sign (-1 or 1)
- Defined in src/util/random.ts:176

`Static`vec2

vec2(scale?: number): Vec2
Generates a random Vec2
Parameters
- scale: number = 1
  Scale of vector (optional)
Returns Vec2
Random Vec2
- Defined in src/util/random.ts:260

`Static`vec3

vec3(scale?: number): Vec3
Generates a random Vec3
Parameters
- scale: number = 1
  Scale of vector (optional)
Returns Vec3
Random Vec3
- Defined in src/util/random.ts:279

`Static`vec4

vec4(scale?: number): Vec4
Generates a random Vec4
Parameters
- scale: number = 1
  Scale of vector (optional)
Returns Vec4
Random Vec4
- Defined in src/util/random.ts:303