Dice/FunctionContext - Revision history

Skizzerz: /* Constructors */

2017-08-14T23:11:48Z

Constructors

Skizzerz: /* Properties */

2017-08-14T22:42:34Z

Properties

Skizzerz: /* Properties */

2017-08-14T22:36:58Z

Properties

Skizzerz: /* Properties */

2017-04-25T22:12:57Z

Properties

Skizzerz: Created page with "{{APIdoc|FunctionContext Class}} Contains the context for a function call, and is passed to function callbacks. {{ns}} == Inheritance Hierarchy == System.Object :Dice.Functi..."

2017-04-20T17:02:46Z

Created page with "{{APIdoc|FunctionContext Class}} Contains the context for a function call, and is passed to function callbacks. {{ns}} == Inheritance Hierarchy == System.Object :Dice.Functi..."

New page

{{APIdoc|FunctionContext Class}}
Contains the context for a function call, and is passed to function callbacks.

{{ns}}

== Inheritance Hierarchy ==
System.Object
:Dice.FunctionContext

== Syntax ==
<syntaxhighlight lang="C#">
public class FunctionContext
</syntaxhighlight>

== Constructors ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{internal}} {{method}} || [[/FunctionContext|FunctionContext(FunctionScope, String, IReadOnlyList<DiceAST>)]] || Constructs a new instance of FunctionContext.
|}

== Properties ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{public}} {{property}} || [[/Arguments|Arguments]] || Gets the arguments to the function call.
|-
| {{public}} {{property}} || [[/Expression|Expression]] || Gets the dice expression this function is attached to, or null if it is a global function.
|-
| {{public}} {{property}} || [[/Name|Name]] || Gets the name of the function being called, converted to lowercase.
|-
| {{public}} {{property}} || [[/Scope|Scope]] || Gets the scope of the function being called.
|-
| {{public}} {{property}} || [[/Value|Value]] || Gets or sets the result of the function call.
|-
| {{public}} {{property}} || [[/Values|Values]] || Gets or sets the underlying dice rolls for the function call that should be shown in the overall result.
|-
| {{public}} {{property}} || [[/ValueType|ValueType]] || Gets or sets the type of value this function returns.
|}

== Remarks ==
A FunctionContext is created and passed into all [[Dice/FunctionCallback|FunctionCallbacks]]. The callback must fill out Value and should also fill out Values and ValueType. Failing to fill out Value will result in an error being displayed to the user.

@@ Line 18: / Line 18: @@
 ! Name !! Description
 |-
-| {{internal}} {{method}} || [[/FunctionContext|FunctionContext(FunctionScope, String, IReadOnlyList<DiceAST>)]] || Constructs a new instance of FunctionContext.
+| {{internal}} {{method}} || [[/FunctionContext|FunctionContext(FunctionScope, String, IReadOnlyList<DiceAST>, RollData)]] || Constructs a new instance of FunctionContext.
 |}

@@ Line 28: / Line 28: @@
 | {{public}} {{property}} || [[/Arguments|Arguments]] || Gets the arguments to the function call.
 |-
-| {{public}} {{property}} || [[/Data|Data]] || RollData attached to this function execution.
+| {{public}} {{property}} || [[/Data|Data]] || Gets the RollData attached to this function execution.
 |-
 | {{public}} {{property}} || [[/Expression|Expression]] || Gets the dice expression this function is attached to, or null if it is a global function.

@@ Line 30: / Line 30: @@
 | {{public}} {{property}} || [[/Expression|Expression]] || Gets the dice expression this function is attached to, or null if it is a global function.
 |-
-| {{public}} {{property}} || [[/Name|Name]] || Gets the name of the function being called, converted to lowercase.
+| {{public}} {{property}} || [[/Name|Name]] || Gets the name of the function being called, in the casing that the name was registered as.
 |-
 | {{public}} {{property}} || [[/Scope|Scope]] || Gets the scope of the function being called.