Dice/Roller/DefaultConfig - Revision history

Skizzerz at 05:25, 9 April 2017

2017-04-09T05:25:24Z

Skizzerz: Skizzerz moved page API/Roller/DefaultConfig to Dice/Roller/DefaultConfig without leaving a redirect

2017-04-09T05:22:32Z

Skizzerz moved page API/Roller/DefaultConfig to Dice/Roller/DefaultConfig without leaving a redirect

Skizzerz: Created page with "{{APIdoc|Roller.DefaultConfig Property}} Gets or sets the default configuration used when rolling dice expressions. * '''Namespace:''' Dice * '''Assembly:''' Dic..."

2017-04-08T20:43:21Z

Created page with "{{APIdoc|Roller.DefaultConfig Property}} Gets or sets the default configuration used when rolling dice expressions. * '''Namespace:''' Dice * '''Assembly:''' Dic..."

New page

{{APIdoc|Roller.DefaultConfig Property}}
Gets or sets the default configuration used when rolling dice expressions.

* '''Namespace:''' [[API/Dice|Dice]]
* '''Assembly:''' DiceRoller (in DiceRoller.dll)

== Syntax ==
<syntaxhighlight lang="C#">
public static RollerConfig DefaultConfig { get; set; }
</syntaxhighlight>

=== Property Value ===
Type: [[API/RollerConfig|Dice.RollerConfig]]

The default configuration.

== Remarks ==
When [[API/Roller/Roll|Roller.Roll]] is called with a {{cs|null}} ''config'' argument, the DefaultConfig is used. Setting this property therefore allows you to modify the behavior of many dice rolls without needing to remember to explicitly pass a configuration object. This property is initialized in Roller's static constructor to be default values.

== Examples ==
The following example demonstrates setting a custom default configuration.

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

class Sample
{
public static void Main()
{
Roller.DefaultConfig = new RollerConfig()
{
NormalSidesOnly = true // restrict to rolling only "normal" die sizes
};

var result = Roller.Roll("1d19"); // throws a DiceException with DiceErrorCode.WrongSides
}
}
</syntaxhighlight>

@@ Line 2: / Line 2: @@
 Gets or sets the default configuration used when rolling dice expressions.
-* '''Namespace:''' [[API/Dice|Dice]]
+{{ns}}
 == Syntax ==
@@ Line 11: / Line 10: @@
 === Property Value ===
-Type: [[API/RollerConfig|Dice.RollerConfig]]
+Type: [[Dice/RollerConfig|Dice.RollerConfig]]
 The default configuration.
 == Remarks ==
-When [[API/Roller/Roll|Roller.Roll]] is called with a {{cs|null}} ''config'' argument, the DefaultConfig is used. Setting this property therefore allows you to modify the behavior of many dice rolls without needing to remember to explicitly pass a configuration object. This property is initialized in Roller's static constructor to be default values.
+When [[Dice/Roller/Roll|Roller.Roll]] is called with a {{cs|null}} ''config'' argument, the DefaultConfig is used. Setting this property therefore allows you to modify the behavior of many dice rolls without needing to remember to explicitly pass a configuration object. This property is initialized in Roller's static constructor to be default values.
 == Examples ==