DCS func scheduleFunction - Revision history

Grimes at 10:25, 27 April 2025

2025-04-27T10:25:24Z

@@ Line 63: / Line 63: @@
   end
   timer.scheduleFunction(CheckStatus, 53, timer.getTime() + 5)
 |notes=

Grimes at 06:44, 17 March 2022

2022-03-17T06:44:20Z

← Older revision		Revision as of 06:44, 17 March 2022
Line 67:		Line 67:
	}}		}}
	[[Category:Singleton Functions\|scheduleFunction]]		[[Category:Singleton Functions\|scheduleFunction]]
			[[Category:Game Patch 1.2.0\|scheduleFunction]]

Bailey at 16:20, 8 February 2022

2022-02-08T16:20:21Z

← Older revision		Revision as of 16:20, 8 February 2022
Line 16:		Line 16:

	The function that is called is expected to return nil or a number which will indicate the next time the function will be rescheduled.		The function that is called is expected to return nil or a number which will indicate the next time the function will be rescheduled.
	Use the second argument in that function to retrieve the current time and add the desired amount of delay (expressed in seconds)		Use the second argument in that function to retrieve the current time and add the desired amount of delay (expressed in seconds).

	\|rtnType= functionId		\|rtnType= functionId

Grimes: 1 revision imported

2018-04-12T00:12:15Z

1 revision imported

New page

{{Template:dcs_funcs

|fName= scheduleFunction

|vNum= 1.2.0

|par1= [[DCS_singleton_timer|timer]]

|par2=

|par3=

|par4=

|desc= Schedules a function to run at a time in the future. This is a very powerful function.

The function that is called is expected to return nil or a number which will indicate the next time the function will be rescheduled.
Use the second argument in that function to retrieve the current time and add the desired amount of delay (expressed in seconds)

|rtnType= functionId

|rtnExample= 3

|reqType1= function

|reqName1= functionToCall

|reqType2= functionArgs

|reqName2= anyFunctionArguement

|reqType3= time

|reqName3= modelTime

|reqType4=

|optType1=

|optName1=

|optType2=

|related=
[[DCS_singleton_timer|'''timer Functions:''']] {{listOfTimerFuncs}}

|examples= The following will run a function named "main" 120 seconds from one the code would run.
timer.scheduleFunction(main, {}, timer.getTime() + 120)

The following example sets up a repetitive call loop where function CheckStatus is called every 5 seconds or.

function CheckStatus(ourArgument, time)
-- Do things to check, use ourArgument (which is the scheduleFunction's second argument)
if ourArgument == 53 and someExternalCondition then
-- Keep going
return time + 5
else
-- That's it we're done looping
return nil
end
end
timer.scheduleFunction(CheckStatus, 53, timer.getTime() + 5)

|notes=
}}
[[Category:Singleton Functions|scheduleFunction]]