RandomNumberGenerator

Inherits: Reference < Object

Una clase para generar números pseudo-aleatorios.

Descripción

RandomNumberGenerator is a class for generating pseudo-random numbers. It currently uses PCG32.

Note: 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:

var rng = RandomNumberGenerator.new()
func _ready():
    rng.randomize()
    var my_random_number = rng.randf_range(-10.0, 10.0)

Note: The default values of seed and state properties are pseudo-random, and changes when calling randomize. The 0 value documented here is a placeholder, and not the actual default seed.

Propiedades

int

seed

0

int

state

0

Métodos

float

randf ( )

float

randf_range ( float from, float to )

float

randfn ( float mean=0.0, float deviation=1.0 )

int

randi ( )

int

randi_range ( int from, int to )

void

randomize ( )

Descripciones de Propiedades

Default

0

Setter

set_seed(value)

Getter

get_seed()

Initializes the random number generator state based on the given seed value. A given seed will give a reproducible sequence of pseudo-random numbers.

Note: 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.

Note: Setting this property produces a side effect of changing the internal state, so make sure to initialize the seed before modifying the state:

var rng = RandomNumberGenerator.new()
rng.seed = hash("Godot")
rng.state = 100 # Restore to some previously saved state.

Warning: the getter of this property returns the previous state, and not the initial seed value, which is going to be fixed in Godot 4.0.


Default

0

Setter

set_state(value)

Getter

get_state()

The current state of the random number generator. Save and restore this property to restore the generator to a previous state:

var rng = RandomNumberGenerator.new()
print(rng.randf())
var saved_state = rng.state # Store current state.
print(rng.randf()) # Advance internal state.
rng.state = saved_state # Restore the state.
print(rng.randf()) # Prints the same value as in previous.

Note: Do not set state to arbitrary values, since the random number generator requires the state to have certain qualities to behave properly. It should only be set to values that came from the state property itself. To initialize the random number generator with arbitrary input, use seed instead.

Descripciones de Métodos

Genera un número float pseuodo-aleatorio entre 0.0 y 1.0 (ambos incluídos).


Genera un número float pseudo-aleatorio entre from y to (ambos incluidos).


Genera un número pseudoaleatorio distribuido normalmente, utilizando la transformación Box-Muller con el mean especificado y una desviación estándar. Esto también se denomina distribución Gaussiana.


  • int randi ( )

Genera un número entero seudoaleatorio de 32 bits sin signo entre 0 y 4294967295 (inclusive).


Genera un entero seudoaleatorio de 32 bits firmado entre de y a (inclusive).


  • void randomize ( )

Configura una semilla basada en el tiempo para el generador.