Dragengine.Utils.TimerBlock Class Reference

Timer running block. More...

Inheritance diagram for Dragengine.Utils.TimerBlock:

Public Member Functions
void	fire ()
	Timer time elapsed.
void	giveUp ()
	Give up timer if registered with a timer manager.
TimerBlock	new (float triggerTime, bool periodic, Block blockFire)
	Create timer registered at default timer manager.
TimerBlock	new (TimerManager manager, float triggerTime, bool periodic, Block blockFire)
	Create timer registered at timer manager.
Public Member Functions inherited from Dragengine.Utils.Timer
void	advance (float elapsed)
	Advance timer.
float	getElapsedTime ()
	Elapsed seconds.
bool	getIsPeriodic ()
	Timer is periodic.
float	getRemainingTime ()
	Remaining seconds until timer elapses.
TimerManager	getTimerManager ()
	Timer manager the timer is registered at.
float	getTriggerTime ()
	Seconds until timer elapsed.
bool	hasElapsed ()
	Timer elapsed.
Timer	new (float triggerTime, bool periodic)
	Create timer registered at default timer manager.
Timer	new (TimerManager manager, float triggerTime, bool periodic)
	Create timer registered at timer manager.
void	setElapsedTime (float elapsedTime)
	Set elapsed seconds.
void	setIsPeriodic (bool periodic)
	Set if timer is periodic.
void	setTriggerTime (float triggerTime)
	Set seconds until timer elapses.

Additional Inherited Members
Public Attributes inherited from Dragengine.Utils.Timer
float	pElapsedTime
bool	pIsPeriodic
TimerManager	pTimerManager
float	pTriggerTime

Detailed Description

Timer running block.

Member Function Documentation

fire()

void Dragengine.Utils.TimerBlock.fire

(

)

Timer time elapsed.

Reimplemented from Dragengine.Utils.Timer.

giveUp()

void Dragengine.Utils.TimerBlock.giveUp

(

)

Give up timer if registered with a timer manager.

Call to give up pending timer. Dropping the reference alone does not give up the timer.

Reimplemented from Dragengine.Utils.Timer.

new() [1/2]

TimerBlock Dragengine.Utils.TimerBlock.new	(	float	triggerTime,
		bool	periodic,
		Block	blockFire
	)

Create timer registered at default timer manager.

Parameters

triggerTime	Seconds to wait before triggering
periodic	Reschedule trigger once finished.
blockFire	Block to run. Block has no parameters.

new() [2/2]

TimerBlock Dragengine.Utils.TimerBlock.new	(	TimerManager	manager,
		float	triggerTime,
		bool	periodic,
		Block	blockFire
	)

Create timer registered at timer manager.

Parameters

manager	Timer Manager to register timer at
triggerTime	Seconds to wait before triggering
periodic	True if this timer is periodic
blockFire	Block to run. Block has no parameters.

---

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

• TimerBlock.ds