DustyEngine::IntervalCounterTask Class Reference

IntervalCounterTask will count a specific interval, rather than counting by 1. More...

#include <dustyintervalcountertask.h>

Inheritance diagram for DustyEngine::IntervalCounterTask:

List of all members.

Public Member Functions
	IntervalCounterTask ()
virtual	~IntervalCounterTask ()
void	SetValue (irr::s32 t)
irr::s32	GetValue ()
void	SetInterval (irr::s32 i)
irr::s32	GetInterval ()
void	OnUpdate ()
	OnUpdate() is called by the TaskTree when the time has come to execute the task's code.
Protected Attributes
irr::s32	counterValue
irr::s32	interval

---

Detailed Description

IntervalCounterTask will count a specific interval, rather than counting by 1.

Definition at line 11 of file dustyintervalcountertask.h.

---

Constructor & Destructor Documentation

DustyEngine::IntervalCounterTask::IntervalCounterTask (   )

virtual DustyEngine::IntervalCounterTask::~IntervalCounterTask (   )  [virtual]

---

Member Function Documentation

irr::s32 DustyEngine::IntervalCounterTask::GetInterval (   )  [inline]

GetInterval() returns the interval this task is counting by. Returns: Returns the counter interval. Definition at line 41 of file dustyintervalcountertask.h.

irr::s32 DustyEngine::IntervalCounterTask::GetValue (   )  [inline]

GetValue() returns the current value of the counter. Returns: Returns the current value of the counter. Definition at line 27 of file dustyintervalcountertask.h.

void DustyEngine::IntervalCounterTask::OnUpdate (   )  [inline, virtual]

OnUpdate() is called by the TaskTree when the time has come to execute the task's code. OnUpdate is typically the most important function. OnUpdate is only called when enough time has passed or every frame, depending upon what the priority of the task is. If you want code to execute on a time-based basis, put that code here and add the task to the tree. Reimplemented from DustyEngine::DummyTask. Definition at line 46 of file dustyintervalcountertask.h.

void DustyEngine::IntervalCounterTask::SetInterval (  irr::s32  i  )  [inline]

SetInterval() sets the interval to count by. Parameters: i,:  The interval to use in counting. If this is 5, the counter will count by 5. If it's -5, it'll count by -5. And so on. Definition at line 34 of file dustyintervalcountertask.h.

void DustyEngine::IntervalCounterTask::SetValue (  irr::s32  t  )  [inline]

SetValue() sets the current value of the counter. Parameters: t,:  The value to set the counter to. Definition at line 20 of file dustyintervalcountertask.h.

---

Member Data Documentation

irr::s32 DustyEngine::IntervalCounterTask::counterValue [protected]

Definition at line 52 of file dustyintervalcountertask.h.

irr::s32 DustyEngine::IntervalCounterTask::interval [protected]

Definition at line 53 of file dustyintervalcountertask.h.

---

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

• dustyintervalcountertask.h

---