diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-28 12:36:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-28 12:36:41 +0200 |
| commit | 6e03236574467d6a0c3aca1b0375da59423b0083 (patch) | |
| tree | 7da85ef95f4fc66559218976bb08a87143ae3c8c /doc/classes/RandomNumberGenerator.xml | |
| parent | 7b10bae916dabcf1639fa1ee99c5fefd2790a1ca (diff) | |
| parent | f7f6115f7627df24a08a9a0882b2f573cc838eb1 (diff) | |
Merge pull request #30134 from Calinou/doc-proofread
Proofread and improve the whole class reference
Diffstat (limited to 'doc/classes/RandomNumberGenerator.xml')
| -rw-r--r-- | doc/classes/RandomNumberGenerator.xml | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index be7bcc9c35..dc96bba304 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -4,7 +4,8 @@ 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. </description> <tutorials> </tutorials> @@ -13,7 +14,7 @@ <return type="float"> </return> <description> - Generates pseudo-random float between '0.0' and '1.0', inclusive. + Generates a pseudo-random float between [code]0.0[/code] and [code]1.0[/code] (inclusive). </description> </method> <method name="randf_range"> @@ -24,7 +25,7 @@ <argument index="1" name="to" type="float"> </argument> <description> - Generates pseudo-random float between [code]from[/code] and [code]to[/code], inclusive. + Generates a pseudo-random float between [code]from[/code] and [code]to[/code] (inclusive). </description> </method> <method name="randfn"> @@ -35,14 +36,14 @@ <argument index="1" name="deviation" type="float" default="1.0"> </argument> <description> - Generates normally(gaussian) distributed pseudo-random number, using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. + Generates a [url=https://en.wikipedia.org/wiki/Normal_distribution]normally-distributed[/url] pseudo-random number, using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. This is also called Gaussian distribution. </description> </method> <method name="randi"> <return type="int"> </return> <description> - Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295', inclusive. + Generates a pseudo-random 32-bit unsigned integer between [code]0[/code] and [code]4294967295[/code] (inclusive). </description> </method> <method name="randi_range"> @@ -53,7 +54,7 @@ <argument index="1" name="to" type="int"> </argument> <description> - Generates pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code] (inclusive). + Generates a pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code] (inclusive). </description> </method> <method name="randomize"> |