Difference between revisions of "Dice/MacroContext/MacroContext"

From DiceRoller Documentation
(Created page with "{{APIdoc|MacroContext Constructor (String)}} Constructs a new instance of MacroContext. {{ns}} == Syntax == <syntaxhighlight lang="C#"> internal MacroContext( string par...")
 
Line 15: Line 15:
 
: Type: System.String
 
: Type: System.String
 
: The macro's text.
 
: The macro's text.
 
== Exceptions ==
 
{| class="wikitable"
 
! Exception !! Condition
 
|-
 
| ArgumentNullException
 
| ''param'' is {{cs|null}}.
 
|}
 
  
 
== Remarks ==
 
== Remarks ==
 
[[../Value|Value]] is initialized to Decimal.MinValue, [[../Values|Values]] is initialized to {{cs|null}}, and [[../ValueType|ValueType]] is initialized to ResultType.Total. The function's callback '''must''' modify Value to some other value, and may modify Values and ValueType if the defaults are insufficient. See the documentation for Values and ValueType for more details on how they interact if they are left at their defaults.
 
[[../Value|Value]] is initialized to Decimal.MinValue, [[../Values|Values]] is initialized to {{cs|null}}, and [[../ValueType|ValueType]] is initialized to ResultType.Total. The function's callback '''must''' modify Value to some other value, and may modify Values and ValueType if the defaults are insufficient. See the documentation for Values and ValueType for more details on how they interact if they are left at their defaults.

Revision as of 23:09, 14 August 2017

Constructs a new instance of MacroContext.

  • Namespace: Dice
  • Assembly: DiceRoller (in DiceRoller.dll)

Syntax

internal MacroContext(
    string param
)

Parameters

param
Type: System.String
The macro's text.

Remarks

Value is initialized to Decimal.MinValue, Values is initialized to null, and ValueType is initialized to ResultType.Total. The function's callback must modify Value to some other value, and may modify Values and ValueType if the defaults are insufficient. See the documentation for Values and ValueType for more details on how they interact if they are left at their defaults.