Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

RandomNumberGenerator

Inherits: RefCounted < Object

Provides methods for generating pseudo-random numbers.

Description

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

Note: The underlying algorithm is an implementation detail and should not be depended upon.

To generate a random float number (within a given range) based on a time-dependant seed:

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

Tutorials

Properties

int

seed

0

int

state

0

Methods

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