< Dice‎ | Roller

Difference between revisions of "Dice/Roller/Roll (String, RollerConfig)"

From DiceRoller Documentation
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{APIdoc|Roller.Roll Method (String, RollerConfig)}}
 
Rolls dice according to the given dice expression. Please see [[Dice Reference]] for more information about dice expressions.
 
Rolls dice according to the given dice expression. Please see [[Dice Reference]] for more information about dice expressions.
−
{{APIdoc|Roller.Roll Method}}
+
 
 +
{{ns}}
  
 
== Syntax ==
 
== Syntax ==
Line 6: Line 8:
 
public static RollResult Roll(
 
public static RollResult Roll(
 
     string diceExpr,
 
     string diceExpr,
−
     RollerConfig config = null
+
     RollerConfig config
 
)
 
)
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 15: Line 17:
 
: A [[Dice Reference|dice expression]].
 
: A [[Dice Reference|dice expression]].
 
; ''config''
 
; ''config''
−
: Type: [[API/RollerConfig|Dice.RollerConfig]]
+
: Type: [[Dice/RollerConfig|Dice.RollerConfig]]
−
: Configuration to use for this roll. If {{cs|null}}, the [[API/Roller/DefaultConfig|DefaultConfig]] will be used.
+
: Configuration to use for this roll. If {{cs|null}}, the [[Dice/Roller/DefaultConfig|DefaultConfig]] will be used.
  
 
=== Return value ===
 
=== Return value ===
−
Type: [[API/RollResult|Dice.RollResult]]
+
Type: [[Dice/RollResult|Dice.RollResult]]
  
 
The result of rolling ''diceExpr''.
 
The result of rolling ''diceExpr''.
Line 29: Line 31:
 
| ArgumentNullException || ''diceExpr'' is {{cs|null}}.
 
| ArgumentNullException || ''diceExpr'' is {{cs|null}}.
 
|-
 
|-
−
| [[API/DiceException|DiceException]] || An error was detected with ''diceExpr''.
+
| [[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.
 
When a DiceException is thrown, the exception will contain an ErrorCode property which describes the error in more detail.
−
 
−
== Example ==
 
−
<syntaxhighlight lang="C#">
 
−
RollResult result = Roller.Roll("1d20+4");
 
−
Console.WriteLine(result.Value);
 
−
</syntaxhighlight>
 

Latest revision as of 20:12, 23 December 2018

Rolls dice according to the given dice expression. Please see Dice Reference for more information about dice expressions.

  • Namespace: Dice
  • Assembly: DiceRoller (in DiceRoller.dll)

Syntax

public static RollResult Roll(
    string diceExpr,
    RollerConfig config
)

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.

Retrieved from "https://skizzerz.net/DiceRoller/index.php?title=Dice/Roller/Roll_(String,_RollerConfig)&oldid=974"