summaryrefslogtreecommitdiff
path: root/doc/classes/RandomNumberGenerator.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-11-05 08:47:37 +0100
committerGitHub <noreply@github.com>2020-11-05 08:47:37 +0100
commit494bf38c76d3070c548a104d56d9f7e164226f1c (patch)
tree36306746e6e0aa94e7b6790c37e99fd7afb93f8f /doc/classes/RandomNumberGenerator.xml
parentc35517f07eb0f0f71d4c5aa8d40420aa0f8ad6e3 (diff)
parent35e6070a353044a82f5f33c7ca52e6f315320a29 (diff)
Merge pull request #43318 from akien-mga/doc-rng-seed
doc: Override default value for RandomNumberGenerator.seed
Diffstat (limited to 'doc/classes/RandomNumberGenerator.xml')
-rw-r--r--doc/classes/RandomNumberGenerator.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml
index d4f9517dd1..dcb75dc275 100644
--- a/doc/classes/RandomNumberGenerator.xml
+++ b/doc/classes/RandomNumberGenerator.xml
@@ -74,9 +74,10 @@
</method>
</methods>
<members>
- <member name="seed" type="int" setter="set_seed" getter="get_seed" default="-6398989897141750821">
+ <member name="seed" type="int" setter="set_seed" getter="get_seed" default="0">
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.
+ [b]Note:[/b] The default value of this property is pseudo-random, and changes when calling [method randomize]. The [code]0[/code] value documented here is a placeholder, and not the actual default seed.
</member>
</members>
<constants>