Class UI.BarTime
UI BarTime class.
To displays progress bar similar to C4 planting/defusing progress bar.
Data Structures
.barTimeDrawOption | The UI.BarTime:Draw options. |
Methods
UI.BarTime:Draw (Duration, StartPercent) | Draws the BarTime HUD. |
UI.BarTime:Hide () | Hides the BarTime HUD. |
UI.BarTime:IsVisible () | Checks whether the BarTime HUD is visible. |
Data Structures
- .barTimeDrawOption
-
The UI.BarTime:Draw options.
Note: Display time can be calculated with this formula: (1 - (StartPercent / 100)) / Duration.
- duration number The display duration (in second unit). (default 0)
- startPercent number Start progress percentage (Range = 0~1). (default 0)
Methods
- UI.BarTime:Draw (Duration, StartPercent)
-
Draws the BarTime HUD.
Parameters:
- Duration number or .barTimeDrawOption The display duration (in second unit). | Options table.
- StartPercent
number
Start progress percent (Range = 0~1)(Ignored if
Duration
is a table).
Returns:
-
self
This class.
- UI.BarTime:Hide ()
-
Hides the BarTime HUD.
Returns:
-
self
This class.
- UI.BarTime:IsVisible ()
-
Checks whether the BarTime HUD is visible.
Returns:
-
bool
Returns
true
if visible.