godot-docs/classes/class_randomnumbergenerator.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the RandomNumberGenerator.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_RandomNumberGenerator:

RandomNumberGenerator
=====================

**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

A class for generation pseudo-random numbers.

Properties
----------

+-----------------------+-----------------------------------------------+
| :ref:`int<class_int>` | :ref:`seed<class_RandomNumberGenerator_seed>` |
+-----------------------+-----------------------------------------------+

Methods
-------

+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`rand_range<class_RandomNumberGenerator_rand_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`randf<class_RandomNumberGenerator_randf>` **(** **)**                                                                        |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`      | :ref:`randi<class_RandomNumberGenerator_randi>` **(** **)**                                                                        |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`randomize<class_RandomNumberGenerator_randomize>` **(** **)**                                                                |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_RandomNumberGenerator_seed:

- :ref:`int<class_int>` **seed**

+----------+-----------------+
| *Setter* | set_seed(value) |
+----------+-----------------+
| *Getter* | get_seed()      |
+----------+-----------------+

Method Descriptions
-------------------

.. _class_RandomNumberGenerator_rand_range:

- :ref:`float<class_float>` **rand_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**

Generates pseudo-random float between ``from`` and ``to``.

.. _class_RandomNumberGenerator_randf:

- :ref:`float<class_float>` **randf** **(** **)**

Generates pseudo-random float between '0.0' and '1.0'.

.. _class_RandomNumberGenerator_randi:

- :ref:`int<class_int>` **randi** **(** **)**

Generates pseudo-random 32-bit integer between '0' and '4294967295'.

.. _class_RandomNumberGenerator_randomize:

- void **randomize** **(** **)**

Setups a time-based seed to generator.