Dice/MacroContext - Revision history

Skizzerz: /* Properties */

2017-08-14T23:16:57Z

Properties

Skizzerz: /* Remarks */

2017-08-14T23:15:59Z

Remarks

Skizzerz: /* Remarks */

2017-08-14T23:15:38Z

Remarks

Skizzerz: /* Properties */

2017-08-14T23:14:36Z

Properties

Skizzerz: /* Properties */

2017-08-14T23:12:42Z

Properties

Skizzerz: /* Constructors */

2017-08-14T23:12:04Z

Constructors

Skizzerz: /* Properties */

2017-04-27T18:30:51Z

Properties

Skizzerz: Created page with "{{APIdoc|MacroContext Class}} Contains the context for a macro and is passed to macro callbacks. {{ns}} == Inheritance Hierarchy == System.Object :Dice.MacroContext == Synt..."

2017-04-20T17:09:50Z

Created page with "{{APIdoc|MacroContext Class}} Contains the context for a macro and is passed to macro callbacks. {{ns}} == Inheritance Hierarchy == System.Object :Dice.MacroContext == Synt..."

New page

{{APIdoc|MacroContext Class}}
Contains the context for a macro and is passed to macro callbacks.

{{ns}}

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

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

== Constructors ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{internal}} {{method}} || [[/MacroContext|MacroContext(String)]] || Constructs a new instance of MacroContext.
|}

== Properties ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{public}} {{property}} || [[/Param|Param]] || Gets the parameter passed to the macro. The callback is responsible for parsing this into something useful and acting accordingly.
|-
| {{public}} {{property}} || [[/Value|Value]] || Gets or sets the result of the macro.
|-
| {{public}} {{property}} || [[/Values|Values]] || Gets or sets the underlying die results for the macro. that should be shown in the overall result.
|-
| {{public}} {{property}} || [[/ValueType|ValueType]] || Gets or sets the type of value this macro returns.
|}

== Remarks ==
A MacroContext is created and passed into all [[Dice/MacroCallback|MacroCallbacks]]. 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.

The Param property contains the full string inside of the macro's square brackets. For example, the Param for the macro invocation {{c|[roll:1:critical]}} is the string {{cs|"roll:1:critical"}}. All registered macro callbacks are invoked for every macro, unlike function callbacks which register themselves to a particular function name.

@@ Line 32: / Line 32: @@
 | {{public}} {{property}} || [[/Name|Name]] || Gets the name of the macro, if using the recommended method of separating arguments with colons.
 |-
-| {{public}} {{property}} || [[/Param|Param]] || Gets the parameter passed to the macro. The callback is responsible for parsing this into something useful and acting accordingly.
+| {{public}} {{property}} || [[/Param|Param]] || Gets the parameter passed to the macro. If not using the recommended method of separating arguments with colons, the callback is responsible for parsing this into something useful and acting accordingly.
 |-
 | {{public}} {{property}} || [[/Value|Value]] || Gets or sets the result of the macro.

← Older revision		Revision as of 23:15, 14 August 2017
Line 44:		Line 44:
	A MacroContext is created and passed into all [[Dice/MacroCallback\|MacroCallbacks]]. 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.		A MacroContext is created and passed into all [[Dice/MacroCallback\|MacroCallbacks]]. 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.

−	The Param property contains the full string inside of the macro's square brackets. For example, the Param for the macro invocation {{c\|[roll:1:critical]}} is the string {{cs\|"roll:1:critical"}}. The Name property would be "roll" and the Arguments property would be the list "roll", "1", "critical".	+	The Param property contains the full string inside of the macro's square brackets. For example, the Param for the macro invocation {{c\|[roll:1:critical]}} is the string {{cs\|"roll:1:critical"}}. The Name property would be {{cs\|"roll"}} and the Arguments property would be the list {{cs\|"roll", "1", "critical"}}.

← Older revision		Revision as of 23:15, 14 August 2017
Line 44:		Line 44:
	A MacroContext is created and passed into all [[Dice/MacroCallback\|MacroCallbacks]]. 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.		A MacroContext is created and passed into all [[Dice/MacroCallback\|MacroCallbacks]]. 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.

−	The Param property contains the full string inside of the macro's square brackets. For example, the Param for the macro invocation {{c\|[roll:1:critical]}} is the string {{cs\|"roll:1:critical"}}. ~~All registered macro callbacks are invoked for every macro~~, ~~unlike function callbacks which register themselves to a particular function name~~.	+	The Param property contains the full string inside of the macro's square brackets. For example, the Param for the macro invocation {{c\|[roll:1:critical]}} is the string {{cs\|"roll:1:critical"}}. The Name property would be "roll" and the Arguments property would be the list "roll", "1", "critical".

@@ Line 25: / Line 25: @@
 ! style="width: 5em" |
 ! Name !! Description
 |-
 | {{public}} {{property}} || [[/Data|Data]] || Gets roll data for the dice roll.
 |-
 | {{public}} {{property}} || [[/Param|Param]] || Gets the parameter passed to the macro. The callback is responsible for parsing this into something useful and acting accordingly.

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

@@ Line 30: / Line 30: @@
 | {{public}} {{property}} || [[/Value|Value]] || Gets or sets the result of the macro.
 |-
-| {{public}} {{property}} || [[/Values|Values]] || Gets or sets the underlying die results for the macro. that should be shown in the overall result.
+| {{public}} {{property}} || [[/Values|Values]] || Gets or sets the underlying die results for the macro that should be shown in the overall result.
 |-
 | {{public}} {{property}} || [[/ValueType|ValueType]] || Gets or sets the type of value this macro returns.