Difference between revisions of "Lua:AddScheduleRepeating"

From Fortress Forever Wiki
Jump to navigationJump to search
(New page: {{Infobox manual/Header}} ==AddScheduleRepeating== Waits a period of time, then fires a lua function. Repeats indefinitely. ===Usage=== <pre>AddScheduleRepeating(schedule_id, duration, f...)
(No difference)

Revision as of 14:25, 10 May 2009


AddScheduleRepeating

Waits a period of time, then fires a lua function. Repeats indefinitely.

Usage

AddScheduleRepeating(schedule_id, duration, function, ...)

Input

  • schedule_id(string) Gives the schedule a name
  • duration(float) number of seconds the schedule will wait before firing
  • function(function) the lua function that will be activated
  • ...(object) OPTIONAL. Any further parameters will be passed on to the target function

Output

Returns nothing.

Example

AddScheduleRepeating must refer to a user-defined lua function.

AddScheduleRepeating( "my_schedule", 3.3, DoSomething, "hello")

--This function can be defined anywhere in the file--wherever is convenient.
function DoSomething (myString)
	--myString now equals "hello"
	--Do other stuff
end