Dice/Roller/Roll (String, RollerConfig)

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);