Module:Random/doc

This is a documentation subpage for Module:Random.
It may contain usage information, categories and other content that is not part of the original module page.

This module contains a number of functions that use random numbers. It can output random numbers, select a random item from a list, and reorder lists randomly. The available functions are outlined in more detail below.

Number

The number function outputs a random number.

{{#invoke:random|number|m|n}}

The arguments m and n may be omitted, but if specified must be convertible to integers.

With no arguments, returns a real number in the range $[0,1)$
With one argument, returns an integer in the range $[1,m]$
With two arguments, returns an integer in the range $[m,n]$

Examples (refresh)

{{#invoke:random|number}} → 0.12479974288717
{{#invoke:random|number|100}} → 47
{{#invoke:random|number|-100|-50}} → -92

The documentation for this function is partly taken from the Scribunto Lua reference manual, which is in turn based on the Lua 5.1 Reference Manual, available under the MIT License.

Item

The item function outputs a random item from a list.

{{#invoke:random|item|list item 1|list item 2|list item 3|...}}

Example (refresh)

{{#invoke:random|item|egg|beans|sausage|bacon|spam}} → egg