Added example on how to use RandomNumberGenerator

(cherry picked from commit 68c6790baf)
This commit is contained in:
tree786 2019-06-29 22:59:22 +01:00 committed by Rémi Verschelde
parent 055f9f075f
commit 128eaa2718
1 changed files with 9 additions and 1 deletions

View File

@ -4,7 +4,15 @@
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.
RandomNumberGenerator is a class for generating pseudo-random numbers. It currently uses [url=http://www.pcg-random.org/]PCG32[/url].
[b]Note:[/b] The underlying algorithm is an implementation detail. As a result, it should not be depended upon for reproducible random streams across Godot versions.
To generate a random float number (within a given range) based on a time-dependant seed:
[codeblock]
var rng = RandomNumberGenerator.new()
func _ready():
rng.randomize()
var my_random_number = rng.randf_range(-10.0, 10.0)
[/codeblock]
</description>
<tutorials>
</tutorials>