Skizzerz: Created page with "{{APIdoc|Roller.Roll Method (String)}} Rolls dice according to the given dice expression. Please see Dice Reference for more information about dice expressions. {{ns}} =..."

2017-04-13T19:27:24Z

Created page with "{{APIdoc|Roller.Roll Method (String)}} Rolls dice according to the given dice expression. Please see Dice Reference for more information about dice expressions. {{ns}} =..."

New page

{{APIdoc|Roller.Roll Method (String)}}
Rolls dice according to the given dice expression. Please see [[Dice Reference]] for more information about dice expressions.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public static RollResult Roll(
string diceExpr
)
</syntaxhighlight>

=== Parameters ===
; ''diceExpr''
: Type: System.String
: A [[Dice Reference|dice expression]].

=== Return value ===
Type: [[Dice/RollResult|Dice.RollResult]]

The result of rolling ''diceExpr''.

== Exceptions ==
{| class="wikitable"
! Exception !! Condition
|-
| ArgumentNullException || ''diceExpr'' is {{cs|null}}.
|-
| [[Dice/DiceException|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.

== Remarks ==
This is equivalent to calling [[../Roll (String, RollerConfig)|Roller.Roll(String, RollerConfig)]] with a {{cs|null}} value for ''config''. See the [[../Roll|Roll overload page]] for more details.

== Example ==
<syntaxhighlight lang="C#">
RollResult result = Roller.Roll("1d20+4");
Console.WriteLine(result.Value);
</syntaxhighlight>

Dice/Roller/Roll (String) - Revision history

Skizzerz: Created page with "{{APIdoc|Roller.Roll Method (String)}} Rolls dice according to the given dice expression. Please see Dice Reference for more information about dice expressions. {{ns}} =..."