< Dice
Difference between revisions of "Dice/Roller"
From DiceRoller Documentation
(create) |
m |
||
| Line 2: | Line 2: | ||
Provides a Roll method to perform dice rolls. | Provides a Roll method to perform dice rolls. | ||
| − | * '''Namespace:''' Dice | + | * '''Namespace:''' [[API/Dice|Dice]] |
* '''Assembly:''' DiceRoller (in DiceRoller.dll) | * '''Assembly:''' DiceRoller (in DiceRoller.dll) | ||
Revision as of 17:16, 8 April 2017
Provides a Roll method to perform dice rolls.
- Namespace: Dice
- Assembly: DiceRoller (in DiceRoller.dll)
Inheritance Hierarchy
System.Object
- Dice.Roller
Syntax
public static class Roller
Constructors
| Name | Description | |
|---|---|---|
| S | Roller() | Static constructor which initializes DefaultConfig. |
Properties
| Name | Description | |
|---|---|---|
| S | DefaultConfig | Gets or sets the default roller configuration. |
Methods
| Name | Description | |
|---|---|---|
| S | Roll(String, RollerConfig) | Rolls dice according to the string expression and an optional config. |
Remarks
The Roller class is the main entry point to the library, and allows you to roll dice according to a given dice expression. To customize various aspects of a roll, a configuration can be passed in.
Thread Safety
The DefaultConfig property is not thread safe. Calling Roll with a null RollerConfig will make use of the DefaultConfig property. To be thread safe, call Roll with a RollerConfig that was created just for that thread.
