VTimeManager Class Reference

#include <VTimer.h>

Public Member Functions
	VTimeManager ()
	Constructor.
	~VTimeManager ()
	Destructor.
VTimer *	AddTimer ()
VTimerEvent *	AddTimerEvent (unsigned int time, std::function< void()> eventFunction, bool looping=false)
void	AddTimer (VTimer *timer)
void	RemoveTimer (VTimer *timer)
void	Update (float dt)
void	Reserve (size_t size)
void	Clear (bool destroy=true)
int	Count ()

Detailed Description

Manages multiple timers at once in a singleton data structure. An independent VTimeManager can also be created, however any VTimer or VTimeEvent objects must be constructed with the AddToManager parameter set to false.

Member Function Documentation

AddTimer() [1/2]

VTimer* VTimeManager::AddTimer

(

)

Returns

The VTimer object that was added directly to the time manager.

AddTimer() [2/2]

void VTimeManager::AddTimer

(

VTimer *

timer

)

Adds a timer from the list.

Parameters

timer

The VTimer object to add to the list.

AddTimerEvent()

VTimerEvent* VTimeManager::AddTimerEvent	(	unsigned int	time,
		std::function< void()>	eventFunction,
		bool	looping = false
	)

Parameters

time	Time in milliseconds for the event to occur.
eventFunction	The event to call.
looping	If true, the timeline will start at the beginning once finished, otherwise it will destroy itself.

Returns

The VTimerEvent object that was added directly to the time manager.

Clear()

void VTimeManager::Clear

(

bool

destroy = true

)

Clears timer list.

Parameters

destroy

Destroys all timers in the list if true, else it'd need to be done manually.

Count()

int VTimeManager::Count

(

)

Returns

Amount of timers in the manager.

RemoveTimer()

void VTimeManager::RemoveTimer

(

VTimer *

timer

)

Removes a timer from the list.

Parameters

timer

The VTimer object to remove from the list.

Reserve()

void VTimeManager::Reserve

(

size_t

size

)

Reserves a set amount of timers in the list, good for optimization purposes.

Parameters

size	The amount of timers to reserve in the list.

Update()

void VTimeManager::Update

(

float

dt

)

Updates all timers.

Parameters

dt	Delta Time to increment the time by.

---

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

• D:/Development/Libs/Vigilante-Game-Framework/VFrame/VTimer.h