diff options
| author | toasteater <48371905+toasteater@users.noreply.github.com> | 2019-04-02 17:38:03 +0800 |
|---|---|---|
| committer | toasteater <48371905+toasteater@users.noreply.github.com> | 2019-04-02 22:42:49 +0800 |
| commit | ae1393acaef148c8e2d77f122ffef395e326d024 (patch) | |
| tree | 91dbc2b6ca7ed6b99d0b927e4a3161a3c97cbfe7 /doc/classes | |
| parent | 29a1202d39b0efb617a8ff4ee9764612f3e0124f (diff) | |
Improve RandomNumberGenerator docs.
Clarified behavior of a few methods. Added implementation notes so
that developers not familiar with RNGs are alerted to common pitfalls.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/RandomNumberGenerator.xml | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index 6fa2d44fd0..948477ba43 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -1,9 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="RandomNumberGenerator" inherits="Reference" category="Core" version="3.2"> <brief_description> - A class for generation pseudo-random numbers. + A class for generating pseudo-random numbers. </brief_description> <description> + RandomNumberGenerator is a class for generating pseudo-random numbers. It currently uses PCG32. The underlying algorithm is an implementation detail. As a result, it should not be depended upon for reproducible random streams across Godot versions. </description> <tutorials> </tutorials> @@ -14,7 +15,7 @@ <return type="float"> </return> <description> - Generates pseudo-random float between '0.0' and '1.0'. + Generates pseudo-random float between '0.0' and '1.0', inclusive. </description> </method> <method name="randf_range"> @@ -25,14 +26,14 @@ <argument index="1" name="to" type="float"> </argument> <description> - Generates pseudo-random float between [code]from[/code] and [code]to[/code]. + Generates pseudo-random float between [code]from[/code] and [code]to[/code], inclusive. </description> </method> <method name="randi"> <return type="int"> </return> <description> - Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295'. + Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295', inclusive. </description> </method> <method name="randi_range"> @@ -57,6 +58,7 @@ <members> <member name="seed" type="int" setter="set_seed" getter="get_seed"> The seed used by the random number generator. A given seed will give a reproducible sequence of pseudo-random numbers. + [b]Note:[/b] The RNG does not have an avalanche effect, and can output similar random streams given similar seeds. Consider using a hash function to improve your seed quality if they're sourced externally. </member> </members> <constants> |