circulartimerui - eisclimber/ExPresS-XR GitHub Wiki

CircularTimerUi

Class in ExPresSXR.UI

Inherits from TimerUi

Summary

Visualizes an ExPresSXR Timer as a filling circle with an optional display of time and text.

The visuals can be customized in various ways such as counting up or down as well as smooth or tick movement based on time or steps. To further control the timing of the visuals both text and progress can be rounded independently. It is recommended to use the same RoundType if both use the CountType is the same. With FillDirection being set to Down these values are recommended based on RoundType:

  • Smooth: Ceil (Text), None (Fill)
  • TickNum: Ceil (Both)
  • TickTime: Floor (Both)
public class CircularTimerUi : TimerUi

Classes

Name Description
FillSettings A helper class to hold the settings for the visualization of the circular timer.

Enums

Name Description
FillDirection The way progress is visualized, either as counting up or counting down.
ProgressType The type of progress visualization.

Methods

Name Description
ResetVisualization() Resets the visualization.
⚠️ **GitHub.com Fallback** ⚠️