Crosstales.TrueRandom.Module.ModuleSequence Class Reference

This module will randomize a given interval of integers, i.e. arrange them in random order. More...

Inheritance diagram for Crosstales.TrueRandom.Module.ModuleSequence:
Crosstales.TrueRandom.Module.BaseModule

Static Public Member Functions

static System.Collections.IEnumerator Generate (int min, int max, int number=0, bool prng=false, bool silent=false, string id="")
 Generates random sequence. More...
 
static System.Collections.Generic.List< int > GeneratePRNG (int min, int max, int number=0, int seed=0)
 Generates a random sequence with the C#-standard Pseudo-Random-Number-Generator. More...
 
static System.Collections.Generic.List< int > GenerateInEditor (int min, int max, int number=0, bool prng=false, string id="")
 Generates random sequence (Editor only). More...
 

Static Public Attributes

static System.Collections.Generic.List< int > Result => new System.Collections.Generic.List<int>(result)
 Returns the sequence from the last generation. More...
 

Events

static GenerateSequenceStart OnGenerateStart
 Event to get a message when generating sequence has started. More...
 
static GenerateSequenceFinished OnGenerateFinished
 Event to get a message with the generated sequence when finished. More...
 
- Events inherited from Crosstales.TrueRandom.Module.BaseModule
static ErrorInfo OnErrorInfo
 Event to get a message when an error occured. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from Crosstales.TrueRandom.Module.BaseModule
static void onErrorInfo (string errorInfo, string id)
 
- Static Protected Attributes inherited from Crosstales.TrueRandom.Module.BaseModule
const int timeout = 5
 

Detailed Description

This module will randomize a given interval of integers, i.e. arrange them in random order.

Member Function Documentation

◆ Generate()

static System.Collections.IEnumerator Crosstales.TrueRandom.Module.ModuleSequence.Generate ( int  min,
int  max,
int  number = 0,
bool  prng = false,
bool  silent = false,
string  id = "" 
)
static

Generates random sequence.

Parameters
minStart of the interval (range: -1'000'000'000 - 1'000'000'000)
maxEnd of the interval (range: -1'000'000'000 - 1'000'000'000)
numberHow many numbers you have in the result (max range: max - min, optional)
prngUse Pseudo-Random-Number-Generator (default: false, optional)
silentIgnore callbacks (default: false, optional)
idid to identify the generated result (optional)

◆ GenerateInEditor()

static System.Collections.Generic.List<int> Crosstales.TrueRandom.Module.ModuleSequence.GenerateInEditor ( int  min,
int  max,
int  number = 0,
bool  prng = false,
string  id = "" 
)
static

Generates random sequence (Editor only).

Parameters
minStart of the interval (range: -1'000'000'000 - 1'000'000'000)
maxEnd of the interval (range: -1'000'000'000 - 1'000'000'000)
numberHow many numbers you have in the result (max range: max - min, optional)
prngUse Pseudo-Random-Number-Generator (default: false, optional)
idid to identify the generated result (optional)
Returns
List with the generated sequence.

◆ GeneratePRNG()

static System.Collections.Generic.List<int> Crosstales.TrueRandom.Module.ModuleSequence.GeneratePRNG ( int  min,
int  max,
int  number = 0,
int  seed = 0 
)
static

Generates a random sequence with the C#-standard Pseudo-Random-Number-Generator.

Parameters
minStart of the interval
maxEnd of the interval
numberHow many numbers you have in the result (max range: max - min, optional)
seedSeed for the PRNG (default: 0 (=standard), optional)
Returns
List with the generated sequence.

Member Data Documentation

◆ Result

System.Collections.Generic.List<int> Crosstales.TrueRandom.Module.ModuleSequence.Result => new System.Collections.Generic.List<int>(result)
static

Returns the sequence from the last generation.

Returns
Sequence from the last generation.

Event Documentation

◆ OnGenerateFinished

GenerateSequenceFinished Crosstales.TrueRandom.Module.ModuleSequence.OnGenerateFinished
static

Event to get a message with the generated sequence when finished.

◆ OnGenerateStart

GenerateSequenceStart Crosstales.TrueRandom.Module.ModuleSequence.OnGenerateStart
static

Event to get a message when generating sequence has started.


The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/TrueRandom/TrueRandomPro/Assets/Plugins/crosstales/TrueRandom/Scripts/Module/ModuleSequence.cs