Difference between revisions of "Dice/DieResult/Drop"

From DiceRoller Documentation
(Created page with "{{APIdoc|DieResult.Drop Method ()}} Return a new DieResult based on the current one flagged as dropped. {{ns}} == Syntax == <syntaxhighlight lang="C#"> public DieResult Drop...")
 
(No difference)

Latest revision as of 18:32, 25 April 2017

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

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

Syntax

public DieResult Drop()

Return Value

Type: Dice.DieResult

A copy of the current DieResult with the Dropped flag.

Remarks

When dropping a die via this method, the Success and Failure flag are also stripped. As such, it is preferred that you use this method to drop dice instead of manually adding the flag yourself, so that this extra effect happens consistently.