API Docs for: 1.4.0
Show:

Kiwi.Utils.RandomDataGenerator Class

Defined in: src\utils\RandomDataGenerator.ts:9
Module: Utils
Parent Module: Kiwi

Manages the creation of unique internal game IDs. 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

Constructor

Kiwi.Utils.RandomDataGenerator

(
  • [seeds=[]
)
RandomDataGenerator

Defined in src\utils\RandomDataGenerator.ts:9

Parameters:

  • [seeds=[] String optional

Returns:

RandomDataGenerator:

Methods

angle

() Number public

Defined in src\utils\RandomDataGenerator.ts:409

Returns a random angle between -180 and 180

Returns:

Number:

frac

() Number public

Defined in src\utils\RandomDataGenerator.ts:213

Returns a random real number between 0 and 1

Returns:

Number:

fract32

() Any private

Defined in src\utils\RandomDataGenerator.ts:112

[DESCRIPTION REQUIRED]

Returns:

Any:

hash

(
  • data
)
private

Defined in src\utils\RandomDataGenerator.ts:143

[DESCRIPTION REQUIRED]

Parameters:

  • data Any

integer

() Number public

Defined in src\utils\RandomDataGenerator.ts:201

Returns a random integer between 0 and 2^32

Returns:

Number:

integerInRange

(
  • min
  • max
)
Number public

Defined in src\utils\RandomDataGenerator.ts:237

Returns a random integer between min and max

Parameters:

  • min Number
  • max Number

Returns:

Number:

normal

() Number public

Defined in src\utils\RandomDataGenerator.ts:268

Returns a random real number between -1 and 1

Returns:

Number:

objType

() String public

Defined in src\utils\RandomDataGenerator.ts:30

The type of object that this is.

Returns:

String:

"RandomDataGenerator"

pick

(
  • array
)
Any public

Defined in src\utils\RandomDataGenerator.ts:299

Returns a random member of array

Parameters:

  • array Any

Returns:

Any:

real

() Number public

Defined in src\utils\RandomDataGenerator.ts:225

Returns a random real number between 0 and 2^32

Returns:

Number:

realInRange

(
  • min
  • max
)
Number public

Defined in src\utils\RandomDataGenerator.ts:251

Returns a random real number between min and max

Parameters:

  • min Number
  • max Number

Returns:

Number:

rnd

() Any private

Defined in src\utils\RandomDataGenerator.ts:125

[DESCRIPTION REQUIRED]

Returns:

Any:

sentence

() String public

Defined in src\utils\RandomDataGenerator.ts:357

Returns a random lipsum sentence

Returns:

String:

sentences

(
  • [quantity=3]
)
String public

Defined in src\utils\RandomDataGenerator.ts:375

Returns n random lipsum sentences, 3 if not specified

Parameters:

  • [quantity=3] Number optional

    The number of sentences to grab.

Returns:

String:

sow

(
  • [seeds=[]
)
public

Defined in src\utils\RandomDataGenerator.ts:173

Reset the seed of the random data generator

Parameters:

  • [seeds=[] String optional

timestamp

(
  • [min=946684800000]
  • [max=1577862000000]
)
Number public

Defined in src\utils\RandomDataGenerator.ts:395

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:

  • [min=946684800000] Number optional

    The lowest timestamp.

  • [max=1577862000000] Number optional

    The highest timestamp.

Returns:

Number:

uint32

() Any private

Defined in src\utils\RandomDataGenerator.ts:100

[DESCRIPTION REQUIRED]

Returns:

Any:

uuid

() String public

Defined in src\utils\RandomDataGenerator.ts:280

Returns a valid v4 UUID hex string (from https://gist.github.com/1308368)

Returns:

String:

weightedPick

(
  • array
)
Any public

Defined in src\utils\RandomDataGenerator.ts:312

Returns a random member of array, favoring the earlier entries

Parameters:

  • array Any

Returns:

Any:

word

() String public

Defined in src\utils\RandomDataGenerator.ts:325

Returns a random word of lipsum

Returns:

String:

words

(
  • [quantity=3]
)
String public

Defined in src\utils\RandomDataGenerator.ts:337

Returns n random words of lipsum, 3 if not specified

Parameters:

  • [quantity=3] Number optional

    Amount of random words to get.

Returns:

String:

Properties

_data

Object private

Defined in src\utils\RandomDataGenerator.ts:73

Used to contain various arrays of data that can be used when randomly generating blocks of text.

c

Number private

Defined in src\utils\RandomDataGenerator.ts:64

[DESCRIPTION REQUIRED]

Default: 1

s0

Any private

Defined in src\utils\RandomDataGenerator.ts:40

[DESCRIPTION REQUIRED]

s1

Any private

Defined in src\utils\RandomDataGenerator.ts:48

[DESCRIPTION REQUIRED]

s2

Any private

Defined in src\utils\RandomDataGenerator.ts:56

[DESCRIPTION REQUIRED]