random_utils

Methods

(static) gaussian(stdev, meanopt)

Description:

• Generate a whole random number, on a normal (Gaussian, "bell curve") distribution. For example, you might wish to create a youth gang where the members are mostly 18, but with outliers that are much younger or older. This random number generator will give more useful results than random() if you do not want the numbers to be evenly distributed.

Source:

• random_utils.js, line 159

Parameters:

Returns:

(static) guid() → {String}

Description:

• Generates a unique string (not guaranteed to be globally unique, but certainly unique in any given context).

Source:

• random_utils.js, line 19

Example

guid()
=> "6v2w2762322fwsds"

Returns:

Type

String

(static) nonNegativeGaussian(stdev, meanopt)

Description:

• As the gaussian random number method, but it will not return negative numbers (without disturbing the rest of the distribution).

Source:

• random_utils.js, line 186

Parameters:

Returns:

(static) random(value) → {Object}

Description:

• Return a random value from a "strategy" value, recursively. An element will be selected from an array, a function will be executed for its return value, and a string with variants will be returned with a variant selected. The value is then checked again to see if it can still be randomized further, and this process continues until a primitive value is returned (a number, object, string, or boolean).

Source:

• random_utils.js, line 120

Example

random("A")
=> "A"
random(['A','B','C']);
=> 'A'
random("{Big|Bad|Black} Dog");
=> 'Bad Dog'
random(() => ["A","B","C"]);
=> "B"

Parameters:

Returns:

Type

Object

(static) randomElement(an)

Description:

• A function that takes an array and returns a random element in the array. Does not execute functions, select a string out of string expressions, or perform any other recursive randomization.

Source:

• random_utils.js, line 141

Parameters:

Returns:

(static) roll(number) → {Number}

Description:

• Returns a random number based on a die roll string or a provided number. Math operations are supported.

Source:

• random_utils.js, line 44

Example

roll(8)
=> 4

Parameters:

Returns:

Type

Number

(static) roll(notation) → {Number}

Source:

• random_utils.js, line 44

Example

roll("3d6+2")
=> 9
roll("(2d4*10)+500")
=> 540

Parameters:

Returns:

Type

Number

(static) selectElements(tree) → {Array}

Description:

• It’s common to want to select elements according to probabalities and alternatives. Given the following format, this will return a list of selected strings (which must map to whatever you are working on):

  { "oneOf": { "A & B": 50, // if selected, returns ["A","B"] "C": 50, // these values should add up to 100, if they don't // selecting nothing fills the remaining percentage }, "oneOf:2": { // use anything after "oneOf" to create unique key A: 50, B: 50, }, "allOf": { // all noces that pas d100 check are added (100 = always) A: 20, B: 75, }, // this is 1d2 of the child nodes "someOf:1d2": ["2d3:Cash Register"], // if selected, add 2d3 nodes };

Source:

• random_utils.js, line 249

Parameters:

Returns:

Type

Array

(static) shuffle(array)

Description:

• Randomly shuffle the position of the elements in an array (uses Fisher-Yates shuffle). random() is usually more efficient, but if you need to iterate through a set of values in a random order, without traversing the same element more than once, shuffle() is a better way to randomize your data.

Source:

• random_utils.js, line 195

Example

var array = ['A','B','C']
    atomic.shuffle(array);
    =>
    array;
    => ['C','A','B']

Parameters:

(static) test(percentage, value1opt, value2opt) → {Boolean|any}

Description:

• Test against a percentage that something will occur.

Source:

• random_utils.js, line 84

Example

if (test(80)) {
    // Happens 80% of the time.
}
test(15, 'A', 'B')
=> 'B'

Parameters:

Returns:

Type

Boolean | any