Skizzerz: Created page with "{{APIdoc|Roller.Roll Method (String, RollerConfig, RollData)}} Rolls dice according to the given dice expression and with the given RollData. Please see Dice Reference for..."

2018-12-23T20:12:47Z

Created page with "{{APIdoc|Roller.Roll Method (String, RollerConfig, RollData)}} Rolls dice according to the given dice expression and with the given RollData. Please see Dice Reference for..."

New page

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

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public static RollResult Roll(
string diceExpr,
RollerConfig config,
RollData data
)
</syntaxhighlight>

=== Parameters ===
; ''diceExpr''
: Type: System.String
: A [[Dice Reference|dice expression]].
; ''config''
: Type: [[Dice/RollerConfig|Dice.RollerConfig]]
: Configuration to use for this roll. If {{cs|null}}, the [[Dice/Roller/DefaultConfig|DefaultConfig]] will be used.
; ''data''
: Type: {{l|Dice.RollData|Dice.RollData}}
: Additional data that is scoped to this roll.

=== 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.

Dice/Roller/Roll (String, RollerConfig, RollData) - Revision history

Skizzerz: Created page with "{{APIdoc|Roller.Roll Method (String, RollerConfig, RollData)}} Rolls dice according to the given dice expression and with the given RollData. Please see Dice Reference for..."