Class: RandomGenerator

Constructor

new RandomGenerator(seedopt)

Create a random number generator with the seed passed in

Parameters:

Name	Type	Attributes	Default	Description
`seed`	number	<optional>	123456789	Starting seed, 0 as an integer uses the default seed

Source: src/engineMath.js, line 554

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

Type	Description
number	random seed, set it to reseed

Source: src/engineMath.js, line 561

Methods

angle() → {number}

Returns a random angle between -PI and PI

Source: src/engineMath.js, line 613

Returns:

Type:: number

bool(chanceopt) → {boolean}

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

Parameters:

Name	Type	Attributes	Default	Description
`chance`	number	<optional>	0.5

Source: src/engineMath.js, line 592

Returns:

Type:: boolean

direction(lengthopt) → {Vector2}

Returns a seeded Vector2 pointing a random way with the length passed in, the twin of randVec2

Parameters:

Name	Type	Attributes	Default	Description
`length`	number	<optional>	1

Source: src/engineMath.js, line 626

Returns:

Type:: Vector2

float(valueAopt, valueBopt) → {number}

Returns a seeded random value between the two values passed in

Parameters:

Name	Type	Attributes	Default	Description
`valueA`	number	<optional>	1
`valueB`	number	<optional>	0

Source: src/engineMath.js, line 568

Returns:

Type:: number

floatSign(valueAopt, valueBopt) → {number}

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

Parameters:

Name	Type	Attributes	Default	Description
`valueA`	number	<optional>	1
`valueB`	number	<optional>	0

Source: src/engineMath.js, line 602

Returns:

Type:: number

int(valueA, valueBopt) → {number}

Returns a floored seeded random value between the two values passed in

Parameters:

Name	Type	Attributes	Default	Description
`valueA`	number
`valueB`	number	<optional>	0

Source: src/engineMath.js, line 587

Returns:

Type:: number

mutateColor(color, amountopt, alphaAmountopt) → {Color}

Returns a new color that has each component randomly adjusted

Parameters:

Name	Type	Attributes	Default
`color`	Color
`amount`	number	<optional>	0.05
`alphaAmount`	number	<optional>	0

Source: src/engineMath.js, line 648

Returns:

Type:: Color

randColor(colorAopt, colorBopt, linearopt) → {Color}

Returns a random color between the two passed in colors, combine components if linear

Parameters:

Name	Type	Attributes	Default
`colorA`	Color	<optional>	WHITE
`colorB`	Color	<optional>	BLACK
`linear`	boolean	<optional>	false

Source: src/engineMath.js, line 633

Returns:

Type:: Color

sign() → {number}

Randomly returns either -1 or 1 deterministically

Source: src/engineMath.js, line 596

Returns:

Type:: number

vec2(valueAopt, valueBopt) → {Vector2}

Returns a seeded vec2 with each component between the two values passed in

A point in a square, not a random direction like randVec2, see direction for that

Parameters:

Name	Type	Attributes	Default	Description
`valueA`	number	<optional>	1
`valueB`	number	<optional>	0

Source: src/engineMath.js, line 620

Returns:

Type:: Vector2