Verse API reference page for the Shuffle function
Makes an array with the same elements as Input shuffled in a random order.
Verse using statement |
using { /Verse.org/Random } |
Shuffle<public>(Input:[]t where t:any)<transacts>:[]t
Parameters
Shuffle takes the following parameters:
| Name | Type | Description |
|---|---|---|
Input |
[]t |
|
t |
any |
Attributes, Specifiers, and Effects
Specifiers
The following specifiers determine how you can interact with Shuffle in your programs. For the complete list of specifiers, see the Specifiers Page.
| Specifier | Meaning |
|---|---|
public |
The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, methods, and data. |
Effects
The following effects determine how Shuffle behaves in your programs. For the complete list of effects, see the Effect Specifers section of the Specifiers Page.
| Effect | Meaning |
|---|---|
transacts |
This effect indicates that any actions performed by the function can be rolled back. The transacts effect is required any time a mutable variable (var) is written. You'll be notified when you compile your code if the transacts effect was added to a function that can't be rolled back. Note that this check is not done for functions with the native specifier. |