Skizzerz: /* Members */

2017-04-17T19:15:57Z

Members

Skizzerz: /* Members */

2017-04-17T18:23:48Z

Members

Skizzerz: Created page with "{{APIdoc|SpecialDie Enumeration}} Indicates what type of special die the result is. {{ns}} == Syntax == public enum SpecialDie ..."

2017-04-12T16:44:33Z

Created page with "{{APIdoc|SpecialDie Enumeration}} Indicates what type of special die the result is. {{ns}} == Syntax == <syntaxhighlight lang="C#"> public enum SpecialDie </syntaxhighlight>..."

New page

{{APIdoc|SpecialDie Enumeration}}
Indicates what type of special die the result is.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public enum SpecialDie
</syntaxhighlight>

== Members ==
{| class="wikitable"
! Member name !! Description
|-
| Add || Represents an addition operation.
|-
| Subtract || Represents a subtraction operation.
|-
| Multiply || Represents a multiplication operation.
|-
| Divide || Represents a division operation.
|-
| OpenParen || Represents the beginning of a parenthetical expression.
|-
| CloseParen || Represents the end of a parenthetical expression.
|}

== Remarks ==
Some [[Dice/DieResult|DieResults]] indicate that they are special dice rather than actual rolls. This enumeration indicates what type of special die the result is. Special dice are used as guidance for display, such as open/close parenthesis when nested math expressions are rolled so that the user can see the dice displayed in the same format as they were specified.

When implementing a custom function, special dice would normally be passed as-is into the final Values of your function. Add any special dice that are needed in order to make the resulting display unambiguous and grouped according to the dice expression.

== Examples ==
For example, if the dice expression {{c|(2d20 + 2) * 1.5}} is rolled, and a 6 and 8 are rolled on the d20, the Values of the resulting roll will be the following (in order):
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.SpecialDie, NumSides = 0, Value = SpecialDie.OpenParen, Flags = 0 <nowiki>}</nowiki>}}
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.Normal, NumSides = 20, Value = 6, Flags = 0 <nowiki>}</nowiki>}}
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.SpecialDie, NumSides = 0, Value = SpecialDie.Add, Flags = 0 <nowiki>}</nowiki>}}
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.Normal, NumSides = 20, Value = 8, Flags = 0 <nowiki>}</nowiki>}}
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.SpecialDie, NumSides = 0, Value = SpecialDie.Add, Flags = 0 <nowiki>}</nowiki>}}
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.Literal, NumSides = 0, Value = 2, Flags = 0 <nowiki>}</nowiki>}}
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.SpecialDie, NumSides = 0, Value = SpecialDie.CloseParen, Flags = 0 <nowiki>}</nowiki>}}
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.SpecialDie, NumSides = 0, Value = SpecialDie.Multiply, Flags = 0 <nowiki>}</nowiki>}}
# {{cs|1=<nowiki>{</nowiki> DieType = DieType.Literal, NumSides = 0, Value = 1.5, Flags = 0 <nowiki>}</nowiki>}}

The code snippet on [[Dice/RollResult/Values|RollResult.Values]] demonstrates how to iterate over the above result to display the string "(6 + 8 + 2) * 1.5".

@@ Line 26: / Line 26: @@
 |-
 | Negate || Represents a unary negation operation.
 |}

@@ Line 24: / Line 24: @@
 |-
 | CloseParen || Represents the end of a parenthetical expression.
 |}

Dice/SpecialDie - Revision history

Skizzerz: /* Members */

Skizzerz: /* Members */

Skizzerz: Created page with "{{APIdoc|SpecialDie Enumeration}} Indicates what type of special die the result is. {{ns}} == Syntax == public enum SpecialDie ..."