Crosstales.TrueRandom.Module.ModuleFloat Class Reference

This module will generate true random floats in configurable intervals. More...

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

Static Public Member Functions

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

Static Public Attributes

static System.Collections.Generic.List< float > Result => new System.Collections.Generic.List<float>(result)
 Returns the list of floats from the last generation. More...
 

Events

static GenerateFloatStart OnGenerateStart
 Event to get a message when generating floats has started. More...
 
static GenerateFloatFinished OnGenerateFinished
 Event to get a message with the generated floats 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 generate true random floats in configurable intervals.

Member Function Documentation

◆ Generate()

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

Generates random floats.

Parameters
minSmallest possible number (range: -1'000'000'000 - 1'000'000'000)
maxBiggest possible number (range: -1'000'000'000 - 1'000'000'000)
numberHow many numbers you want to generate (range: 1 - 10'000, default: 1, 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<float> Crosstales.TrueRandom.Module.ModuleFloat.GenerateInEditor ( float  min,
float  max,
int  number = 1,
bool  prng = false,
string  id = "" 
)
static

Generates random floats (Editor only).

Parameters
minSmallest possible number (range: -1'000'000'000 - 1'000'000'000)
maxBiggest possible number (range: -1'000'000'000 - 1'000'000'000)
numberHow many numbers you want to generate (range: 1 - 10'000, default: 1, optional)
prngUse Pseudo-Random-Number-Generator (default: false, optional)
idid to identify the generated result (optional)
Returns
List with the generated floats.

◆ GeneratePRNG()

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

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

Parameters
minSmallest possible number
maxBiggest possible number
numberHow many numbers you want to generate (default: 1, optional)
seedSeed for the PRNG (default: 0 (=standard), optional)
Returns
List with the generated floats.

Member Data Documentation

◆ Result

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

Returns the list of floats from the last generation.

Returns
List of floats from the last generation.

Event Documentation

◆ OnGenerateFinished

GenerateFloatFinished Crosstales.TrueRandom.Module.ModuleFloat.OnGenerateFinished
static

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

◆ OnGenerateStart

GenerateFloatStart Crosstales.TrueRandom.Module.ModuleFloat.OnGenerateStart
static

Event to get a message when generating floats 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/ModuleFloat.cs