Skizzerz: /* Exceptions */

2017-08-14T23:07:18Z

Exceptions

Skizzerz: Created page with "{{APIdoc|FunctionRegistry.Remove Method (String, FunctionScope)}} Removes the function with the given name and scope. {{ns}} == Syntax == public..."

2017-04-24T19:29:21Z

Created page with "{{APIdoc|FunctionRegistry.Remove Method (String, FunctionScope)}} Removes the function with the given name and scope. {{ns}} == Syntax == <syntaxhighlight lang="C#"> public..."

New page

{{APIdoc|FunctionRegistry.Remove Method (String, FunctionScope)}}
Removes the function with the given name and scope.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public void Remove(
string name,
FunctionScope scope
)
</syntaxhighlight>

=== Parameters ===
; ''name''
: Type: System.String
: Name of the function to remove, case-insensitive.

; ''scope''
: Type: [[Dice/FunctionScope|Dice.FunctionScope]]
: Scope of the function to remove the ''name'' from.

== Exceptions ==
{| class="wikitable"
! Exception !! Condition
|-
| ArgumentNullException || ''name'' is {{cs|null}}.
|-
| ArgumentException || ''name'' refers to a reserved function name.
|}

== Remarks ==
Reserved function names (dropLowest, reroll, success, critical, etc.) are not actually implemented as functions, and cannot therefore be removed. Actual built-in functions (max, min, round, if, etc.) can be removed, however. If a function with a given ''name'' and ''scope'' does not exist, no error is thrown.

@@ Line 27: / Line 27: @@
 | ArgumentNullException || ''name'' is {{cs|null}}.
 |-
-| ArgumentException || ''name'' refers to a reserved function name.
+| ArgumentException || ''name'' refers to a reserved function name ''-or-'' you passed FunctionScope.All or FunctionScope.Roll as the scope.
 |}
 == Remarks ==
 Reserved function names (dropLowest, reroll, success, critical, etc.) are not actually implemented as functions, and cannot therefore be removed. Actual built-in functions (max, min, round, if, etc.) can be removed, however. If a function with a given ''name'' and ''scope'' does not exist, no error is thrown.

Dice/FunctionRegistry/Remove - Revision history

Skizzerz: /* Exceptions */

Skizzerz: Created page with "{{APIdoc|FunctionRegistry.Remove Method (String, FunctionScope)}} Removes the function with the given name and scope. {{ns}} == Syntax == public..."