Difference between revisions of "Dice/Roller/Roll (String, RollerConfig)"
From DiceRoller Documentation
m (Skizzerz moved page API/Roller/Roll to Dice/Roller/Roll without leaving a redirect) |
|||
| Line 15: | Line 15: | ||
: A [[Dice Reference|dice expression]]. | : A [[Dice Reference|dice expression]]. | ||
; ''config'' | ; ''config'' | ||
| − | : Type: [[ | + | : Type: [[Dice/RollerConfig|Dice.RollerConfig]] |
| − | : Configuration to use for this roll. If {{cs|null}}, the [[ | + | : Configuration to use for this roll. If {{cs|null}}, the [[Dice/Roller/DefaultConfig|DefaultConfig]] will be used. |
=== Return value === | === Return value === | ||
| − | Type: [[ | + | Type: [[Dice/RollResult|Dice.RollResult]] |
The result of rolling ''diceExpr''. | The result of rolling ''diceExpr''. | ||
| Line 29: | Line 29: | ||
| ArgumentNullException || ''diceExpr'' is {{cs|null}}. | | ArgumentNullException || ''diceExpr'' is {{cs|null}}. | ||
|- | |- | ||
| − | | [[ | + | | [[Dice/DiceException|DiceException]] || An error was detected with ''diceExpr''. |
|} | |} | ||
Revision as of 05:26, 9 April 2017
Rolls dice according to the given dice expression. Please see Dice Reference for more information about dice expressions.
Syntax
public static RollResult Roll(
string diceExpr,
RollerConfig config = null
)
Parameters
- diceExpr
- Type: System.String
- A dice expression.
- config
- Type: Dice.RollerConfig
- Configuration to use for this roll. If
null, the DefaultConfig will be used.
Return value
Type: Dice.RollResult
The result of rolling diceExpr.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | diceExpr is null.
|
| DiceException | An error was detected with diceExpr. |
When a DiceException is thrown, the exception will contain an ErrorCode property which describes the error in more detail.
Example
RollResult result = Roller.Roll("1d20+4");
Console.WriteLine(result.Value);
