Class: RandomDataGenerator

Phaser. RandomDataGenerator

Phaser.RandomDataGenerator

new RandomDataGenerator(seeds)

An extremely useful repeatable random data generator. Based on Nonsense by Josh Faul https://github.com/jocafa/Nonsense. Random number generator from http://baagoe.org/en/wiki/Better_random_numbers_for_javascript

Parameters:
Name Type Argument Description
seeds array <optional>

An array of values to use as the seed.

Source:

Methods

angle() → {number}

Returns a random angle between -180 and 180.

Source:
Returns:

A random number between -180 and 180.

Type
number

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.

Source:
Returns:

A random number between min and max.

Type
number

frac() → {number}

Returns a random real number between 0 and 1.

Source:
Returns:

A random real number between 0 and 1.

Type
number

integer() → {number}

Returns a random integer between 0 and 2^32.

Source:
Returns:

A random integer between 0 and 2^32.

Type
number

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.

Source:
Returns:

A random number between min and max.

Type
number

normal() → {number}

Returns a random real number between -1 and 1.

Source:
Returns:

A random real number between -1 and 1.

Type
number

pick(ary) → {any}

Returns a random member of array.

Parameters:
Name Type Description
ary Array

An Array to pick a random member of.

Source:
Returns:

A random member of the array.

Type
any

real() → {number}

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

Source:
Returns:

A random real number between 0 and 2^32.

Type
number

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.

Source:
Returns:

A random number between min and max.

Type
number

sow(seeds)

Reset the seed of the random data generator.

Parameters:
Name Type Description
seeds array
Source:

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.

Source:
Returns:

A random timestamp between min and max.

Type
number

uuid() → {string}

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

Source:
Returns:

A valid RFC4122 version4 ID hex string

Type
string

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.

Source:
Returns:

A random member of the array.

Type
any
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev on Wed Oct 22 2014 21:46:04 GMT+0100 (BST) using the DocStrap template.