Skizzerz: Created page with "{{APIdoc|DiceMacroAttribute Class}} An attribute that can be applied to methods which denotes the method is a valid MacroCallback. The {{l|MacroRegistry..."

2017-08-14T22:00:41Z

Created page with "{{APIdoc|DiceMacroAttribute Class}} An attribute that can be applied to methods which denotes the method is a valid MacroCallback. The {{l|MacroRegistry..."

New page

{{APIdoc|DiceMacroAttribute Class}}
An attribute that can be applied to methods which denotes the method is a valid [[Dice/MacroCallback|MacroCallback]]. The {{l|MacroRegistry.RegisterType}} function can be used to register types which contain methods marked with this attribute.

{{ns}}

== Inheritance Hierarchy ==
System.Object
: System.Attribute
:: Dice.DiceMacroAttribute

== Syntax ==
<syntaxhighlight lang="C#">
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true, Inherited = false)]
public sealed class DiceMacroAttribute : Attribute
</syntaxhighlight>

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

== Properties ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{public}} {{property}} || [[/Name|Name]] || Gets the name of the macro, which is not necessarily the same as the name of the method the attribute is attached to.
|}

== Remarks ==
This attribute can be applied to a callback to mark it as a macro. In addition to using the attribute, the type containing the decorated methods must be registered via {{l|MacroRegistry.RegisterType}}. This attribute should only ever be applied to public methods whose signature matches {{l|MacroCallback}}.

== Examples ==
The following example demonstrates using DiceMacroAttribute to register two macros, and then registering the type containing those functions.
<syntaxhighlight lang="C#">
using System;
using System.Collections.Generic;
using Dice;

class Sample
{
public static void Main()
{
Roller.DefaultConfig.MacroRegistry.RegisterType(typeof(Sample));
var result = Roller.Roll([a]d6 + [b:2]");
Console.WriteLine(result.Value); // retrieves the value of the expression 1d6+2
}

[DiceMacro("a")]
public static void A(MacroContext context)
{
context.Value = 1;
}

[DiceMacro("b")]
public static void B(MacroContext context)
{
// context.Arguments[0] is "b" and context.Arguments[1] is "2" in this example
context.Value = Convert.ToDecimal(context.Arguments[1]);
}
}
</syntaxhighlight>

Dice/DiceMacroAttribute - Revision history

Skizzerz: Created page with "{{APIdoc|DiceMacroAttribute Class}} An attribute that can be applied to methods which denotes the method is a valid MacroCallback. The {{l|MacroRegistry..."