Class Game.BarTime
Game BarTime class.
Main bar time class. To displays progress bar similar to C4 planting/defusing progress bar.
Data Structures
| .barTimeShowOption | The Game.BarTime:Show options. |
Methods
| Game.BarTime:Show ([player=nil[, duration=0[, startPercent=0]]]) | Shows the progress bar. |
| Game.BarTime:Hide ([player=nil]) | Hides the progress bar. |
Data Structures
- .barTimeShowOption
-
The Game.BarTime:Show options.
Note: Display time can be calculated with this formula: (1 - (StartPercent / 100)) / Duration.
- player Game.Player or nil A player that receive screen fade. | All connected players will receive screen fade. (default nil)
- duration number The display duration (in second unit). (default 0)
- startPercent number Start progress percentage (Range = 0~100). (default 0)
Methods
- Game.BarTime:Show ([player=nil[, duration=0[, startPercent=0]]])
-
Shows the progress bar.
Note: Display time can be calculated with this formula: (1 - (StartPercent / 100)) / Duration.
Parameters:
- player Game.Player, nil or .barTimeShowOption A player that displays this progress bar. | All connected players will displays this progress bar. | Optiins table. (default nil)
- duration
number
The display duration (in second unit)(Ignored if
playeris a table). (default 0) - startPercent
number
Start progress percentage (Range = 0~100)(Ignored if
playeris a table). (default 0)
Returns:
-
self
This class.
- Game.BarTime:Hide ([player=nil])
-
Hides the progress bar.
Parameters:
- player Game.Player or nil A player that removes his/her progress bar. | All connected players will removes their progress bar. (default nil)
Returns:
-
self
This class.