Difference between revisions of "API:RNG"

From Spherical
Jump to: navigation, search
m (Description)
(Add some subheadings)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Constructs a new instance of the pseudorandom number generator.
+
{{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_obj = '''new RNG'''();
+
  ''rng_object'' = '''new RNG'''();
  
 
__TOC__
 
__TOC__
  
== Description ==
+
== API Information ==
  
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.
+
=== 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 ====
Line 33: Line 37:
 
* [[API:RNG::next|RNG::next()]]
 
* [[API:RNG::next|RNG::next()]]
 
</tt>
 
</tt>
 +
 +
[[Category:Sphere 2 API]]

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();

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