View source for Dice/AST

{{APIdoc|Dice.AST Namespace}}
The Dice.AST namespace contains the internal nodes which constitute a dice expression in a tree form (abstract syntax tree). This tree is then evaluated in a visitor pattern to perform the roll.

== Classes ==
{| class="wikitable"
! style="width: 5em" |
! Class !! Description
|-
| {{public}} {{class}} || [[/ComparisonNode|ComparisonNode]] || Represents one or more comparisons.
|-
| {{public}} {{class}} || [[/CritNode|CritNode]] || Represents marking a die as a critical or fumble, for display purposes.
|-
| {{public}} {{class}} || [[/DiceAST|DiceAST]] || Represents a node in the dice expression Abstract Syntax Tree.
|-
| {{public}} {{class}} || [[/ExplodeNode|ExplodeNode]] || Represents dice that reroll when certain conditions are met.
|-
| {{public}} {{class}} || [[/FunctionNode|FunctionNode]] || Represents a function call, either a global function or one attached to a roll.
|-
| {{public}} {{class}} || [[/GroupNode|GroupNode]] || Represents one or more dice expressions that can be rolled multiple times as a set.
|-
| {{internal}} {{class}} || [[/GroupPartialNode|GroupPartialNode]] || An ephemeral node used in construction of the AST.
|-
| {{public}} {{class}} || [[/KeepNode|KeepNode]] || A node representing that only some of the rolled dice should be kept.
|-
| {{public}} {{class}} || [[/LiteralNode|LiteralNode]] || Represents a node which contains a literal value.
|-
| {{public}} {{class}} || [[/MacroNode|MacroNode]] || Represents a macro whose exact functionality is not specified by this library.
|-
| {{public}} {{class}} || [[/MathNode|MathNode]] || Represents a math expression on two nodes.
|-
| {{public}} {{class}} || [[/RerollNode|RerollNode]] || Represents a node in which we reroll the underlying expression should a comparison match.
|-
| {{public}} {{class}} || [[/RollNode|RollNode]] || Represents rolling one or more dice of the same type.
|-
| {{internal}} {{class}} || [[/RollPartialNode|RollPartialNode]] || An ephemeral node used in construction of the AST.
|-
| {{public}} {{class}} || [[/SortNode|SortNode]] || Represents sorting the dice rolled into a specific order.
|-
| {{public}} {{class}} || [[/SuccessNode|SuccessNode]] || Represents a roll where we count the number of successes and failures in a dice pool rather than accumulating the die rolls.
|}

== Structures ==
{| class="wikitable"
! style="width: 5em" |
! Class !! Description
|-
| {{public}} {{struct}} || [[/Comparison|Comparison]] || Holds information about a comparison, which checks a CompareOp against an expression.
|}

== Enumerations ==
{| class="wikitable"
! style="width: 5em" |
! Class !! Description
|-
| {{public}} {{enum}} || [[/CompareOp|CompareOp]] || The type of comparison to perform.
|-
| {{public}} {{enum}} || [[/ExplodeType|ExplodeType]] || The type of exploding dice.
|-
| {{public}} {{enum}} || [[/KeepType|KeepType]] || The type of a keep node.
|-
| {{public}} {{enum}} || [[/MathOp|MathOp]] || Represents the operation performed on each side of a math expression.
|-
| {{public}} {{enum}} || [[/RollType|RollType]] || How rolled values are calculated.
|-
| {{public}} {{enum}} || [[/SortDirection|SortDirection]] || Which way the dice are sorted.
|}

== Remarks ==
This namespace is mainly for internal use, however there are some public properties on each node which (once cast from their base class to the appropriate subclass) allow one to walk the tree and view each individual die roll, should such be necessary. Typically, the [[Dice/RollResult|RollResult]] class contains everything you need to know about a die roll, so walking the tree isn't necessary in general.

When deserializing a RollResult, the AST is no longer accessible (it does not get serialized along with the RollResult in order to save space, as the AST is quite large memory-wise). The AST can be reconstructed by making use of the AllRolls and AllMacros fields of a RollResult (as these fields are private, Reflection will be needed to access them, and there is no guarantee that they will not change in incompatible ways across point releases as private and internal fields are not part of the public API for semver considerations). A method to reconstruct the AST does not currently exist in the library, but if such is needed, open an issue on GitHub requesting it along with your use-case.