Lua:AddSchedule - Revision history

Crazycarl at 19:25, 11 May 2009

2009-05-11T19:25:18Z

Crazycarl at 19:24, 11 May 2009

2009-05-11T19:24:20Z

Crazycarl at 22:17, 10 May 2009

2009-05-10T22:17:15Z

Crazycarl at 22:15, 10 May 2009

2009-05-10T22:15:34Z

Crazycarl: New page: {{Infobox manual/Header}} ==IsPlayer== A schedule waits for a period of time, then fires a lua function. ===Usage===

AddSchedule(schedule_id, duration, function, ...)

===Inpu...

2009-05-10T22:13:51Z

New page: {{Infobox manual/Header}} ==IsPlayer== A schedule waits for a period of time, then fires a lua function. ===Usage=== <pre>AddSchedule(schedule_id, duration, function, ...)</pre> ===Inpu...

New page

{{Infobox manual/Header}}
==IsPlayer==

A schedule waits for a period of time, then fires a lua function.

===Usage===
<pre>AddSchedule(schedule_id, duration, function, ...)</pre>

===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===
AddSchedule must refer to a user-defined lua function.

<pre>AddSchedule( "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</pre>

[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

@@ Line 8: / Line 8: @@
 ===Input===
-<ul>
+* schedule_id(string) Gives the schedule a name
-<li>schedule_id(string) Gives the schedule a name</li>
+* duration(float) number of seconds the schedule will wait before firing
-<li>duration(float) number of seconds the schedule will wait before firing</li>
+* function(function) the lua function that will be activated
-<li>function(function) the lua function that will be activated</li>
+* ...(object) OPTIONAL. Any further parameters will be passed on to the target function
-<li>...(object) OPTIONAL. Any further parameters will be passed on to the target function</li>
 ===Output===
 Returns nothing.

@@ Line 28: / Line 28: @@
 end</pre>
-[[Category:Lua_Commands]]
+[[Category:Schedules]]
 {{Infobox manual/Footer}}

@@ Line 1: / Line 1: @@
 {{Infobox manual/Header}}
-==IsPlayer==
+==AddSchedule==
-A schedule waits for a period of time, then fires a lua function.
+A schedule allows you to fire a lua function, after waiting x number of seconds.
 ===Usage===