API:RNG - Revision history

Bruce Pascoe: Add some subheadings

2017-08-12T04:08:56Z

Add some subheadings

Bruce Pascoe: Improve documentation conventions a bit

2017-08-08T15:01:03Z

Improve documentation conventions a bit

Bruce Pascoe at 06:14, 8 August 2017

2017-08-08T06:14:10Z

Bruce Pascoe at 06:12, 8 August 2017

2017-08-08T06:12:58Z

Bruce Pascoe: /* Description */

2017-08-08T04:36:54Z

‎Description

Bruce Pascoe: Initial draft of RNG constructor documentation

2017-08-08T04:35:54Z

Initial draft of RNG constructor documentation

Bruce Pascoe: Created page with "{{subst:objecttemp|preamble=Constructs a new instance of the Sphere pseudorandom number generator. The '''RNG''' object uses the xoroshiro128+ algorithm, providing high-quali..."

2017-08-07T18:35:15Z

Created page with "{{subst:objecttemp|preamble=Constructs a new instance of the Sphere pseudorandom number generator. The '''RNG''' object uses the xoroshiro128+ algorithm, providing high-quali..."

New page

{{subst:objecttemp|preamble=Constructs a new instance of the Sphere pseudorandom number generator. The '''RNG''' object uses the xoroshiro128+ algorithm, providing high-quality pseudorandom numbers.|function=RNG|object=RNG|returns=A new ```RNG``` instance.|params=none}}

@@ Line 9: / Line 9: @@
 __TOC__
-== Description ==
+== API Information ==
 <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.
@@ Line 15: / Line 17: @@
 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>
@@ Line 21: / Line 23: @@
 </tt>
-== Methods ==
+=== Methods ===
 ==== Static Methods ====

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:RNG Constructor}}
+{{DISPLAYTITLE:new RNG()}}
-Constructs a new instance of the pseudorandom number generator.
+The '''<tt>RNG()</tt> constructor''' initializes a new instance of the pseudorandom number generator, seeded using the current time and date.
 ===== Usage =====
-  rng_obj = '''new RNG'''();
+  ''rng_object'' = '''new RNG'''();
 __TOC__
@@ Line 11: / Line 11: @@
 == 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.
+<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>.

← Older revision		Revision as of 06:14, 8 August 2017
Line 1:		Line 1:
		+	{{DISPLAYTITLE:RNG Constructor}}
		+
	Constructs a new instance of the pseudorandom number generator.		Constructs a new instance of the pseudorandom number generator.

← Older revision		Revision as of 06:12, 8 August 2017
Line 33:		Line 33:
	* [[API:RNG::next\|RNG::next()]]		* [[API:RNG::next\|RNG::next()]]
	</tt>		</tt>
		+
		+	[[Category:Sphere 2 API]]

@@ Line 9: / Line 9: @@
 == 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.
 == Properties ==

← Older revision		Revision as of 04:35, 8 August 2017
Line 1:		Line 1:
−	~~{{subst:objecttemp\|preamble=~~Constructs a new instance of the ~~Sphere~~ pseudorandom number generator. The '''RNG''' ~~object~~ uses the xoroshiro128+ algorithm, providing high-quality pseudorandom numbers.\|~~function~~=RNG\|~~object~~=RNG\|~~returns=A new ```~~RNG~~``` instance~~.\|~~params~~=~~none}}~~	+	Constructs a new instance of the pseudorandom number generator.
		+
		+	===== Usage =====
		+
		+	rng_obj = '''new RNG'''();
		+
		+	__TOC__
		+
		+	== 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.
		+
		+	== Properties ==
		+
		+	<tt>
		+	* [[API:RNG::state\|RNG::state]]
		+	</tt>
		+
		+	== Methods ==
		+
		+	==== Static Methods ====
		+
		+	<tt>
		+	* [[API:RNG.fromSeed\|RNG.fromSeed()]]
		+	* [[API:RNG.fromState\|RNG.fromState()]]
		+	</tt>
		+
		+	==== Instance Methods ====
		+
		+	<tt>
		+	* [[API:RNG::next\|RNG::next()]]
		+	</tt>