Difference between revisions of "Core.random"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Available since:''' Gideros 2017.9<br/>
+
'''<translate>Available since</translate>:''' Gideros 2017.9<br/>
=== Description ===
+
=== <translate>Description</translate> ===
 
<translate>Generate and return a pseudo random number. The random number sequence is guaranteed to be consistent across
 
<translate>Generate and return a pseudo random number. The random number sequence is guaranteed to be consistent across
 
   devices for a given seed.
 
   devices for a given seed.
Line 10: Line 10:
 
() = Core.random(generator,bound1,bound2)
 
() = Core.random(generator,bound1,bound2)
 
</source>
 
</source>
=== Parameters ===
+
=== <translate>Parameters</translate> ===
 
'''generator''': (number) <translate>PRNG algorithm to use, use 0 for default engine (MT19937)</translate> '''optional'''<br/>
 
'''generator''': (number) <translate>PRNG algorithm to use, use 0 for default engine (MT19937)</translate> '''optional'''<br/>
 
'''bound1''': (number) <translate>First bound of the range returned number must be in</translate> '''optional'''<br/>
 
'''bound1''': (number) <translate>First bound of the range returned number must be in</translate> '''optional'''<br/>
 
'''bound2''': (number) <translate>Second bound of the range returned number must be in</translate> '''optional'''<br/>
 
'''bound2''': (number) <translate>Second bound of the range returned number must be in</translate> '''optional'''<br/>
=== Return values ===
+
=== <translate>Return values</translate> ===
'''Returns''' () <translate>random number</translate><br/>
+
'''<translate>Returns</translate>''' () <translate>random number</translate><br/>

Revision as of 07:28, 24 August 2018

Available since: Gideros 2017.9

Description

Generate and return a pseudo random number. The random number sequence is guaranteed to be consistent across

 devices for a given seed.
 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.
() = Core.random(generator,bound1,bound2)

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