Docs: Recommend against using PseudoRandom

This commit is contained in:
Lars Müller 2024-01-17 21:48:17 +01:00 committed by GitHub
parent e985b7a0bf
commit a8cf10b0b5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 0 deletions

View File

@ -8180,6 +8180,11 @@ Can be obtained using `player:get_meta()`.
A 16-bit pseudorandom number generator.
Uses a well-known LCG algorithm introduced by K&R.
> [!NOTE]
> `PseudoRandom` is slower and has worse random distribution than `PcgRandom`.
> Use `PseudoRandom` only if you need output to match the well-known LCG algorithm introduced by K&R.
> Otherwise, use `PcgRandom`.
* constructor `PseudoRandom(seed)`
* `seed`: 32-bit signed number