RandomGenerator

Seeded random number generator

  • Can be used to create a deterministic random number sequence

Constructor

new RandomGenerator(seedopt)

Create a random number generator with the seed passed in

Parameters:
NameTypeAttributesDefaultDescription
seednumber<optional>
123456789

Starting seed or engine default seed

Source
Example
let r = new RandomGenerator(123); // random number generator with seed 123
let a = r.float();                // random value between 0 and 1
let b = r.int(10);                // random integer between 0 and 9
r.seed = 123;                     // reset the seed
let c = r.float();                // the same value as a

Members

seed

Properties
TypeDescription
number

random seed

Source

Methods

angle() → {number}

Returns a random angle between -PI and PI

Source
Returns:
Type: 
number

bool(chanceopt) → {boolean}

Randomly returns true or false given the chance of true passed in

Parameters:
NameTypeAttributesDefaultDescription
chancenumber<optional>
0.5
Source
Returns:
Type: 
boolean

float(valueAopt, valueBopt) → {number}

Returns a seeded random value between the two values passed in

Parameters:
NameTypeAttributesDefaultDescription
valueAnumber<optional>
1
valueBnumber<optional>
0
Source
Returns:
Type: 
number

floatSign(valueAopt, valueBopt) → {number}

Returns a seeded random value between the two values passed in with a random sign

Parameters:
NameTypeAttributesDefaultDescription
valueAnumber<optional>
1
valueBnumber<optional>
0
Source
Returns:
Type: 
number

int(valueA, valueBopt) → {number}

Returns a floored seeded random value the two values passed in

Parameters:
NameTypeAttributesDefaultDescription
valueAnumber
valueBnumber<optional>
0
Source
Returns:
Type: 
number

sign() → {number}

Randomly returns either -1 or 1 deterministically

Source
Returns:
Type: 
number

vec2(valueA, valueBopt) → {Vector2}

Returns a seeded vec2 with size between the two values passed in

Parameters:
NameTypeAttributesDefaultDescription
valueAnumber1
valueBnumber<optional>
0
Source
Returns:
Type: 
Vector2