Skizzerz: Created page with "{{APIdoc|FunctionScope Enumeration}} When registering a function, this indicates what scopes the function should be registered to. When a Dice/FunctionCallback|FunctionCallb..."

2017-04-11T23:36:22Z

Created page with "{{APIdoc|FunctionScope Enumeration}} When registering a function, this indicates what scopes the function should be registered to. When a Dice/FunctionCallback|FunctionCallb..."

New page

{{APIdoc|FunctionScope Enumeration}}
When registering a function, this indicates what scopes the function should be registered to. When a [[Dice/FunctionCallback|FunctionCallback]] is called, this will indicate the scope from which the function was called from.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
public enum FunctionScope
</syntaxhighlight>

== Members ==
{| class="wikitable"
! Member name !! Description
|-
| Global || The function is a global function (not attached to a die roll).
|-
| Roll || The function is attached to normal, fudge, or grouped rolls, useful when registering functions that work on multiple roll types.
|-
| Basic || The function is attached to a normal or fudge die roll.
|-
| Group || The function is attached to a grouped roll.
|-
| All || The function can be executed globally as well as attached to any sort of roll. Useful when registering functions that work everywhere.
|}

== Remarks ==
When registering a function into the [[Dice/FunctionRegistry|FunctionRegistry]], any of the enum values may be used. When a scope is passed as part of a [[Dice/FunctionContext|FunctionContext]], it will be one of Global, Basic, or Group (Roll and All are not used in FunctionContexts).

Dice/FunctionScope - Revision history

Skizzerz: Created page with "{{APIdoc|FunctionScope Enumeration}} When registering a function, this indicates what scopes the function should be registered to. When a Dice/FunctionCallback|FunctionCallb..."