Difference between revisions of "love.math.random"

(Function)
(Remove misleading comment about seeding)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
Generates a pseudo-random number in a platform independent manner.
+
Generates a pseudo-random number in a platform independent manner. The default [love.run] seeds this function at startup, so you generally don't need to seed it yourself.
 +
 
 
== Function ==
 
== Function ==
 
Get uniformly distributed pseudo-random real number within [0, 1].
 
Get uniformly distributed pseudo-random real number within [0, 1].
  
You might want to initialize the PRNG with [https://love2d.org/wiki/love.math.setRandomSeed setRandomSeed] before using this function.
 
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">

Revision as of 14:55, 4 October 2017

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Generates a pseudo-random number in a platform independent manner. The default [love.run] seeds this function at startup, so you generally don't need to seed it yourself.

Function

Get uniformly distributed pseudo-random real number within [0, 1].

Synopsis

number = love.math.random( )

Arguments

None.

Returns

number number
The pseudo-random number.

Function

Get a uniformly distributed pseudo-random integer within [1, max].

Synopsis

number = love.math.random( max )

Arguments

number max
The maximum possible value it should return.

Returns

number number
The pseudo-random integer number.

Function

Get uniformly distributed pseudo-random integer within [min, max].

Synopsis

number = love.math.random( min, max )

Arguments

number min
The minimum possible value it should return.
number max
The maximum possible value it should return.

Returns

number number
The pseudo-random integer number.

Examples

Generates a number between 1 and 100 (both inclusive).

function love.load()
    randomNumber = love.math.random(1, 100)
end

See Also

Other Languages