Show / Hide Table of Contents

Class SubtractTerm

Term representing the subtraction operator -- subtracts the second term from the first.

Inheritance
System.Object
SubtractTerm
Implements
ITerm
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: GoRogue.DiceNotation.Terms
Assembly: GoRogue.dll
Syntax
public class SubtractTerm : ITerm

Constructors

| Improve this Doc View Source

SubtractTerm(ITerm, ITerm)

Constructor. Takes the two terms to subtract.

Declaration
public SubtractTerm(ITerm term1, ITerm term2)
Parameters
Type Name Description
ITerm term1

The first term (left-hand side).

ITerm term2

The second term (right-hand side).

Properties

| Improve this Doc View Source

Term1

The first term (left-hand side).

Declaration
public ITerm Term1 { get; }
Property Value
Type Description
ITerm
| Improve this Doc View Source

Term2

The second term (right-hand side).

Declaration
public ITerm Term2 { get; }
Property Value
Type Description
ITerm

Methods

| Improve this Doc View Source

GetResult(IGenerator)

Subtracts the second term from the first, evaluating those two terms as necessary.

Declaration
public int GetResult(IGenerator rng)
Parameters
Type Name Description
Troschuetz.Random.IGenerator rng

The rng to used -- passed to other terms.

Returns
Type Description
System.Int32

The result of evaluating Term1 - Term2.

| Improve this Doc View Source

ToString()

Returns a parenthesized string representing the operation.

Declaration
public override string ToString()
Returns
Type Description
System.String

A parenthesized string representing the operation.

Overrides
System.Object.ToString()

Implements

ITerm

Extension Methods

Utility.Yield<T>(T)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX