$Random Seed: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
(Automatically generated page update) |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle">Build seed specifying series of <var>$RANDOM</var> results</span> | <span class="pageSubtitle">Build seed specifying series of <var>$RANDOM</var> results</span> | ||
<p class="warn"><b>Note: </b> | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Random_Seed function is the [[RandomNumberGenerator class]].</p> | ||
This function sets a %variable or IMAGE item to a value that can be used by <var>[[$Random]]</var>, so that the series of numbers returned by <var>$Random</var> is reproducible. | This function sets a %variable or IMAGE item to a value that can be used by <var>[[$Random]]</var>, so that the series of numbers returned by <var>$Random</var> is reproducible. |
Latest revision as of 22:52, 20 September 2018
Build seed specifying series of $RANDOM results
Note: Many $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.
Syntax
%result = $Random_Seed(%seed, seed_value)
Syntax terms
%result | A zero, which indicates success.
If any argument is invalid or omitted, the request is cancelled. |
---|---|
%seed | A %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144. %seed is initialized for a series of $Random results that depends on seed_value. |
seed_value | 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. |
Examples
See the description of $Random for examples of the use of $Random_Seed.