Class: RandomDataGenerator

Methods

angle()

Returns a random angle between -180 and 180.

Source:

src/math/RandomDataGenerator.js line 293

Returns:

A random number between -180 and 180.

Type

number

between(min, max)

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.

Source:

src/math/RandomDataGenerator.js line 190

Returns:

A random number between min and max.

Type

number

frac()

Returns a random real number between 0 and 1.

Source:

src/math/RandomDataGenerator.js line 155

Returns:

A random real number between 0 and 1.

Type

number

integer()

Returns a random integer between 0 and 2^32.

Source:

src/math/RandomDataGenerator.js line 144

Returns:

A random integer between 0 and 2^32.

Type

number

integerInRange(min, max)

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.

Source:

src/math/RandomDataGenerator.js line 177

Returns:

A random number between min and max.

Type

number

normal()

Returns a random real number between -1 and 1.

Source:

src/math/RandomDataGenerator.js line 217

Returns:

A random real number between -1 and 1.

Type

number

pick(ary)

Returns a random member of array.

Parameters:

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

Source:

src/math/RandomDataGenerator.js line 245

Returns:

A random member of the array.

Type

any

real()

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

Source:

src/math/RandomDataGenerator.js line 166

Returns:

A random real number between 0 and 2^32.

Type

number

realInRange(min, max)

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.

Source:

src/math/RandomDataGenerator.js line 204

Returns:

A random number between min and max.

Type

number

sign()

Returns a sign to be used with multiplication operator.

Source:

src/math/RandomDataGenerator.js line 257

Returns:

-1 or +1.

Type

number

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:

src/math/RandomDataGenerator.js line 80

state( [state])

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.

Source:

src/math/RandomDataGenerator.js line 304

Returns:

The current state of the generator.

Type

string

timestamp(min, max)

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.

Source:

src/math/RandomDataGenerator.js line 280

Returns:

A random timestamp between min and max.

Type

number

uuid()

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

Source:

src/math/RandomDataGenerator.js line 228

Returns:

A valid RFC4122 version4 ID hex string

Type

string

weightedPick(ary)

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

Parameters:

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

Source:

src/math/RandomDataGenerator.js line 268

Returns:

A random member of the array.

Type

any