< Dice
Revision as of 23:32, 11 April 2017 by Skizzerz (talk | contribs) (Created page with "{{APIdoc|DieType Enumeration}} Indicates what type of die was rolled for a DieResult. {{ns}} == Syntax == <syntaxhighlight lang="C#"> public enum DieType...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

DieType Enumeration

From DiceRoller Documentation

Indicates what type of die was rolled for a DieResult.

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

Syntax

public enum DieType

Members

Member name Description
Normal Die represents a roll from 1 to N, where N is the number of sides.
Fudge Die represents a roll from -N to N, where N is the number of sides.
Group Die represents a grouped roll. The number of sides is meaningless for this die type.
Literal Die represents a literal number. The number of sides is meaningless for this die type.
Special Die is not actually a roll at all, but rather a special marker. The Value can be cast into a SpecialDie enum to determine what kind of special marker it is.

Remarks

There is no DieType for functions or macros. This is because it is expected that functions or macros will add appropriate values of the above types when they need to add new dice into the final Values list. For example, a [WIS-mod] macro could add a Literal DieResult with the value of the character's Wisdom modifier.