$Random Seed: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 7: Line 7:


<var>$Random_Seed</var> accepts two required arguments and returns zero.  
<var>$Random_Seed</var> accepts two required arguments and returns zero.  
is initialized for a series of <var>$Random</var> results that depends on '''seed_value'''.</p>


==Syntax==
==Syntax==
Line 17: Line 15:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%result</th>
<tr><th>%result</th>
<td>A %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144. </td></tr>
<td>A zero, which indicates success.</td></tr>


<tr><th>%seed</th>
<tr><th>%seed</th>
<td>A %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144. </td></tr>
<td>A %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144. <var class="term">%seed</var> is initialized for a series of <var>$Random</var> results that depends on <var class="term">seed_value</var>.</td></tr>


<tr><th>seed_value</th>
<tr><th>seed_value</th>

Revision as of 22:18, 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.
%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.

If any argument is invalid or omitted, the request is cancelled.

Examples

See the description of $Random for examples of the use of $Random_Seed.


Products authorizing $Random_Seed