Difference between revisions of "Dice/Roller/Roll"
From DiceRoller Documentation
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{APIdoc|Roller.Roll Method Overloads}} | {{APIdoc|Roller.Roll Method Overloads}} | ||
| + | |||
| + | Rolls dice according to the string expression. | ||
| + | |||
| + | {{ns}} | ||
| + | |||
| + | == Overloads == | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 5: | Line 11: | ||
! Name !! Description | ! Name !! Description | ||
|- | |- | ||
| − | | {{public}} {{static}} {{method}} || [[ | + | | {{public}} {{static}} {{method}} || [[../Roll (String)|Roll(String)]] || Rolls dice according to the string expression, using the default configuration. |
|- | |- | ||
| − | | {{public}} {{static}} {{method}} || [[ | + | | {{public}} {{static}} {{method}} || [[../Roll (String, RollerConfig)|Roll(String, RollerConfig)]] || Rolls dice according to the string expression and configuration. |
| + | |- | ||
| + | | {{public}} {{static}} {{method}} || [[../Roll (String, RollerConfig, RollData)|Roll(String, RollerConfig, RollData)]] || Rolls dice according to the string expression and configuration and with the given {{l|Dice.RollData|RollData}}. | ||
| + | |- | ||
| + | || {{internal}} {{static}} {{method}} || [[../Roll (DiceAST, RollerConfig)|Roll(DiceAST, RollerConfig)]] || Evaluates the root of the tree, returning the RollResult. | ||
|} | |} | ||
| + | |||
| + | == Remarks == | ||
| + | {{cs|null}} can be passed as RollerConfig for the second and third overloads. This is equivalent to specifying {{cs|RollerConfig.DefaultConfig}} for those parameters. {{cs|null}} can be passed as RollData for the third overload. This is equivalent to calling the second overload and no user-defined data is associated with the roll. | ||
Latest revision as of 20:15, 23 December 2018
Rolls dice according to the string expression.
- Namespace: Dice
- Assembly: DiceRoller (in DiceRoller.dll)
Overloads
| Name | Description | |
|---|---|---|
| S | Roll(String) | Rolls dice according to the string expression, using the default configuration. |
| S | Roll(String, RollerConfig) | Rolls dice according to the string expression and configuration. |
| S | Roll(String, RollerConfig, RollData) | Rolls dice according to the string expression and configuration and with the given RollData. |
| S | Roll(DiceAST, RollerConfig) | Evaluates the root of the tree, returning the RollResult. |
Remarks
null can be passed as RollerConfig for the second and third overloads. This is equivalent to specifying RollerConfig.DefaultConfig for those parameters. null can be passed as RollData for the third overload. This is equivalent to calling the second overload and no user-defined data is associated with the roll.
