Function: random()

Overload 1

random(): number

Defined in: random.ts:14

Returns a random integer between 0 and 1 (inclusive).

Returns

number

Either 0 or 1.

Example

random() // 0 or 1

Overload 2

random(max): number

Defined in: random.ts:25

Returns a random integer between 0 and max (inclusive). If max is negative, this function returns a random integer between max and 0, both inclusive.

Parameters

max

number

The upper bound if positive, lower bound if negative.

Returns

number

A random integer in the range [0 ; max] or [max ; 0].

Example

random(3)   // 0, 1, 2, or 3
random(-3)  // -3, -2, -1, or 0

Overload 3

random(min, max): number

Defined in: random.ts:38

Returns a random integer between min and max (inclusive). If min is greater than max, the values are swapped automatically.

Parameters

min

number

The lower bound (inclusive).

max

number

The upper bound (inclusive).

Returns

number

A random integer in the range [min, max].

Example

random(1, 6)   // dice roll: 1, 2, 3, 4, 5, or 6
random(-5, 5)  // anywhere from -5 to 5
random(5, 1)   // same as random(1, 5) — bounds are swapped