Difference between revisions of "RandomGenerator:random"

m
(Reflects love.math.random)
Line 3: Line 3:
  
 
== Function ==
 
== Function ==
Get uniformly distributed pseudo-random number within [0, 1].
+
Get uniformly distributed pseudo-random real number within [0, 1].
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 14: Line 14:
  
 
== Function ==
 
== Function ==
Get uniformly distributed pseudo-random integer number within [1, max].
+
Get uniformly distributed pseudo-random '''integer''' number within [1, max].
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 24: Line 24:
 
{{param|number|number|The pseudo-random integer number.}}
 
{{param|number|number|The pseudo-random integer number.}}
 
== Function ==
 
== Function ==
Get uniformly distributed pseudo-random integer number within [min, max].
+
Get uniformly distributed pseudo-random '''integer''' number within [min, max].
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 34: Line 34:
 
=== Returns ===
 
=== Returns ===
 
{{param|number|number|The pseudo-random integer number.}}
 
{{param|number|number|The pseudo-random integer number.}}
 
+
== Notes ==
 +
When using the 2nd and 3rd variant, numbers passed will be rounded, thus, <code>RandomGenerator:random(0, 76.767)</code> may return 77
 
== See Also ==
 
== See Also ==
 
* [[parent::RandomGenerator]]
 
* [[parent::RandomGenerator]]

Revision as of 14:50, 14 November 2020

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.

Function

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

Synopsis

number = RandomGenerator:random( )

Arguments

None.

Returns

number number
The pseudo-random number.

Function

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

Synopsis

number = RandomGenerator: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 number within [min, max].

Synopsis

number = RandomGenerator: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.

Notes

When using the 2nd and 3rd variant, numbers passed will be rounded, thus, RandomGenerator:random(0, 76.767) may return 77

See Also

Other Languages