fillsettings - eisclimber/ExPresS-XR GitHub Wiki

FillSettings

Class in CircularTimerUi

Inherits from System.Object

Summary

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

public class FillSettings

Fields

Name Description
FillDirection The direction in which the fill image fills up.
FillType The type of progress visualization.
RoundType How the remaining time is displayed (i.e. count up or down).
tickFrequency The tick frequency for the tick-based visualization.
Will be interpreted as seconds if 'fillType' is set to 'TickTime'.
If 'fillType' is set to 'TickNum' the value is interpreted as number of ticks.
Has no effect if fillType is set to Smooth or set to a value equal or below zero.

Methods

Name Description
ResetVisualization() Resets the visualization to the default state (fill amount 0).
UpdateCaps() Updates the visibility of the caps.
UpdateColors() Updates the colors set for the visualization.
UpdateVisualization(float,float) Updates the visualization of the timer according to the remaining time and overall wait time.

Properties

Name Description
CapsEnabled If the caps shown at the ends of the progress meter to round the ends.
Color Color of the fill meter and the caps.
EndCapImage The image used to visualize the end cap of the timer.
FillImage The image used to visualize the fill of the timer. Should be of Image Type 'Filled' for correct visualization.
HideCapsIfNotRunning If the caps will be hidden when the timer is not running and the fill amount is 0.
StartCapImage The image used to visualize the start cap of the timer.
⚠️ **GitHub.com Fallback** ⚠️