Class ProgressiveDelay
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
baseDelaydouble- The minimum delay.
maxDelaydouble- The maximum delay.
delayMultiplierdouble- The multiplier between adjacent delay values.
Exceptions
- ArgumentOutOfRangeException
baseDelayis negative or zero. -or-maxDelayis negative or zero. -or-delayMultiplieris less than or equal to 1.
Properties
CurrentDelay
The delay to next tick.
public double CurrentDelay { get; }
Property Value
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
amountdouble- The amount of delay to decrement.
Returns
- bool
- Whether to tick.