Interface IRandomProvider

Namespace: GDX.Mathematics.Random

Syntax

[VisualScriptingCompatible((short)4)]
public interface IRandomProvider

Methods

| Improve this Doc View Source

NextBoolean(Single)

Returns a pseudorandom System.Boolean value based on chance, favoring false, with a default 50% chance.

Declaration

bool NextBoolean(float chance = 0.5F)

Parameters

Type	Name	Description
System.Single	chance	The 0-1 System.Single percent chance of success.

Returns

Type	Description
System.Boolean	A pseudorandom System.Boolean.

| Improve this Doc View Source

NextBytes(Byte[])

Fills a buffer with pseudorandom System.Byte.

Declaration

void NextBytes(byte[] buffer)

Parameters

Type	Name	Description
System.Byte[]	buffer	The buffer to fill.

Remarks

The buffer shouldn't be null.

| Improve this Doc View Source

NextDouble(Double, Double)

Returns the next pseudorandom System.Double between minValue and less then maxValue.

Declaration

double NextDouble(double minValue = 0, double maxValue = 1)

Parameters

Type	Name	Description
System.Double	minValue	The lowest possible value (inclusive).
System.Double	maxValue	The highest possible value (exclusive).

Returns

Type	Description
System.Double	A pseudorandom System.Double.

Remarks

Distribution of values falls within a linear scale. minValue should not be greater then maxValue.

| Improve this Doc View Source

NextInteger(Int32, Int32)

Returns the next pseudorandom System.Int32 between minValue and maxValue.

Declaration

int NextInteger(int minValue = 0, int maxValue = 2147483647)

Parameters

Type	Name	Description
System.Int32	minValue	The lowest possible value.
System.Int32	maxValue	The highest possible value, including itself.

Returns

Type	Description
System.Int32	A pseudorandom System.Int32.

Remarks

Distribution of values falls within a linear scale. minValue should not be greater then maxValue. Never pass System.Int32.MaxValue to maxValue.

| Improve this Doc View Source

NextIntegerExclusive(Int32, Int32)

Returns the next pseudorandom System.Int32 between minValue and maxValue, excluding maxValue itself.

Declaration

int NextIntegerExclusive(int minValue = 0, int maxValue = 2147483647)

Parameters

Type	Name	Description
System.Int32	minValue	The lowest possible value.
System.Int32	maxValue	The highest possible value, excluding itself.

Returns

Type	Description
System.Int32	A pseudorandom System.Int32.

Remarks

Distribution of values falls within a linear scale. minValue should not be greater then maxValue.

| Improve this Doc View Source

NextSingle(Single, Single)

Returns the next pseudorandom System.Single between minValue and less then maxValue.

Declaration

float NextSingle(float minValue = 0F, float maxValue = 1F)

Parameters

Type	Name	Description
System.Single	minValue	The lowest possible value (inclusive).
System.Single	maxValue	The highest possible value (exclusive).

Returns

Type	Description
System.Single	A pseudorandom System.Single.

Remarks

Distribution of values falls within a linear scale. minValue should not be greater then maxValue.

| Improve this Doc View Source

NextUnsignedInteger(UInt32, UInt32)

Returns the next pseudorandom System.UInt32 between minValue and maxValue.

Declaration

uint NextUnsignedInteger(uint minValue = 0U, uint maxValue = 4294967295U)

Parameters

Type	Name	Description
System.UInt32	minValue	The lowest possible value.
System.UInt32	maxValue	The highest possible value, including itself.

Returns

Type	Description
System.UInt32	A pseudorandom System.UInt32.

Remarks

Distribution of values falls within a linear scale. minValue should not be greater then maxValue. Never pass System.UInt32.MaxValue to maxValue.

| Improve this Doc View Source

NextUnsignedIntegerExclusive(UInt32, UInt32)

Returns the next pseudorandom System.UInt32 between minValue and maxValue, excluding maxValue itself.

Declaration

uint NextUnsignedIntegerExclusive(uint minValue = 0U, uint maxValue = 4294967295U)

Parameters

Type	Name	Description
System.UInt32	minValue	The lowest possible value.
System.UInt32	maxValue	The highest possible value, excluding itself.

Returns

Type	Description
System.UInt32	A pseudorandom System.UInt32.

Remarks

Distribution of values falls within a linear scale. minValue should not be greater then maxValue.

| Improve this Doc View Source

Sample()

Returns the next pseudorandom System.Double value, between 0.0 and 1.0.

Declaration

double Sample()

Returns

Type	Description
System.Double	A pseudorandom System.Double floating point value.