aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/random.txt
blob: 5e50232ae0616690db25911a172dbbe02e4dda56 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
\section random random - generate random number

\subsection random-synopsis Synopsis
\fish{synopsis}
random [SEED]
\endfish

\subsection random-description Description

`random` outputs a random number from 0 to 32766, inclusive.

If a `SEED` value is provided, it is used to seed the random number generator, and no output will be produced. This can be useful for debugging purposes, where it can be desirable to get the same random number sequence multiple times. If the random number generator is called without first seeding it, the current time will be used as the seed.


\subsection random-example Example

The following code will count down from a random number to 1:

\fish
for i in (seq (random) -1 1)
    echo $i
    sleep
end
\endfish