Dice/RollResult/Values - Revision history

Skizzerz: /* Examples */

2017-04-14T03:00:30Z

Examples

Skizzerz: /* Examples */

2017-04-14T02:59:26Z

Examples

Skizzerz: /* Examples */ I realize now that omitting add dice was a dumb idea

2017-04-10T22:44:21Z

Examples: I realize now that omitting add dice was a dumb idea

Skizzerz: /* Examples */

2017-04-10T22:42:12Z

Examples

Skizzerz: Created page with "{{APIdoc|RollResult.Values Property}} Gets the results of each individual die rolled. {{ns}} == Syntax == public IReadOnlyList Values..."

2017-04-10T22:41:25Z

Created page with "{{APIdoc|RollResult.Values Property}} Gets the results of each individual die rolled. {{ns}} == Syntax == <syntaxhighlight lang="C#"> public IReadOnlyList<DieResult> Values..."

New page

{{APIdoc|RollResult.Values Property}}
Gets the results of each individual die rolled.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public IReadOnlyList<DieResult> Values { get; private set; }
</syntaxhighlight>

=== Property Value ===
Type: System.Collections.Generic.IReadOnlyList<[[Dice/DieResult|Dice.DieResult]]>

The values of the individual dice rolled.

== Remarks ==
This is not necessarily all dice rolled, just the ones that are exposed to the user. For example, in {{c|(1d8)d6}}, 1d8 is rolled, and that many d6s are rolled. Values will only contain the results of the d6s. Inspecting the d8 requires walking the AST beginning at [[../RollRoot|RollResult.RollRoot]]. This property is read-only.

== Examples ==
This example iterates through Values to display a roll result.

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

class Sample
{
public static void Main()
{
StringBuilder sb = new StringBuilder();
RollResult result = Roller.Roll("(2d20 + 2) * 1.5"); // rolls a 6 and an 8
bool needAdd = false;
foreach (DieResult die in result.Values)
{
if (die.DieType == DieType.Special)
{
needAdd = false;
switch ((SpecialDie)die.Value)
{
case SpecialDie.Subtract:
sb.Append(" - ");
break;
case SpecialDie.Multiply:
sb.Append(" * ");
break;
case SpecialDie.Divide:
sb.Append(" / ");
break;
case SpecialDie.OpenParen:
sb.Append("(");
break;
case SpecialDie.CloseParen:
sb.Append(")");
needAdd = true;
break;
}
}
else
{
if (needAdd)
{
sb.Append(" + ");
}

sb.Append(die.Value);
}
}

Console.WriteLine(sb.ToString()); // outputs "(6 + 8 + 2) * 1.5"
}
}
</syntaxhighlight>

@@ Line 18: / Line 18: @@
 == Examples ==
-This example iterates through Values to display a roll result. Note that the following code is how [[../ToString|RollResult.ToString()]] is implemented.
+This example iterates through Values to display a roll result. Note that the following code is how part of [[../ToString|RollResult.ToString()]] is implemented.
 <syntaxhighlight lang="C#">

@@ Line 31: / Line 31: @@
          StringBuilder sb = new StringBuilder();
          RollResult result = Roller.Roll("(2d20 + 2) * 1.5"); // rolls a 6 and an 8
          foreach (DieResult die in result.Values)
+         {
              if (die.DieType == DieType.Special)
+             {
                  switch ((SpecialDie)die.Value)
+                 {
                      case SpecialDie.Subtract:
                          sb.Append(" - ");
@@ Line 53: / Line 54: @@
                      case SpecialDie.CloseParen:
                          sb.Append(")");
                          break;
+                 }
@@ Line 59: / Line 59: @@
              else
+             {
                  sb.Append(die.Value);
+             }
+         }