Difference between revisions of "API:RNG"
From Spherical
Bruce Pascoe (talk | contribs) |
Bruce Pascoe (talk | contribs) (Add some subheadings) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | + | {{DISPLAYTITLE:new RNG()}} | |
+ | |||
+ | The '''<tt>RNG()</tt> constructor''' initializes a new instance of the pseudorandom number generator, seeded using the current time and date. | ||
===== Usage ===== | ===== Usage ===== | ||
− | + | ''rng_object'' = '''new RNG'''(); | |
__TOC__ | __TOC__ | ||
− | == Description == | + | == API Information == |
+ | |||
+ | === Description === | ||
− | + | <tt>'''new RNG()'''</tt> initializes a new instance of the built-in pseudorandom 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>. | 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 === |
<tt> | <tt> | ||
Line 19: | Line 23: | ||
</tt> | </tt> | ||
− | == Methods == | + | === Methods === |
==== Static Methods ==== | ==== Static Methods ==== |
Latest revision as of 04:08, 12 August 2017
The RNG() constructor initializes a new instance of the pseudorandom number generator, seeded using the current time and date.
Usage
rng_object = new RNG();
Contents
API Information
Description
new RNG() initializes a new instance of the built-in pseudorandom 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