Table of Contents

Class ProgressiveDelay

Namespace
Cryville.EEW
Assembly
Cryville.EEW.dll
A helper class that produces progressive delay.
public class ProgressiveDelay
Inheritance
ProgressiveDelay
Inherited Members

Constructors

ProgressiveDelay(double, double, double)

Creates an instance of the ProgressiveDelay class.
public ProgressiveDelay(double baseDelay = 1, double maxDelay = 1440, double delayMultiplier = 3.4641)

Parameters

baseDelay double
The minimum delay.
maxDelay double
The maximum delay.
delayMultiplier double
The multiplier between adjacent delay values.

Exceptions

ArgumentOutOfRangeException
baseDelay is negative or zero. -or- maxDelay is negative or zero. -or- delayMultiplier is less than or equal to 1.

Properties

CurrentDelay

The delay to next tick.
public double CurrentDelay { get; }

Property Value

double

Methods

Reset()

Resets to the base delay.
public void Reset()

Step(double)

Decrements the current delay and ticks if the delay has run over.
public bool Step(double amount = 1)

Parameters

amount double
The amount of delay to decrement.

Returns

bool
Whether to tick.