Difference between revisions of "love.math.newRandomGenerator"

m (Added example)
(Fixed constructor documentation to properly talk about the seed rather than the state)
Line 10: Line 10:
 
None
 
None
 
=== Returns ===
 
=== Returns ===
{{param|RandomGenerator|rng|A Random Number Generator object.}}
+
{{param|RandomGenerator|rng|The new Random Number Generator object.}}
  
 
== Function ==
 
== Function ==
See [[RandomGenerator:setState]].
 
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
rng = love.math.newRandomGenerator( state )
+
rng = love.math.newRandomGenerator( seed )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|state|The state ("seed") number to use for this instance of the object.}}
+
{{param|number|seed|The initial seed number to use for this object.}}
 
=== Returns ===
 
=== Returns ===
{{param|RandomGenerator|rng|A Random Number Generator object.}}
+
{{param|RandomGenerator|rng|The new Random Number Generator object.}}
 +
=== Notes ===
 +
See [[RandomGenerator:setSeed]].
  
 
== Function ==
 
== Function ==
See [[RandomGenerator:setState]].
 
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 30: Line 30:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|low|The lower 32 bits of the state number to use for this instance of the object.}}
+
{{param|number|low|The lower 32 bits of the seed number to use for this object.}}
{{param|number|high|The higher 32 bits of the state number to use for this instance of the object.}}
+
{{param|number|high|The higher 32 bits of the seed number to use for this object.}}
 
=== Returns ===
 
=== Returns ===
{{param|RandomGenerator|rng|A Random Number Generator object.}}
+
{{param|RandomGenerator|rng|The new Random Number Generator object.}}
 +
=== Notes ===
 +
See [[RandomGenerator:setSeed]].
 +
 
 
== Examples ==
 
== Examples ==
 
Creates a new RandomGenerator object, then generates a number between 1 and 100 inclusive.
 
Creates a new RandomGenerator object, then generates a number between 1 and 100 inclusive.

Revision as of 17:51, 17 July 2014

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Creates a new RandomGenerator object which is completely independent of other RandomGenerator objects and random functions.

Function

Synopsis

rng = love.math.newRandomGenerator( )

Arguments

None

Returns

RandomGenerator rng
The new Random Number Generator object.

Function

Synopsis

rng = love.math.newRandomGenerator( seed )

Arguments

number seed
The initial seed number to use for this object.

Returns

RandomGenerator rng
The new Random Number Generator object.

Notes

See RandomGenerator:setSeed.

Function

Synopsis

rng = love.math.newRandomGenerator( low, high )

Arguments

number low
The lower 32 bits of the seed number to use for this object.
number high
The higher 32 bits of the seed number to use for this object.

Returns

RandomGenerator rng
The new Random Number Generator object.

Notes

See RandomGenerator:setSeed.

Examples

Creates a new RandomGenerator object, then generates a number between 1 and 100 inclusive.

function love.load()
	rng = love.math.newRandomGenerator()
	randomNumber = rng:random(1,100)
end

See Also

Other Languages