WoW:API random

math.random and math.randomseed

Usage

math.randomseed(s); val = math.random([l, u]);

Description

The functions math.random and math.randomseed are interfaces to the simple random generator functions rand and srand that are provided by ANSI C. (No guarantees can be given for their statistical properties.)

When called without arguments, math.random returns a pseudo-random real number in the range [0,1).

When called with a number n, math.random returns a pseudo-random integer in the range [1,n].

When called with two arguments, l and u, math.random returns a pseudo-random integer in the range [l,u].

The math.randomseed function sets a "seed" for the pseudo-random generator: Equal seeds produce equal sequences of numbers.

Example

> local x = math.random();
> = x
0.34534 [0 - 1]

> local x = math.random(100);
> = x
53 [1 - 100]

> local x = math.random(50, 52);
> = x
51 [50 - 52]

Notes

math.randomseed takes any kind of positive number, between 0 and 2^31-1.

The range [0,1) of math.random is exclusive, meaning that you can never get 1.0 exactly. Note that the returned number is not an integer, except the special (very rare) case of 0.

The other ranges of the functions are inclusive, and will always return integers.