Dice/FunctionRegistry/RegisterFunction (String, FunctionCallback) - Revision history

Skizzerz: Created page with "{{APIdoc|FunctionRegistry.RegisterFunction Method (String, FunctionCallback)}} Registers the specified global callback to the given name. {{ns}} == Syntax ==
2017-04-24T19:23:34Z

Created page with "{{APIdoc|FunctionRegistry.RegisterFunction Method (String, FunctionCallback)}} Registers the specified global callback to the given name. {{ns}} == Syntax == <syntaxhighligh..."

New page
{{APIdoc|FunctionRegistry.RegisterFunction Method (String, FunctionCallback)}}
Registers the specified global callback to the given name.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public void RegisterFunction(
string name,
FunctionCallback callback
)
</syntaxhighlight>

=== Parameters ===
; ''name''
: Type: System.String
: Function name to register. Function names are case-insensitive.

; ''callback''
: Type: [[Dice/FunctionCallback|Dice.FunctionCallback]]
: The method to be called whenever the function is called in a dice expression.

== Exceptions ==
{| class="wikitable"
! Exception !! Condition
|-
| ArgumentNullException || ''name'' is {{cs|null}}.
|-
| ArgumentException || ''name'' is the empty string.
|-
| InvalidOperationException || A global function with the same ''name'' has already been registered.
|}

== Remarks ==
This registers a new global function with the given name (FunctionScope.Global).

There can only be one callback associated with any given function name and scope. It is an error to re-register a function, but a function can be [[../Remove|removed]] and then registered again.

== See Also ==
* [[../RegisterFunction|RegisterFunction overload summary]]