PixelCrushers.DialogueSystem.TK2D.TK2DTimer Class Reference

Applies a timer effect to a tk2dProgressBar that counts down from 1 to 0. More...

Inheritance diagram for PixelCrushers.DialogueSystem.TK2D.TK2DTimer:
Collaboration diagram for PixelCrushers.DialogueSystem.TK2D.TK2DTimer:

Public Member Functions

IEnumerator Play ()
 Runs the timer. More...
 

Public Attributes

float duration = 5f
 The timer duration. More...
 

Properties

float? Value [get, set]
 Gets or sets the value of the progress bar. More...
 

Events

Action TimeoutHandler = null
 Occurs when the timer is done (i.e., at the end of duration). More...
 

Detailed Description

Applies a timer effect to a tk2dProgressBar that counts down from 1 to 0.

When time is up, it calls an event handler. Attach this script to your response menu timer.

Member Function Documentation

◆ Play()

IEnumerator PixelCrushers.DialogueSystem.TK2D.TK2DTimer.Play ( )

Runs the timer.

Member Data Documentation

◆ duration

float PixelCrushers.DialogueSystem.TK2D.TK2DTimer.duration = 5f

The timer duration.

Property Documentation

◆ Value

float? PixelCrushers.DialogueSystem.TK2D.TK2DTimer.Value
getset

Gets or sets the value of the progress bar.

The value (0-1).

Event Documentation

◆ TimeoutHandler

Action PixelCrushers.DialogueSystem.TK2D.TK2DTimer.TimeoutHandler = null

Occurs when the timer is done (i.e., at the end of duration).

If the coroutine is stopped or the control is deactivated, this will never get called.


The documentation for this class was generated from the following file: