Skizzerz: Created page with "{{APIdoc|BuiltinFunction.If Method (FunctionContext)}} Conditionally returns a result based on a comparison. {{ns}} == Syntax == [DiceFunction("i..."

2017-04-27T21:52:47Z

Created page with "{{APIdoc|BuiltinFunction.If Method (FunctionContext)}} Conditionally returns a result based on a comparison. {{ns}} == Syntax == <syntaxhighlight lang="C#"> [DiceFunction("i..."

New page

{{APIdoc|BuiltinFunction.If Method (FunctionContext)}}
Conditionally returns a result based on a comparison.

{{ns}}

== Syntax ==
<syntaxhighlight lang="C#">
[DiceFunction("if", Scope = FunctionScope.Global)]
public static void If(
FunctionContext context
)
</syntaxhighlight>

=== Parameters ===
; ''context''
: Type: [[Dice/FunctionContext|Dice.FunctionContext]]
: The context of the function call.

== Exceptions ==
{| class="wikitable"
! Exception !! Condition
|-
| DiceException (DiceErrorCode.IncorrectArity) || context.Arguments.Count is not exactly 3 or 4.
|-
| DiceException (DiceErrorCode.IncorrectArgType) || context.Arguments[1] is not a comparison, any of the other arguments is a comparison.
|}

== Remarks ==
If the short form (3 argument expression, test, then) is used and the comparison fails, a new DieResult with DieType.Literal is returned with the Value 0. This automatically generated DieResult has the DieFlags.Macro flag.

Dice/BuiltinFunctions/If - Revision history

Skizzerz: Created page with "{{APIdoc|BuiltinFunction.If Method (FunctionContext)}} Conditionally returns a result based on a comparison. {{ns}} == Syntax == [DiceFunction("i..."