Class Random

Create an instance of Random with a given seed. Instances created with the same seed will output the same sequence of values, as long as each method is called in the same order each time.

Example

Create an instance with a seed string:

let myRandom = new bge.Random("my cool seed");
let value = myRandom.int(10, 20);
Copy

Seed string used when creating this instance.

Example

Print the seed of the shared instance:

console.log(bge.random.seed);
Copy

Returns true with the given probability, which is 0.5 by default (50%).

Example

Fair coin flip:

console.log(bge.random.chance() ? "Heads" : "Tails");
Copy

Weighted coin flip, with a 75% bias towards heads:

console.log(bge.random.chance(0.75) ? "Heads" : "Tails");
Copy

Generates a uniformly-distributed floating-point number between 0 (inclusive) and 1 (exclusive).

Example

Generate a floating-point value between 0 and 1:

let value = bge.random.float();
Copy

Generates a uniformly-distributed floating-point number between 0 (inclusive) and max (exclusive).

Example

Generate a floating-point value between 0 and 10:

let value = bge.random.float(10);
Copy

Generates a uniformly-distributed floating-point number between min (inclusive) and max (exclusive).

Example

Generate a floating-point value between 10 and 20:

let value = bge.random.float(10, 20);
Copy

Generates a uniformly-distributed integer between 0 (inclusive) and max (exclusive).

Example

Generate either 0, 1, 2, 3 or 4:

let value = bge.random.int(5);
Copy

Generates a uniformly-distributed integer between min (inclusive) and max (exclusive).

Example

Generate either 10, 11, 12, 13 or 14:

let value = bge.random.int(10, 15);
Copy

Returns a uniformly selected random item from an array.

Example

Pick a random name from a list:

let list = ["Alice", "Bob", "Charlie"];
let name = bge.random.item(list);
Copy

Shuffles all items of the given array in-place.

Example

Shuffle a list of numbers:

let list = [1, 2, 3, 4, 5];
bge.random.shuffle(list);
Copy

Shuffles a range of items of the given array in-place.

Example

Shuffle the middle 3 items of a list with 5 numbers:

let list = [1, 2, 3, 4, 5];
bge.random.shuffle(list, 1, 4);
Copy