Dice/AST/DiceAST - Revision history

Skizzerz at 21:42, 14 August 2017

2017-08-14T21:42:39Z

Skizzerz: /* Methods */

2017-05-01T22:52:43Z

Methods

Skizzerz: /* Methods */ additional framework for eventually implementing custom AST nodes

2017-05-01T21:39:14Z

Methods: additional framework for eventually implementing custom AST nodes

Skizzerz at 20:01, 1 May 2017

2017-05-01T20:01:21Z

Skizzerz: /* Methods */

2017-05-01T19:45:05Z

Methods

Skizzerz: /* Remarks */

2017-05-01T19:44:27Z

Remarks

Skizzerz: /* Properties */

2017-04-20T23:05:17Z

Properties

Skizzerz: Created page with "{{APIdoc|DiceAST Class}} Represents a node in the dice expression Abstract Syntax Tree. {{ns|AST}} == Inheritance Hierarchy == System.Object : Dice.AST.DiceAST == Syntax ==..."

2017-04-20T23:05:09Z

Created page with "{{APIdoc|DiceAST Class}} Represents a node in the dice expression Abstract Syntax Tree. {{ns|AST}} == Inheritance Hierarchy == System.Object : Dice.AST.DiceAST == Syntax ==..."

New page

{{APIdoc|DiceAST Class}}
Represents a node in the dice expression Abstract Syntax Tree.

{{ns|AST}}

== Inheritance Hierarchy ==
System.Object
: Dice.AST.DiceAST

== Syntax ==
<syntaxhighlight lang="C#">
public abstract class DiceAST
</syntaxhighlight>

== Methods ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{internal}} {{method}} || [[/Evaluate|Evaluate(RollerConfig, DiceAST, Int32)]] || Evaluates the node, causing it to store its result in Value.
|-
| {{protected}} {{method}} || [[/EvaluateInternal|EvaluateInternal(RollerConfig, DiceAST, Int32)]] || Actual evaluation logic, implemented by each subclass.
|-
| {{internal}} {{method}} || [[/GetUnderlyingRollNode|GetUnderlyingRollNode()]] || Gets the roll node underneath this node, unless this node is a roll node of some sort.
|-
| {{internal}} {{method}} || [[/Reroll|Reroll(RollerConfig, DiceAST, Int32)]] || Re-do the roll without re-evaluating the entire subtree again.
|-
| {{protected}} {{method}} || [[/RerollInternal|RerollInternal(RollerConfig, DiceAST, Int32)]] || Actual reroll logic, implemented by each subclass.
|-
| {{public}} {{method}} || [[/ToString|ToString()]] || Retrieves a normalized representation of the dice expression.
|}

== Properties ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{public}} {{property}} || [[/Evaluated|Evaluated]] || Gets whether or not this node has been evaluated.
|-
| {{public}} {{property}} || [[/Value|Value]] || Gets the final value of the node.
|-
| {{public}} {{property}} || [[/Values|Values]] || Gets the underlying dice that were rolled, as well as their values.
|-
| {[public}} {{property}} || [[/ValueType|ValueType]] || Gets what type of value we have (total or successes).
|}

== Remarks ==
The DiceAST class and its subclasses implement the AST from the parser. As it is not possible to extend the parser outside of the assembly, it does not make sense to make any additional subclasses of DiceAST. As such, the public API for DiceAST and its descendants are only its public methods and properties. Protected methods are considered to be part of the internal API and can change without warning even across minor or patch versions (unlike for other classes, where protected members are considered part of the public API).

@@ Line 18: / Line 18: @@
 ! Name !! Description
 |-
-| {{protected}} {{method}} || [[/Evaluate|Evaluate(RollerConfig, DiceAST, Int32)]] || Evaluates the node, causing it to store its result in Value.
+| {{protected}} {{method}} || [[/Evaluate|Evaluate(RollData, DiceAST, Int32)]] || Evaluates the node, causing it to store its result in Value.
 |-
-| {{protected}} {{method}} || [[/EvaluateInternal|EvaluateInternal(RollerConfig, DiceAST, Int32)]] || Actual evaluation logic, implemented by each subclass.
+| {{protected}} {{method}} || [[/EvaluateInternal|EvaluateInternal(RollData, DiceAST, Int32)]] || Actual evaluation logic, implemented by each subclass.
 |-
-| {{protected}} {{method}} || [[/Reroll|Reroll(RollerConfig, DiceAST, Int32)]] || Re-do the roll without re-evaluating the entire subtree again.
+| {{protected}} {{method}} || [[/Reroll|Reroll(RollData, DiceAST, Int32)]] || Re-do the roll without re-evaluating the entire subtree again.
 |-
-| {{protected}} {{method}} || [[/RerollInternal|RerollInternal(RollerConfig, DiceAST, Int32)]] || Actual reroll logic, implemented by each subclass.
+| {{protected}} {{method}} || [[/RerollInternal|RerollInternal(RollData, DiceAST, Int32)]] || Actual reroll logic, implemented by each subclass.
 |-
 | {{public}} {{method}} || [[/ToString|ToString()]] || Retrieves a normalized representation of the dice expression. Overridden from Object.ToString.

← Older revision		Revision as of 19:44, 1 May 2017
Line 46:		Line 46:

	== Remarks ==		== Remarks ==
−	The DiceAST class and its subclasses implement the AST from the parser. As it is not possible to extend the parser outside of the assembly, it does not make sense to make any additional subclasses of DiceAST. As such, the public API for DiceAST and its descendants are only its public methods and properties. Protected methods are considered to be part of the internal API and can change without warning even across minor or patch versions (unlike for other classes, where protected members are considered part of the public API).	+	The DiceAST class and its subclasses implement the AST from the parser.

@@ Line 21: / Line 21: @@
 |-
 | {{protected}} {{method}} || [[/EvaluateInternal|EvaluateInternal(RollerConfig, DiceAST, Int32)]] || Actual evaluation logic, implemented by each subclass.
 |-
 | {{internal}} {{method}} || [[/Reroll|Reroll(RollerConfig, DiceAST, Int32)]] || Re-do the roll without re-evaluating the entire subtree again.
@@ Line 37: / Line 35: @@
 |-
 | {{public}} {{property}} || [[/Evaluated|Evaluated]] || Gets whether or not this node has been evaluated.
 |-
 | {{public}} {{property}} || [[/Value|Value]] || Gets the final value of the node.

@@ Line 22: / Line 22: @@
 | {{protected}} {{method}} || [[/EvaluateInternal|EvaluateInternal(RollerConfig, DiceAST, Int32)]] || Actual evaluation logic, implemented by each subclass.
 |-
-| {{internal}} {{method}} || [[/GetUnderlyingRollNode|GetUnderlyingRollNode()]] || Gets the roll node underneath this node, unless this node is a roll node of some sort.
+| {{protected}} {{method}} || [[/GetUnderlyingRollNode|GetUnderlyingRollNode()]] || Gets the roll node underneath this node, unless this node is a roll node of some sort.
 |-
 | {{internal}} {{method}} || [[/Reroll|Reroll(RollerConfig, DiceAST, Int32)]] || Re-do the roll without re-evaluating the entire subtree again.

@@ Line 42: / Line 42: @@
 | {{public}} {{property}} || [[/Values|Values]] || Gets the underlying dice that were rolled, as well as their values.
 |-
-| {[public}} {{property}} || [[/ValueType|ValueType]] || Gets what type of value we have (total or successes).
+| {{public}} {{property}} || [[/ValueType|ValueType]] || Gets what type of value we have (total or successes).
 |}
 == Remarks ==
 The DiceAST class and its subclasses implement the AST from the parser. As it is not possible to extend the parser outside of the assembly, it does not make sense to make any additional subclasses of DiceAST. As such, the public API for DiceAST and its descendants are only its public methods and properties. Protected methods are considered to be part of the internal API and can change without warning even across minor or patch versions (unlike for other classes, where protected members are considered part of the public API).