$Random Seed: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Syntax terms) |
||
Line 15: | Line 15: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%result</th> | <tr><th>%result</th> | ||
<td>A zero, which indicates success.</td></tr> | <td>A zero, which indicates success. | ||
If any argument is invalid or omitted, the request is cancelled. | |||
</td></tr> | |||
<tr><th>%seed</th> | <tr><th>%seed</th> | ||
Line 23: | Line 25: | ||
<td>A number that determines the <var>$Random</var> series. This argument must be greater than or equal to -1,000,000,000 and less than or equal to 1,000,000,000.</td></tr> | <td>A number that determines the <var>$Random</var> series. This argument must be greater than or equal to -1,000,000,000 and less than or equal to 1,000,000,000.</td></tr> | ||
</table> | </table> | ||
==Examples== | ==Examples== |
Revision as of 22:19, 24 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.
Syntax
<section begin="syntax" />%result = $Random_Seed(%seed, seed_value) <section end="syntax" />
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.