Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.RegionTimer Class Reference

Calls delegate on every tick. More...

Inheritance diagram for DOL.GS.RegionTimer:
DOL.GS.GameTimer

List of all members.

Public Member Functions

 RegionTimer (GameObject timerOwner)
 Constructs a new region timer.
 RegionTimer (GameObject timerOwner, RegionTimerCallback callback)
 Constructs a new region timer.
 RegionTimer (GameObject timerOwner, RegionTimerCallback callback, int delay)
 Constructs a new region timer and starts it with specified delay.
 RegionTimer (TimeManager time)
 Constructs a new region timer.
override string ToString ()
 Returns short information about the timer.

Protected Member Functions

override void OnTick ()
 Called on every timer tick.

Properties

GameObject Owner [get]
 The timer owner.
RegionTimerCallback Callback [get, set]
 Gets or sets the timer callback.
PropertyCollection Properties [get]
 Gets the properties of this timer.

Detailed Description

Calls delegate on every tick.


Constructor & Destructor Documentation

DOL.GS.RegionTimer.RegionTimer ( GameObject  timerOwner)

Constructs a new region timer.

Parameters:
timerOwnerThe game object that is starting the timer
DOL.GS.RegionTimer.RegionTimer ( GameObject  timerOwner,
RegionTimerCallback  callback 
)

Constructs a new region timer.

Parameters:
timerOwnerThe game object that is starting the timer
callbackThe callback function to call
DOL.GS.RegionTimer.RegionTimer ( GameObject  timerOwner,
RegionTimerCallback  callback,
int  delay 
)

Constructs a new region timer and starts it with specified delay.

Parameters:
timerOwnerThe game object that is starting the timer
callbackThe callback function to call
delayThe interval in milliseconds when to call the callback (>0)
DOL.GS.RegionTimer.RegionTimer ( TimeManager  time)

Constructs a new region timer.

Parameters:
time

Member Function Documentation

override void DOL.GS.RegionTimer.OnTick ( ) [protected, virtual]

Called on every timer tick.

Implements DOL.GS.GameTimer.

override string DOL.GS.RegionTimer.ToString ( )

Returns short information about the timer.

Returns:
Short info about the timer

Reimplemented from DOL.GS.GameTimer.


Property Documentation

RegionTimerCallback DOL.GS.RegionTimer.Callback [get, set]

Gets or sets the timer callback.

GameObject DOL.GS.RegionTimer.Owner [get]

The timer owner.

PropertyCollection DOL.GS.RegionTimer.Properties [get]

Gets the properties of this timer.


The documentation for this class was generated from the following file:
All Classes Namespaces Functions Variables Enumerations Properties Events