Class: Phaser.RandomDataGenerator

Constructor

new RandomDataGenerator(seeds)

Parameters

Name	Type	Argument	Description
seeds	Array.<any> | string	<optional>	An array of values to use as the seed, or a generator state (from {#state}).

Source code: math/RandomDataGenerator.js (Line 23)

Public Methods

angle() → {number}

Returns a random angle between -180 and 180.

Returns

number -

A random number between -180 and 180.

Source code: math/RandomDataGenerator.js (Line 310)

between(min, max) → {number}

Returns a random integer between and including min and max.
This method is an alias for RandomDataGenerator.integerInRange.

Parameters

Name	Type	Description
min	number	The minimum value in the range.
max	number	The maximum value in the range.

Returns

number -

A random number between min and max.

Source code: math/RandomDataGenerator.js (Line 198)

frac() → {number}

Returns a random real number between 0 and 1.

Returns

number -

A random real number between 0 and 1.

Source code: math/RandomDataGenerator.js (Line 160)

integer() → {number}

Returns a random integer between 0 and 2^32.

Returns

number -

A random integer between 0 and 2^32.

Source code: math/RandomDataGenerator.js (Line 148)

integerInRange(min, max) → {number}

Returns a random integer between and including min and max.

Parameters

Name	Type	Description
min	number	The minimum value in the range.
max	number	The maximum value in the range.

Returns

number -

A random number between min and max.

Source code: math/RandomDataGenerator.js (Line 184)

normal() → {number}

Returns a random real number between -1 and 1.

Returns

number -

A random real number between -1 and 1.

Source code: math/RandomDataGenerator.js (Line 227)

pick(ary) → {any}

Returns a random member of array.

Parameters

Name	Type	Description
ary	Array	An Array to pick a random member of.

Returns

any -

A random member of the array.

Source code: math/RandomDataGenerator.js (Line 258)

real() → {number}

Returns a random real number between 0 and 2^32.

Returns

number -

A random real number between 0 and 2^32.

Source code: math/RandomDataGenerator.js (Line 172)

realInRange(min, max) → {number}

Returns a random real number between min and max.

Parameters

Name	Type	Description
min	number	The minimum value in the range.
max	number	The maximum value in the range.

Returns

number -

A random number between min and max.

Source code: math/RandomDataGenerator.js (Line 213)

sign() → {number}

Returns a sign to be used with multiplication operator.

Returns

number -

-1 or +1.

Source code: math/RandomDataGenerator.js (Line 271)

sow(seeds)

Reset the seed of the random data generator.

Note: the seed array is only processed up to the first undefined (or null) value, should such be present.

Parameters

Name	Type	Description
seeds	Array.<any>	The array of seeds: the toString() of each value is used.

Source code: math/RandomDataGenerator.js (Line 83)

state(state) → {string}

Gets or Sets the state of the generator. This allows you to retain the values
that the generator is using between games, i.e. in a game save file.

To seed this generator with a previously saved state you can pass it as the
seed value in your game config, or call this method directly after Phaser has booted.

Call this method with no parameters to return the current state.

If providing a state it should match the same format that this method
returns, which is a string with a header !rnd followed by the c,
s0, s1 and s2 values respectively, each comma-delimited.

Parameters

Name	Type	Argument	Description
state	string	<optional>	Generator state to be set.

Returns

string -

The current state of the generator.

Source code: math/RandomDataGenerator.js (Line 322)

timestamp(min, max) → {number}

Returns a random timestamp between min and max, or between the beginning of 2000 and the end of 2020 if min and max aren't specified.

Parameters

Name	Type	Description
min	number	The minimum value in the range.
max	number	The maximum value in the range.

Returns

number -

A random timestamp between min and max.

Source code: math/RandomDataGenerator.js (Line 296)

uuid() → {string}

Returns a valid RFC4122 version4 ID hex string from https://gist.github.com/1308368

Returns

string -

A valid RFC4122 version4 ID hex string

Source code: math/RandomDataGenerator.js (Line 239)

weightedPick(ary) → {any}

Returns a random member of array, favoring the earlier entries.

Parameters

Name	Type	Description
ary	Array	An Array to pick a random member of.

Returns

any -

A random member of the array.

Source code: math/RandomDataGenerator.js (Line 283)