$Random_Seed

From m204wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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.

Products authorizing $Random_Seed