API:RNG: Difference between revisions

From Spherical
Jump to navigation Jump to search
Initial draft of RNG constructor documentation
Line 9: Line 9:
== Description ==
== Description ==


The <tt>'''RNG'''</tt> constructor initializes a new instance of the Sphere random number generator, seeded based on the current time and date.  Unlike <tt>Math.random()</tt> which uses a very basic linear generator, Sphere uses the ''xoroshiro128+'' algorithm, providing games with a very high-quality source of pseudorandom numbers. To control the initial state of the generator, you should use one of <tt>[[API:RNG.fromSeed|RNG.fromSeed()]]</tt> or <tt>[[API:RNG.fromState|RNG.fromState()]]</tt> instead.
The <tt>'''RNG'''</tt> constructor initializes a new instance of the Sphere random number generator, seeded based on the current time and date.  Unlike <tt>Math.random()</tt> which uses a very basic linear generator, Sphere uses the ''xoroshiro128+'' algorithm, providing games with a very high-quality source of pseudorandom numbers.
 
To control the initial state of the generator, use <tt>[[API:RNG.fromSeed|RNG.fromSeed()]]</tt> or <tt>[[API:RNG.fromState|RNG.fromState()]]</tt>.


== Properties ==
== Properties ==

Revision as of 04:36, 8 August 2017

Constructs a new instance of the pseudorandom number generator.

Usage
rng_obj = new RNG();

Description

The RNG constructor initializes a new instance of the Sphere random number generator, seeded based on the current time and date. Unlike Math.random() which uses a very basic linear generator, Sphere uses the xoroshiro128+ algorithm, providing games with a very high-quality source of pseudorandom numbers.

To control the initial state of the generator, use RNG.fromSeed() or RNG.fromState().

Properties

Methods

Static Methods

Instance Methods