SchedulerScriptHandlerEntry Class Reference

The SchedulerScriptHandlerEntry is used to store the handler corresponding to the Lua function pointer and assign the handler a unique id like ScriptHandlerEntry. More...

#include <ScriptSupport.h>

Inherits ScriptHandlerEntry.

Public Member Functions
virtual	~SchedulerScriptHandlerEntry ()
	Destructor of SchedulerScriptHandlerEntry.
TimerScriptHandler *	getTimer ()
	Get the pointer of TimerScriptHandler object.
bool	isPaused ()
	Get the flag whether paused or not.
void	markedForDeletion ()
	Set the markedForDeletion flag true.
bool	isMarkedForDeletion ()
	Get the flag whether markedForDeletion or not.
Public Member Functions inherited from ScriptHandlerEntry
virtual	~ScriptHandlerEntry ()
	Destructor of ScriptHandlerEntry.
int	getHandler ()
	Get the handler corresponding to the Lua function pointer.
int	getEntryId ()
	Get the unique id corresponding to the handler.
Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
virtual	~Object ()
	Destructor.

Static Public Member Functions
static SchedulerScriptHandlerEntry *	create (int handler, float interval, bool paused)
	create a SchedulerScriptHandlerEntry object.
Static Public Member Functions inherited from ScriptHandlerEntry
static ScriptHandlerEntry *	create (int handler)
	create a ScriptHandlerEntry instance by the handler.

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.

Detailed Description

The SchedulerScriptHandlerEntry is used to store the handler corresponding to the Lua function pointer and assign the handler a unique id like ScriptHandlerEntry.

Meanwhile,create a timer that named TimerScriptHandler to execute the Lua function corresponding to the handler in the interval time if the SchedulerScriptHandlerEntry object isn't paused. @js NA

Constructor & Destructor Documentation

~SchedulerScriptHandlerEntry()

virtual ~SchedulerScriptHandlerEntry ( )

virtual

Destructor of SchedulerScriptHandlerEntry.

@js NA @lua NA

Member Function Documentation

create()

static SchedulerScriptHandlerEntry * create ( int handler, float interval, bool paused )

static

create a SchedulerScriptHandlerEntry object.

Parameters

handler	the index corresponding to the Lua function pointer.
interval	the interval to execute the Lua function. If the value is 0, then the lua function will be scheduled every frame.
paused	if paused is true, then the timer won't be started until it is resumed.

Returns

a SchedulerScriptHandlerEntry object. @js NA @lua NA

getTimer()

TimerScriptHandler * getTimer ( )

inline

Get the pointer of TimerScriptHandler object.

Returns

the pointer of TimerScriptHandler object. @js NA @lua NA

isPaused()

bool isPaused ( )

inline

Get the flag whether paused or not.

Returns

the flag whether paused or not. @js NA @lua NA

markedForDeletion()

void markedForDeletion ( )

inline

Set the markedForDeletion flag true.

@js NA @lua NA

isMarkedForDeletion()

bool isMarkedForDeletion ( )

inline

Get the flag whether markedForDeletion or not.

Returns

the flag whether markedForDeletion or not. @js NA @lua NA

---

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

• ScriptSupport.h