delaytimer - eisclimber/ExPresS-XR GitHub Wiki

DelayTimer

Class in ExPresSXR.Misc.Timing

Inherits from Timer

Summary

A timer with an initial delay.

public class DelayTimer : Timer

Fields

Name Description
DEFAULT_DELAY Default delay time.
OnDelayStarted Event that is triggered when the delay timer starts (i.e. the timer is started).
OnDelayTimeout Event that is triggered when the delay timer times out (i.e. the actual timer starts).

Methods

Name Description
StartTimer(float,float) (Re-)starts the timer with duration, setting waitTime in the process.
If duration is less or equal to 0.0f the value of waitTime is used.
StartTimer(float) (Re-)starts the timer with duration, setting waitTime in the process.
If duration is less or equal to 0.0f the value of waitTime is used.
StopTimer() Stops and resets the timer whilst not emitting the timeout event.

Properties

Name Description
Delayed Returns if the timer is currently delaying.
RemainingDelay Returns the remaining time of the timer.
If the timer is was not started or timed out, the value will be the value of TIMER_INACTIVE_WAIT_TIME.
Running If the timer is actively is counting down, meaning it was started and is not paused.
StartDelay Delay until the timer stats. Must be greater than 0.0f.
⚠️ **GitHub.com Fallback** ⚠️