Dice/RollerConfig/GetRandomBytes - Revision history

Skizzerz: fix link

2023-05-18T18:00:24Z

fix link

Skizzerz at 20:27, 13 April 2017

2017-04-13T20:27:57Z

Skizzerz: Skizzerz moved page API/RollerConfig/GetRandomBytes to Dice/RollerConfig/GetRandomBytes without leaving a redirect

2017-04-09T05:22:46Z

Skizzerz moved page API/RollerConfig/GetRandomBytes to Dice/RollerConfig/GetRandomBytes without leaving a redirect

Skizzerz at 05:19, 9 April 2017

2017-04-09T05:19:55Z

Skizzerz: Created page with "{{APIdoc|RollerConfig.GetRandomBytes Property}} Gets or sets the function used to generate random numbers. {{ns}} == Syntax == public Action
2017-04-09T05:18:43Z

Created page with "{{APIdoc|RollerConfig.GetRandomBytes Property}} Gets or sets the function used to generate random numbers. {{ns}} == Syntax == <syntaxhighlight lang="C#"> public Action<byte..."

New page
{{APIdoc|RollerConfig.GetRandomBytes Property}}
Gets or sets the function used to generate random numbers.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public Action<byte[]> GetRandomBytes { get; set; }
</syntaxhighlight>

=== Property Value ===
Type: System.Action<byte[]>

The callback delegate that is used to populate die rolls.

== Remarks ==
The delegate should populate the passed-in byte array with a 4-byte value. The Length of the byte array is 4. The {{cs|BitConverter.GetBytes}} overloads may be useful should you wish to transform values of other types, such as integers, into a byte array.

If {{cs|null}}, random values will be generated via the {{cs|RNGCryptoServiceProvider.GetRandomBytes(byte[])}} method in the {{cs|System.Security.Cryptography}} namespace.

This property is used extensively by the unit-testing suite in order to provide fixed die rolls. It is exposed to applications wishing to override the default random number generator with their own version, or to fix die results as well. For example, in a play-by-post the dice should not be rerolled each time a post is previewed or edited, provided the dice expression did not change. As such, passing in a callback here which "re-rolls" the previously rolled values is one way to accomplish this functionality.

The number of sides to the die being rolled is not passed in as an argument to this callback, the resultant byte array is interpreted as a {{cs|uint}} and then converted into the proper range via modulus operations. To prevent bias, this function may be called numerous times in the course of rolling a single die should the value be outside of an even range (so that the modulus does not introduce any potential bias into the final result).

== Examples ==
The following example causes all dice to roll 9. After all, we can [http://dilbert.com/strip/2001-10-25 never be sure] about how random something truly is 😉.

<syntaxhighlight lang="C#">
use System;
use Dice;

class Sample
{
public static void Main()
{
Roller.DefaultConfig.GetRandomBytes = GetRandomBytes;
var result = Roller.Roll("2d20");
Console.WriteLine(result.Value); // writes 18
}

public static void GetRandomBytes(byte[] param)
{
BitConverter.GetBytes((uint)9).CopyTo(param, 0);
}
}
</syntaxhighlight>

@@ Line 24: / Line 24: @@
 == Examples ==
-The following example causes all dice to roll 9. After all, we can [http://dilbert.com/strip/2001-10-25 never be sure] about how random something truly is 😉.
+The following example causes all dice to roll 9. After all, we can [https://assets.amuniversal.com/321a39e06d6401301d80001dd8b71c47 never be sure] about how random something truly is 😉.
 <syntaxhighlight lang="C#">

@@ Line 21: / Line 21: @@
 This property is used extensively by the unit-testing suite in order to provide fixed die rolls. It is exposed to applications wishing to override the default random number generator with their own version, or to fix die results as well. For example, in a play-by-post the dice should not be rerolled each time a post is previewed or edited, provided the dice expression did not change. As such, passing in a callback here which "re-rolls" the previously rolled values is one way to accomplish this functionality.
-The number of sides to the die being rolled is not passed in as an argument to this callback, the resultant byte array is interpreted as a {{cs|uint}} and then converted into the proper range via modulus operations. To prevent bias, this function may be called numerous times in the course of rolling a single die should the value be outside of an even range (so that the modulus does not introduce any potential bias into the final result).
+The number of sides to the die being rolled is not passed in as an argument to this callback, the resultant byte array is interpreted as a {{cs|uint}} and then converted into the proper range via modulus operations, and addition/subtraction. To prevent bias, this function may be called numerous times in the course of rolling a single die should the value be outside of an even range (so that the modulus does not introduce any potential bias into the final result).
 == Examples ==
@@ Line 41: / Line 41: @@
      public static void GetRandomBytes(byte[] param)
+     {
-         BitConverter.GetBytes((uint)9).CopyTo(param, 0);
+        // 8 instead of 9 is intentional. For normal dice, this value will be +1 to adjust the number
+     }
+}
 </syntaxhighlight>

@@ Line 27: / Line 27: @@
 <syntaxhighlight lang="C#">
-use System;
+using System;
-use Dice;
+using Dice;
 class Sample