Core.random: Difference between revisions

From GiderosMobile
mNo edit summary
m Text replacement - "<source" to "<syntaxhighlight"
Line 4: Line 4:
=== Description ===
=== Description ===
Generates and returns a pseudo random number. The random number sequence is guaranteed to be consistent across devices for a given seed.
Generates and returns a pseudo random number. The random number sequence is guaranteed to be consistent across devices for a given seed.
<source lang="lua">
<syntaxhighlight lang="lua">
() = Core.random(generator,bound1,bound2)
() = Core.random(generator,bound1,bound2)
</source>
</source>

Revision as of 13: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. <syntaxhighlight lang="lua"> () = Core.random(generator,bound1,bound2) </source>

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