virtualx-engine/doc/classes/RandomNumberGenerator.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="RandomNumberGenerator" inherits="Reference" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A class for generating pseudo-random numbers.
	</brief_description>
	<description>
		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]
		[b]Note:[/b] The default values of [member seed] and [member state] properties are pseudo-random, and changes when calling [method randomize]. The [code]0[/code] value documented here is a placeholder, and not the actual default seed.
	</description>
	<tutorials>
		<link title="Random number generation">$DOCS_URL/tutorials/math/random_number_generation.html</link>
	</tutorials>
	<methods>
		<method name="randf">
			<return type="float" />
			<description>
				Generates a pseudo-random float between [code]0.0[/code] and [code]1.0[/code] (inclusive).
			</description>
		</method>
		<method name="randf_range">
			<return type="float" />
			<argument index="0" name="from" type="float" />
			<argument index="1" name="to" type="float" />
			<description>
				Generates a pseudo-random float between [code]from[/code] and [code]to[/code] (inclusive).
			</description>
		</method>
		<method name="randfn">
			<return type="float" />
			<argument index="0" name="mean" type="float" default="0.0" />
			<argument index="1" name="deviation" type="float" default="1.0" />
			<description>
				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" />
			<description>
				Generates a pseudo-random 32-bit unsigned integer between [code]0[/code] and [code]4294967295[/code] (inclusive).
			</description>
		</method>
		<method name="randi_range">
			<return type="int" />
			<argument index="0" name="from" type="int" />
			<argument index="1" name="to" type="int" />
			<description>
				Generates a pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code] (inclusive).
			</description>
		</method>
		<method name="randomize">
			<return type="void" />
			<description>
				Setups a time-based seed to generator.
			</description>
		</method>
	</methods>
	<members>
		<member name="seed" type="int" setter="set_seed" getter="get_seed" default="0">
			Initializes the random number generator state based on the given seed value. A given seed will give a reproducible sequence of pseudo-random numbers.
			[b]Note:[/b] 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.
			[b]Note:[/b] Setting this property produces a side effect of changing the internal [member state], so make sure to initialize the seed [i]before[/i] modifying the [member state]:
			[codeblock]
			var rng = RandomNumberGenerator.new()
			rng.seed = hash("Godot")
			rng.state = 100 # Restore to some previously saved state.
			[/codeblock]
			[b]Warning:[/b] the getter of this property returns the previous [member state], and not the initial seed value, which is going to be fixed in Godot 4.0.
		</member>
		<member name="state" type="int" setter="set_state" getter="get_state" default="0">
			The current state of the random number generator. Save and restore this property to restore the generator to a previous state:
			[codeblock]
			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.
			[/codeblock]
			[b]Note:[/b] 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 [member seed] instead.
		</member>
	</members>
	<constants>
	</constants>
</class>