Skizzerz: /* Examples */

2018-12-23T17:50:33Z

Examples

Skizzerz: Created page with "{{APIdoc|RollerConfig.RollDie Property}} Gets or sets the function used to generate results when a die is rolled. {{ns}} == Syntax == public Func..."

2018-12-23T17:50:16Z

Created page with "{{APIdoc|RollerConfig.RollDie Property}} Gets or sets the function used to generate results when a die is rolled. {{ns}} == Syntax == <syntaxhighlight lang="C#"> public Func..."

New page

{{APIdoc|RollerConfig.RollDie Property}}
Gets or sets the function used to generate results when a die is rolled.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public Func<int, int, int> RollDie { get; set; }
</syntaxhighlight>

=== Property Value ===
Type: System.Func<System.Int32, System.Int32, System.Int32>

The callback delegate that is used to populate die rolls.

== Remarks ==
The delegate should take in the minimum and maximum amount to be rolled (both inclusive) and return an integer within that range.

If {{cs|null}}, the default implementation will call {{l|Dice.RollerConfig.GetRandomBytes|GetRandomBytes}} repeatedly until a non-biased answer is given, and use that as the result.

== Examples ==
The following example causes all dice to their maximum result.

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

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

public static int RollDie(int min, int max)
{
return max;
}
}
</syntaxhighlight>

@@ Line 20: / Line 20: @@
 == Examples ==
-The following example causes all dice to their maximum result.
+The following example causes all dice to roll their maximum result.
 <syntaxhighlight lang="C#">

Dice/RollerConfig/RollDie - Revision history

Skizzerz: /* Examples */

Skizzerz: Created page with "{{APIdoc|RollerConfig.RollDie Property}} Gets or sets the function used to generate results when a die is rolled. {{ns}} == Syntax == public Func..."