Skizzerz at 21:44, 14 August 2017

2017-08-14T21:44:00Z

Skizzerz: Created page with "{{APIdoc|DiceAST.Evaluate Method (RollerConfig, DiceAST, Int32)}} Evaluates the node, causing it to store its result in Value. {{ns}} == Syntax ==
2017-05-02T18:57:27Z

Created page with "{{APIdoc|DiceAST.Evaluate Method (RollerConfig, DiceAST, Int32)}} Evaluates the node, causing it to store its result in [[../Value|Value]]. {{ns}} == Syntax == <syntaxhighli..."

New page
{{APIdoc|DiceAST.Evaluate Method (RollerConfig, DiceAST, Int32)}}
Evaluates the node, causing it to store its result in [[../Value|Value]].

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
protected internal long Evaluate(
RollerConfig conf,
DiceAST root,
int depth
)
</syntaxhighlight>

=== Parameters ===
; ''conf''
: Type: [[Dice/RollerConfig|Dice.RollerConfig]]
: Configuration of the roller.

; ''root''
: Type: [[Dice/AST/DiceAST|Dice.AST.DiceAST]]
: Root of the AST.

; ''depth''
: Type: System.Int32
: Current recursion depth.

=== Return Value ===
Type: System.Int64

Total number of rolls taken to evaluate this subtree.

== Remarks ==
This method is responsible for evaluating an AST, and tracks things like recursion depth and total number of rolls (throwing DiceException if they get too high). It calls [[../EvaluateInternal|EvaluateInternal]] to actually perform the evaluation logic (as this method is not virtual). After this method succeeds, [[../Evaluated|Evaluated]] is set to {{cs|true}} on the node.

When a subclass is inside of EvaluateInternal, it should call Evaluate on any child nodes it has before executing its own logic. These calls should typically increase the depth by 1.

== Examples ==
The following example implements a new subclass of DiceAST which evaluates child nodes in its own evaluation process.

<syntaxhighlight lang="C#">
using System.Text;
using System.Collections.Generic;
using Dice.AST;

class MyNode : DiceAST
{
private List<DieResult> _values = new List<DieResult>();

public DiceAST Child { get; private set; }
public override IReadOnlyList<DieResult> Values => _values;

public MyNode(DiceAST child)
{
Child = child ?? throw new ArgumentNullException(nameof(child));
}

public override string ToString()
{
StringBuilder sb = new StringBuilder();
bool needParens = Child.UnderlyingRollNode is MathNode;

if (needParens)
{
sb.Append("(");
}

sb.Append(Child.ToString());

if (needParens)
{
sb.Append(")");
}

sb.Append("++");

return sb.ToString();
}

protected override long EvaluateInternal(RollerConfig conf, DiceAST root, int depth)
{
long numRolls = Child.Evaluate(conf, root, depth + 1);
MyCustomLogic();

return numRolls;
}

protected override long RerollInternal(RollerConfig conf, DiceAST root, int depth)
{
long numRolls = Child.Reroll(conf, root, depth + 1);
MyCustomLogic();

return numRolls;
}

private void MyCustomLogic()
{
Value = Child.Value + 1;
ValueType = ResultType.Total;
_values.Clear();
_values.Add(new DieResult()
{
DieType = DieType.Literal,
NumSides = 0,
Value = Value,
Flags = 0
});
}
}
</syntaxhighlight>

@@ Line 1: / Line 1: @@
-{{APIdoc|DiceAST.Evaluate Method (RollerConfig, DiceAST, Int32)}}
+{{APIdoc|DiceAST.Evaluate Method (RollData, DiceAST, Int32)}}
 Evaluates the node, causing it to store its result in [[../Value|Value]].
@@ Line 7: / Line 7: @@
 <syntaxhighlight lang="C#">
 protected internal long Evaluate(
-     RollerConfig conf,
+     RollData data,
      DiceAST root,
      int depth
@@ Line 14: / Line 14: @@
 === Parameters ===
-; ''conf''
+; ''data''
-: Type: [[Dice/RollerConfig|Dice.RollerConfig]]
+: Type: {{l|Dice.RollData}}
-: Configuration of the roller.
+: Configuration of the roller and roll-specific data.
 ; ''root''
@@ Line 78: / Line 78: @@
+     }
-     protected override long EvaluateInternal(RollerConfig conf, DiceAST root, int depth)
+     protected override long EvaluateInternal(RollData data, DiceAST root, int depth)
+     {
-         long numRolls = Child.Evaluate(conf, root, depth + 1);
+         long numRolls = Child.Evaluate(data, root, depth + 1);
          MyCustomLogic();
@@ Line 86: / Line 86: @@
+     }
-     protected override long RerollInternal(RollerConfig conf, DiceAST root, int depth)
+     protected override long RerollInternal(RollData data, DiceAST root, int depth)
+     {
-         long numRolls = Child.Reroll(conf, root, depth + 1);
+         long numRolls = Child.Reroll(data, root, depth + 1);
          MyCustomLogic();