< Dice
Difference between revisions of "Dice/BuiltinFunctions"
From DiceRoller Documentation
(Created page with "{{APIdoc|BuiltinFunctions Class}} Contains callbacks for all built-in functions. {{ns}} == Inheritance Hierarchy == System.Object : Dice.BuiltinFunctions == Syntax == <synt...") |
|||
| Line 21: | Line 21: | ||
|- | |- | ||
| {{public}} {{static}} {{method}} || [[/Ceiling|Ceiling(FunctionContext)]] || Computes the ceiling of the argument. | | {{public}} {{static}} {{method}} || [[/Ceiling|Ceiling(FunctionContext)]] || Computes the ceiling of the argument. | ||
| + | |- | ||
| + | | {{public}} {{static}} {{method}} || [[/Expand|Expand(FunctionContext)]] || Expands a grouped DieResult into the individual DieResults that comprise it. | ||
|- | |- | ||
| {{public}} {{static}} {{method}} || [[/Floor|Floor(FunctionContext)]] || Computes the floor of the argument. | | {{public}} {{static}} {{method}} || [[/Floor|Floor(FunctionContext)]] || Computes the floor of the argument. | ||
Latest revision as of 21:51, 14 August 2017
Contains callbacks for all built-in functions.
- Namespace: Dice
- Assembly: DiceRoller (in DiceRoller.dll)
Inheritance Hierarchy
System.Object
- Dice.BuiltinFunctions
Syntax
public static class BuiltinFunctions
Methods
| Name | Description | |
|---|---|---|
| S | Abs(FunctionContext) | Computes the absolute value of the argument. |
| S | Ceiling(FunctionContext) | Computes the ceiling of the argument. |
| S | Expand(FunctionContext) | Expands a grouped DieResult into the individual DieResults that comprise it. |
| S | Floor(FunctionContext) | Computes the floor of the argument. |
| S | If(FunctionContext) | Conditionally returns a result based on a comparison. |
| S | Max(FunctionContext) | Returns the larger of the two arguments. |
| S | Min(FunctionContext) | Returns the smaller of the two arguments. |
| S | Round(FunctionContext) | Rounds the argument. |
Fields
| Name | Description | |
|---|---|---|
| S | ReservedNames | Function names which are reserved and cannot be registered. |
Remarks
These functions are automatically registered whenever constructing a new RollerConfig object, but can be removed from the function registry if desired.
