Dice/FunctionContext/Expression - Revision history

Skizzerz: Created page with "{{APIdoc|FunctionContext.Expression Property}} Gets the dice expression this function is attached to, or null if it is a global function. {{ns}} == Syntax ==
2017-04-25T22:11:33Z

Created page with "{{APIdoc|FunctionContext.Expression Property}} Gets the dice expression this function is attached to, or null if it is a global function. {{ns}} == Syntax == <syntaxhighligh..."

New page
{{APIdoc|FunctionContext.Expression Property}}
Gets the dice expression this function is attached to, or null if it is a global function.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public DiceAST Expression { get; internal set; }
</syntaxhighlight>

=== Property Value ===
Type: [[Dice/AST/DiceAST|Dice.AST.DiceAST]]

The dice expression this function is attached to, or {{cs|null}} if it is a global function.

== Remarks ==
Roll functions will typically look at and perform some transformation on Expression.Value, Expression.ValueType, and Expression.Values (setting the FunctionContext's Value, ValueType, and Values to the modified versions).

== Examples ==
The following example adds one to a roll.

<syntaxhighlight lang="C#">
using Dice;

class Sample
{
public static void Main()
{
Roller.DefaultConfig.FunctionRegistry.RegisterFunction("addOne", AddOne, FunctionScope.Roll);
Roller.Roll("4d6dl1.addOne()");
}

public static void AddOne(FunctionContext context)
{
// Expression is the KeepNode representing the "dl1" extra
context.Value = Expression.Value + 1;
}
}
</syntaxhighlight>