tools.c File Reference

Go to the source code of this file.

Classes
class	ScriptCallQueue
	ScriptCallQueue Class provide "lazy" calls - when we don't want to execute function immediately but later during frame update (used mainly in UI) usage: More...

Typedefs
typedef ScriptInvokerBase< func >	ScriptInvoker

Functions
class ScriptCallQueue	Invoke (void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL)
	ScriptInvoker Class provide list of callbacks usage:
proto native void	Tick (float timeslice)
	executes calls on queue if their time is already elapsed, if 'repeat = false' call is removed from queue
proto void	Call (func fn, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL)
	adds call into the queue with given parameters and arguments (arguments are holded in memory until the call is executed/removed or ScriptCallQueue is destroyed)
proto void	CallByName (Managed obj, string fnName, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL)
	adds call into the queue with given parameters and arguments (arguments are holded in memory until the call is executed/removed or ScriptCallQueue is destroyed)
proto void	CallLater (func fn, int delay=0, bool repeat=false, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL)
	adds call into the queue with given parameters and arguments (arguments are holded in memory until the call is executed/removed or ScriptCallQueue is destroyed)
proto void	CallLaterByName (Managed obj, string fnName, int delay=0, bool repeat=false, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL)
	adds call into the queue with given parameters and arguments (arguments are holded in memory until the call is executed/removed or ScriptCallQueue is destroyed)
proto void	Remove (func fn)
	remove specific call from queue
proto int	GetRemainingTime (func fn)
	return Remaining time to the call execution (in miliseconds)
proto void	RemoveByName (Managed obj, string fnName)
	remove specific call from queue
proto int	GetRemainingTimeByName (Managed obj, string fnName)
	return Remaining time to the call execution (in miliseconds)
proto native void	Clear ()
	remove all calls from queue
proto native void	Dump ()
	dump all callbacks into log
proto void	Insert (T fn)
	Insert method to list.
proto void	Remove (T fn)
	Remove specific call from list.

Typedef Documentation

ScriptInvoker

typedef ScriptInvokerBase<func> ScriptInvoker

Definition at line 134 of file tools.c.

Function Documentation

Call()

proto void Invoke::Call	(	func	fn,
		void	param1 = NULL,
		void	param2 = NULL,
		void	param3 = NULL,
		void	param4 = NULL,
		void	param5 = NULL,
		void	param6 = NULL,
		void	param7 = NULL,
		void	param8 = NULL,
		void	param9 = NULL )

adds call into the queue with given parameters and arguments (arguments are holded in memory until the call is executed/removed or ScriptCallQueue is destroyed)

CallByName()

proto void Invoke::CallByName	(	Managed	obj,
		string	fnName,
		void	param1 = NULL,
		void	param2 = NULL,
		void	param3 = NULL,
		void	param4 = NULL,
		void	param5 = NULL,
		void	param6 = NULL,
		void	param7 = NULL,
		void	param8 = NULL,
		void	param9 = NULL )

adds call into the queue with given parameters and arguments (arguments are holded in memory until the call is executed/removed or ScriptCallQueue is destroyed)

CallLater()

proto void Invoke::CallLater	(	func	fn,
		int	delay = 0,
		bool	repeat = false,
		void	param1 = NULL,
		void	param2 = NULL,
		void	param3 = NULL,
		void	param4 = NULL,
		void	param5 = NULL,
		void	param6 = NULL,
		void	param7 = NULL,
		void	param8 = NULL,
		void	param9 = NULL )

adds call into the queue with given parameters and arguments (arguments are holded in memory until the call is executed/removed or ScriptCallQueue is destroyed)

CallLaterByName()

proto void Invoke::CallLaterByName	(	Managed	obj,
		string	fnName,
		int	delay = 0,
		bool	repeat = false,
		void	param1 = NULL,
		void	param2 = NULL,
		void	param3 = NULL,
		void	param4 = NULL,
		void	param5 = NULL,
		void	param6 = NULL,
		void	param7 = NULL,
		void	param8 = NULL,
		void	param9 = NULL )

adds call into the queue with given parameters and arguments (arguments are holded in memory until the call is executed/removed or ScriptCallQueue is destroyed)

Dump()

proto native void Dump

(

)

dump all callbacks into log

Dump all callbacks into debug log.

Warning

Log level must be set at last to DEBUG level ('-logLevel debug' in CLI) to see debug logs.

GetRemainingTime()

proto int Invoke::GetRemainingTime

(

func

fn

)

return Remaining time to the call execution (in miliseconds)

GetRemainingTimeByName()

proto int Invoke::GetRemainingTimeByName	(	Managed	obj,
		string	fnName )

return Remaining time to the call execution (in miliseconds)

Insert()

proto void Insert

(

T

fn

)

Insert method to list.

Invoke()

class ScriptCallQueue Invoke	(	void	param1 = NULL,
		void	param2 = NULL,
		void	param3 = NULL,
		void	param4 = NULL,
		void	param5 = NULL,
		void	param6 = NULL,
		void	param7 = NULL,
		void	param8 = NULL,
		void	param9 = NULL )

ScriptInvoker Class provide list of callbacks
usage:

Invoke call on all inserted methods with given arguments.

Remove() [1/2]

proto void Invoke::Remove

(

func

fn

)

remove specific call from queue

Remove() [2/2]

proto void Remove

(

T

fn

)

Remove specific call from list.

RemoveByName()

proto void Invoke::RemoveByName	(	Managed	obj,
		string	fnName )

remove specific call from queue

Tick()

proto native void Invoke::Tick

(

float

timeslice

)

executes calls on queue if their time is already elapsed, if 'repeat = false' call is removed from queue