Sirikata::JS::JSTimer Namespace Reference

Functions
v8::Handle< v8::Value >	resetTimer (const v8::Arguments &args)
v8::Handle< v8::Value >	getAllData (const v8::Arguments &args)
v8::Handle< v8::Value >	clear (const v8::Arguments &args)
	Calling clear prevents the timer from ever re-firing again.
v8::Handle< v8::Value >	suspend (const v8::Arguments &args)
	Calling suspend prevents the timer from firing again until it is resumed.
v8::Handle< v8::Value >	getType (const v8::Arguments &args)
v8::Handle< v8::Value >	resume (const v8::Arguments &args)
	Calling this function on a timer makes it so that the timer's associated callback will fire however many seconds from now the timer was initialized with.
v8::Handle< v8::Value >	isSuspended (const v8::Arguments &args)
void	setNullTimer (const v8::Arguments &args)
	Sets args.This to point to null instead of a timer object.

---

Function Documentation

v8::Handle< v8::Value > Sirikata::JS::JSTimer::clear

(

const v8::Arguments &

args

)

Calling clear prevents the timer from ever re-firing again.

References INLINE_DECODE_TIMER_ERROR.

Referenced by Sirikata::JS::JSObjectScriptManager::createTimerTemplate(), Sirikata::JS::JSContext::ScriptClear(), and Sirikata::Graphics::OgreSystem::shape().

v8::Handle< v8::Value > Sirikata::JS::JSTimer::getAllData

(

const v8::Arguments &

args

)

References Sirikata::JS::JSTimerStruct::decodeTimerStruct(), and Sirikata::JS::JSTimerStruct::struct_getAllData().

Referenced by Sirikata::JS::JSObjectScriptManager::createTimerTemplate().

v8::Handle< v8::Value > Sirikata::JS::JSTimer::getType

(

const v8::Arguments &

args

)

Referenced by Sirikata::Graphics::CDNArchiveFactory::createInstance(), and Sirikata::JS::JSObjectScriptManager::createTimerTemplate().

v8::Handle< v8::Value > Sirikata::JS::JSTimer::isSuspended

(

const v8::Arguments &

args

)

Returns:

Boolean corresponding to whether the timer is currently suspended.

References Sirikata::JS::JSTimerStruct::decodeTimerStruct(), and Sirikata::JS::JSSuspendable::getIsSuspendedV8().

Referenced by Sirikata::JS::JSObjectScriptManager::createTimerTemplate(), Sirikata::JS::JSSystem::root_restorePresence(), and Sirikata::JS::JSSystem::root_timeout().

v8::Handle< v8::Value > Sirikata::JS::JSTimer::resetTimer

(

const v8::Arguments &

args

)

Parameters:

numeric,specifying

how long from now to go before re-firing the timer.

Returns:

boolean.

This function takes in a single argument: when the callback should actually fire from now.

References Sirikata::JS::JSTimerStruct::decodeTimerStruct(), and Sirikata::JS::JSTimerStruct::struct_resetTimer().

Referenced by Sirikata::JS::JSObjectScriptManager::createTimerTemplate().

v8::Handle< v8::Value > Sirikata::JS::JSTimer::resume

(

const v8::Arguments &

args

)

Calling this function on a timer makes it so that the timer's associated callback will fire however many seconds from now the timer was initialized with.

References Sirikata::JS::JSTimerStruct::decodeTimerStruct(), and Sirikata::JS::JSTimerStruct::resume().

Referenced by Sirikata::JS::JSObjectScriptManager::createTimerTemplate().

void Sirikata::JS::JSTimer::setNullTimer

(

const v8::Arguments &

args

)

Sets args.This to point to null instead of a timer object.

References TIMER_JSTIMERSTRUCT_FIELD.

v8::Handle< v8::Value > Sirikata::JS::JSTimer::suspend

(

const v8::Arguments &

args

)

Calling suspend prevents the timer from firing again until it is resumed.

References Sirikata::JS::JSTimerStruct::decodeTimerStruct(), and Sirikata::JS::JSTimerStruct::suspend().

Referenced by Sirikata::JS::JSObjectScriptManager::createTimerTemplate().