Differences

This shows you the differences between two versions of the page.

--- dictionary:events:createevent [2014/02/23 19:05] – external edit 127.0.0.1
+++ dictionary:events:createevent [2021/02/15 13:26] – [Passing Parameters To A Handler Example] James Sentman
@@ Line 15: / Line 15: @@
 **with no script** (perform the action, but dont run the unit scripts)\\
 **weekdays** (7 character string in the form of "-MTWTF-" use dashes for days not to execute)\\
+**handler** (string, name of the handler) If executing a script you can optionally specify the handler to call rather than just running the script. This value is ignored unless the event is to execute a script.
+**parameter** A list of items to be optionally passed to the handler. Only valid if you are executing a handler in the script. The number of parameters in the list must be the same as expected by the handler.
 ===Examples:===
@@ Line 28: / Line 30: @@
 create event "nightly" that executes script "going to bed" in 15 * minutes
 </code>
+==Passing Parameters To A Handler Example==
+if you had a global script named “meal manager” with a handler named “mealLogger” like this:
+<code>
+on mealLogger( theName, theEvent)
+    write log theName & “ has had “ & theMeal
+end doThing
+</code>
+and then created an event such as this:
+<code>
+create event “breakfast” that executes script “meal manager” handler “mealLogger" parameter {“Jamie”, “Breakfast”} in 10 * minutes
+</code>
+in 10 minutes you would see output in the log like:
+**jamie has had breakfast**
+===History:===
+The optional “handler” parameter was added in XTension 9.4.21