Difference between revisions of "Core.random"
(Created page with "__NOTOC__ '''Available since:''' Gideros 2017.9<br/> === Description === Generate and return a pseudo random number. The random number sequence is guaranteed to be consistent...") |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
'''Available since:''' Gideros 2017.9<br/> | '''Available since:''' Gideros 2017.9<br/> | ||
| + | '''Class:''' [[Core]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | Generates and returns a pseudo random number. The random number sequence is guaranteed to be consistent across devices for a given seed. | |
| − | + | <syntaxhighlight lang="lua"> | |
| − | + | () = Core.random(generator,bound1,bound2) | |
| − | + | </syntaxhighlight> | |
| − | + | ||
| − | + | If bounds aren't specified, the function will return a floating point number between 0 and 1. | |
| − | + | If one bound is specified, the function will return an integer number between 1 and that bound (inclusive). | |
| − | + | If both bounds are specified, the function will return an integer between bound1 and bound2. bound2 must be greater than bound1. | |
| − | '''generator | + | |
| − | '''bound1 | + | === Parameters === |
| − | '''bound2 | + | '''generator''': (number) PRNG algorithm to use, use 0 for default engine (MT19937) '''optional'''<br/> |
| + | '''bound1''': (number) first bound of the range returned number must be in '''optional'''<br/> | ||
| + | '''bound2''': (number) second bound of the range returned number must be in '''optional'''<br/> | ||
| + | |||
| + | === Return values === | ||
'''Returns''' () random number<br/> | '''Returns''' () random number<br/> | ||
| + | |||
| + | {{Core}} | ||
Latest revision as of 14:26, 13 July 2023
Available since: Gideros 2017.9
Class: Core
Description
Generates and returns a pseudo random number. The random number sequence is guaranteed to be consistent across devices for a given seed.
() = Core.random(generator,bound1,bound2)
If bounds aren't specified, the function will return a floating point number between 0 and 1. If one bound is specified, the function will return an integer number between 1 and that bound (inclusive). If both bounds are specified, the function will return an integer between bound1 and bound2. bound2 must be greater than bound1.
Parameters
generator: (number) PRNG algorithm to use, use 0 for default engine (MT19937) optional
bound1: (number) first bound of the range returned number must be in optional
bound2: (number) second bound of the range returned number must be in optional
Return values
Returns () random number
