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

DieResult.Success Method ()

From DiceRoller Documentation

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

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

Syntax

public DieResult Success()

Return Value

Type: Dice.DieResult

A copy of the current DieResult with the Success flag.

Remarks

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