CScriptBind_Script::SetTimerForFunction Method

Syntax

C++

int SetTimerForFunction(IFunctionHandler* pH, int nMilliseconds, const char* sFunctionName);

Parameters

Parameters	Description
int nMilliseconds	Delay of trigger in milliseconds.
luaFunction	.
userData	(optional) Any user defined table. If specified it will be passed as a first argument of the callback function.
bUpdateDuringPause	(optional) will be updated and trigger even if in pause mode.

Returns

ID assigned to this timer or nil if not specified.

Description

Script.SetTimerForFunction( nMilliseconds, luaFunction [, userData [, bUpdateDuringPause]] )

! ! Set a general script timer, when timer expires will call back a specified lua function. ! Lua function will accept 1 or 2 parameters, ! if userData is specified luaFunction must be: !

LuaCallback = function( userData,nTimerId ) ! -- function body ! end;

! if userData is not specified luaFunction must be: !

LuaCallback = function( nTimerId ) ! -- function body ! end;

!.!

Group

CScriptBind_Script Methods

Made with Doc-O-Matic® Express