iPcTimer Struct Reference

Timer propery class. More...

#include <propclass/timer.h>

Inheritance diagram for iPcTimer:

List of all members.

Public Member Functions
virtual void	Clear (const char *name=0)=0
	Clear this timer.
virtual void	WakeUp (csTicks t, bool repeat, const char *name=0)=0
	Wake up the Behaviour in 't' ticks.
virtual void	WakeUpFrame (int where)=0
	Wake up the Behaviour every frame.

---

Detailed Description

Timer propery class.

This property class supports the following actions (add prefix 'cel.timer.action.' if you want to access this action through a message):

• WakeUp: parameters 'time' (long) and 'repeat' (bool). Optional 'name' (string) parameter for a named timer event.
• WakeUpFrame: no parameters.
• Clear: Optional 'name' (string) parameter for clearing a named timer event. Otherwise all timer events are cleared. If you want to clear only the anonymous timer then you can use "wakeup" as the name. Note that if no name is given then the frame event is also cleared.

This property class can send out the following messages:

• 'cel.timer.wakeup' (old 'pctimer_wakeup'): wakeup message
• 'cel.timer.wakeup.frame' (old 'pctimer_wakeupframe'): wakeup every frame (elapsedticks,currentticks)

Definition at line 46 of file timer.h.

---

Member Function Documentation

virtual void iPcTimer::Clear

(

const char *

name = 0

)

[pure virtual]

Clear this timer.

Optional 'name' (string) parameter for clearing a named timer event. Otherwise all timer events are cleared. If you want to clear only the anonymous timer then you can use "wakeup" as the name. Note that if no name is given then the frame event is also cleared. If name is equal to 'frame' then only the frame event is cleared.

virtual void iPcTimer::WakeUp	(	csTicks	t,
		bool	repeat,
		const char *	name = 0
	)		[pure virtual]

Wake up the Behaviour in 't' ticks.

If the name is not given then it is an anonymous timer (will send out message 'pctimer_wakeup'). There can only be one anonymous timer active. If you want multiple timer events then use a named timer. The message in that case will be 'pctimer_<name>'. If 'repeat' is true then this will be repeated. Otherwise there will only be one signal.

virtual void iPcTimer::WakeUpFrame

(

int

where

)

[pure virtual]

Wake up the Behaviour every frame.

---

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

• propclass/timer.h