< Dice‎ | DieResult
Revision as of 18:33, 25 April 2017 by Skizzerz (talk | contribs) (Created page with "{{APIdoc|DieResult.Failure Method ()}} Return a new DieResult based on the current one flagged as a failure. {{ns}} == Syntax == <syntaxhighlight lang="C#"> public DieResult...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

DieResult.Failure Method ()

From DiceRoller Documentation

Return a new DieResult based on the current one flagged as a failure.

  • Namespace: Dice
  • Assembly: DiceRoller (in DiceRoller.dll)

Syntax

public DieResult Failure()

Return Value

Type: Dice.DieResult

A copy of the current DieResult with the Failure flag.

Remarks

When marking a die as a failure via this method, the Success flag is stripped. As such, it is preferred that you use this method to mark dice as failures instead of manually adding the flag yourself, so that this extra effect happens consistently.