$Random Seed: Difference between revisions
m (1 revision) |
m (1 revision) |
||
Line 6: | Line 6: | ||
This function sets a %variable or IMAGE item to a value that can be used by $Random, so that the series of numbers returned by $Random is reproducible. | This function sets a %variable or IMAGE item to a value that can be used by $Random, so that the series of numbers returned by $Random is reproducible. | ||
$Random_Seed accepts two required arguments and returns zero. | <var>$Random_Seed</var> accepts two required arguments and returns zero. | ||
The first argument is a %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144. | The first argument is a %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144. |
Revision as of 23:44, 18 October 2012
Build seed specifying series of $RANDOM results
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Random_Seed function is the RandomNumberGenerator class.
This function sets a %variable or IMAGE item to a value that can be used by $Random, so that the series of numbers returned by $Random is reproducible.
$Random_Seed accepts two required arguments and returns zero.
The first argument is a %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144.
The second argument specifies a number that determines the $Random series. This argument must be greater than or equal to -1,000,000,000 and less than or equal to 1,000,000,000.
Syntax
<section begin="syntax" /> %RESULT = $Random_Seed(%SEED, seed_value) <section end="syntax" />
If any argument is invalid or omitted, the request is cancelled.
See the description of $Random for examples of the use of $Random_Seed.