Basic slider-based timer for response menus.
More...
|
virtual void | Awake () |
|
virtual void | StartCountdown (float duration, System.Action timeoutHandler) |
| Called by the response menu.
|
|
virtual void | StopCountdown () |
|
void | SkipTime (float amountToSkip) |
| Adjusts the amount of time left.
|
|
virtual void | UpdateTimeLeft (float normalizedTimeLeft) |
| Called each tick to update the timer display.
|
|
Basic slider-based timer for response menus.
◆ Awake()
virtual void PixelCrushers.DialogueSystem.StandardUITimer.Awake |
( |
| ) |
|
|
inlinevirtual |
◆ SkipTime()
void PixelCrushers.DialogueSystem.StandardUITimer.SkipTime |
( |
float |
amountToSkip | ) |
|
|
inline |
Adjusts the amount of time left.
- Parameters
-
amountToSkip | Seconds to fast-forward the timer (or rewind the timer if negative). |
◆ StartCountdown()
virtual void PixelCrushers.DialogueSystem.StandardUITimer.StartCountdown |
( |
float |
duration, |
|
|
System::Action |
timeoutHandler |
|
) |
| |
|
inlinevirtual |
Called by the response menu.
Starts the timer. Each tick, the UpdateTimeLeft method is called.
- Parameters
-
duration | Duration in seconds. |
timeoutHandler | Handler to invoke if the timer reaches zero. |
◆ StopCountdown()
virtual void PixelCrushers.DialogueSystem.StandardUITimer.StopCountdown |
( |
| ) |
|
|
inlinevirtual |
◆ Update()
virtual void PixelCrushers.DialogueSystem.StandardUITimer.Update |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ UpdateTimeLeft()
virtual void PixelCrushers.DialogueSystem.StandardUITimer.UpdateTimeLeft |
( |
float |
normalizedTimeLeft | ) |
|
|
inlinevirtual |
Called each tick to update the timer display.
The default method updates a UI slider.
- Parameters
-
normalizedTimeLeft | 1 at the start, 0 when the timer times out. |
The documentation for this class was generated from the following file:
- C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Standard/Dialogue/StandardUITimer.cs