summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChaosus <chaosus89@gmail.com>2018-09-21 14:32:17 +0300
committerChaosus <chaosus89@gmail.com>2018-11-13 10:50:07 +0300
commitf8151a9e5042ad3de64589f77cb108872694469c (patch)
tree2142d05afadadad7d0d7edf3e52d9b9b2bcb0b87 /doc
parent8849d3b47de8ab936549f0b9262c1193164feee5 (diff)
Implement random number generator
Co-authored-by: Zirak <zirakertan@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/RandomNumberGenerator.xml52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml
new file mode 100644
index 0000000000..55ae356435
--- /dev/null
+++ b/doc/classes/RandomNumberGenerator.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="RandomNumberGenerator" inherits="Reference" category="Core" version="3.1">
+ <brief_description>
+ A class for generation pseudo-random numbers.
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="randi">
+ <return type="int">
+ </return>
+ <description>
+ Generates pseudo-random 32-bit integer between '0' and '4294967295'.
+ </description>
+ </method>
+ <method name="randf">
+ <return type="float">
+ </return>
+ <description>
+ Generates pseudo-random float between '0.0' and '1.0'.
+ </description>
+ </method>
+ <method name="rand_range">
+ <return type="float">
+ </return>
+ <argument index="0" name="from" type="float">
+ </argument>
+ <argument index="1" name="to" type="float">
+ </argument>
+ <description>
+ Generates pseudo-random float between [code]from[/code] and [code]to[/code].
+ </description>
+ </method>
+ <method name="randomize">
+ <return type="void">
+ </return>
+ <description>
+ Setups a time-based seed to generator.
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="seed" type="int" setter="set_seed" getter="get_seed">
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>