Skizzerz: Created page with "{{APIdoc|FunctionRegistry Class}} Stores a mapping of all functions to their appropriate callbacks. Functions registered here can specify when they should be executed in relat..."

2017-04-20T18:08:23Z

Created page with "{{APIdoc|FunctionRegistry Class}} Stores a mapping of all functions to their appropriate callbacks. Functions registered here can specify when they should be executed in relat..."

New page

{{APIdoc|FunctionRegistry Class}}
Stores a mapping of all functions to their appropriate callbacks. Functions registered here can specify when they should be executed in relation to built-in dice expressions.

{{ns}}

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

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

== Methods ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{internal}} {{method}} || [[/Contains|Contains(String, FunctionScope, Boolean)]] || Checks if the given function has already been registered.
|-
| {{internal}} {{method}} || [[/Get|Get(String, FunctionScope)]] || Retrieves the registration information for the given registered function.
|-
| {{public}} {{method}} || [[/RegisterFunction (String, FunctionCallback)|RegisterFunction(String, FunctionCallback)]] || Registers the specified global callback to the given name.
|-
| {{public}} {{method}} || [[/RegisterFunction (String, FunctionCallback, FunctionScope)|RegisterFunction(String, FunctionCallback, FunctionScope)]] || Registers the specified callback to the given name and scope.
|-
| {{public}} {{method}} || [[/RegisterFunction (String, FunctionCallback, FunctionScope, FunctionTiming)|RegisterFunction(String, FunctionCallback, FunctionScope, FunctionTiming)]] || Registers the specified callback to the given name, scope, and timing.
|-
| {{public}} {{method}} || [[/Remove|Remove(String, FunctionScope)]] || Removes the function with the given name and scope.
|-
| {{public}} {{method}} || [[/RegisterType (Type)|RegisterType(Type)]] || Registers all public static methods marked with [[Dice/DiceFunctionAttribute|DiceFunctionAttribute]] on the type.
|-
| {{public}} {{method}} || [[/RegisterType (T)(T)|RegisterType<T>(T)]] || Registers all public static and instance methods marked with the [[Dice/DiceFunctionAttribute|DiceFunctionAttribute]] on the type, using the passed-in object when calling instance methods.
|}

== Fields ==
{| class="wikitable"
! style="width: 5em" |
! Name !! Description
|-
| {{private}} {{field}} || [[/Callbacks|Callbacks]] || Contains a mapping of all registered functions to their callback and other registration information.
|}

== Remarks ==
Constructing a new instance of this class will not automatically register all built-in functions (floor, ceil, round, abs, max, min, if). This will let you register your own versions of these functions, if desired. However, all reserved function names (dropLowest, reroll, success, critical, etc.) are not actually implemented as functions, and can never be registered.

The FunctionRegistry constructed when constructing a new [[Dice/RollerConfig|RollerConfig]] ''does'' register all built-in functions. If you wish to wipe them, you can reassign the registry with your own constructed instance of this class, or you can use Remove() to remove specific functions while keeping the others.

Dice/FunctionRegistry - Revision history

Skizzerz: Created page with "{{APIdoc|FunctionRegistry Class}} Stores a mapping of all functions to their appropriate callbacks. Functions registered here can specify when they should be executed in relat..."