Terminate (event) - Revision history

TheOriginalBIT: Less confusing example for newbies. Also removed the comment that was implying to override os.pullEvent if you wish to capture this event

2013-10-28T09:48:24Z

Less confusing example for newbies. Also removed the comment that was implying to override os.pullEvent if you wish to capture this event

1lann: Better description and mentions on how it indirectly calls error within the bios

2013-06-10T20:23:28Z

Better description and mentions on how it indirectly calls error within the bios

Superaxander at 22:44, 27 March 2013

2013-03-27T22:44:29Z

Superaxander at 22:44, 27 March 2013

2013-03-27T22:44:01Z

Superaxander at 22:42, 27 March 2013

2013-03-27T22:42:59Z

Superaxander at 22:42, 27 March 2013

2013-03-27T22:42:36Z

AfterLifeLochie: Created event page

2012-11-30T12:14:32Z

Created event page

New page

{{NeedsWork|A demonstration on the use and handling of this event would be beneficial. ''[[User:AfterLifeLochie|AfterLifeLochie]] 16:13, 30 November 2012 (MSK)''}}

{{Event
|name=terminate
|desc=Fired when CTRL+T is held to terminate the running program.
}}

@@ Line 1: / Line 1: @@
 {{Event
 |name=terminate
-|desc=Fired when CTRL+T is held for at least 1 second. With an unmodified bios and os.pullEvent, it indirectly calls error().
+|desc=Fired when CTRL+T is held for at least 1 second. '''NOTE:''' This event cannot be captured with an unmodified [[os.pullEvent]], [[os.pullEventRaw]] or [[coroutine.yield]] should be used whenever possible instead of overriding os.pullEvent
 }}
 {{Example
-|desc=The actual terminating part of CTRL+T is defined in the bios for os.pullEvent. This can however be overridden to catch terminate and modify it's effects, as shown below. Note that holding CTRL+T, and it firing the terminate event is independent of key events and is hard coded into ComputerCraft.
+|desc=This loop listens for the terminate event and exits the program when found, cleaning the screen first
-|code=function os.pullEvent(_sFilter)
+|code=while true do
-    local event = { os.pullEventRaw(_sFilter) }
+   local event = os.pullEventRaw()
-    if event[1] == "terminate" then
+   if event == "terminate" then
-      error("Terminate Event Found", 0)
+     term.clear()
-    end
+     term.setCursorPos(1,1)
-    return unpack(event)
+     return
-  end
+   else
 }}

@@ Line 3: / Line 3: @@
 {{Event
 |name=terminate
-|desc=Fired when CTRL+T is held to terminate the running program.
+|desc=Fired when CTRL+T is held for at least 1 second. With an unmodified bios and os.pullEvent, it indirectly calls error().
 }}
 {{Example
-|desc=This overides the [[os.pullEvent]] function to display a custom message when a program is terminated
+|desc=The actual terminating part of CTRL+T is defined in the bios for os.pullEvent. This can however be overridden to catch terminate and modify it's effects, as shown below. Note that holding CTRL+T, and it firing the terminate event is independent of key events and is hard coded into ComputerCraft.
-|code=  function os.pullEvent(_sFilter)
+|code=function os.pullEvent(_sFilter)
      local event = { os.pullEventRaw(_sFilter) }
      if event[1] == "terminate" then

@@ Line 8: / Line 8: @@
 |desc=This overides the [[os.pullEvent]] function to display a custom message when a program is terminated
 |code=  function os.pullEvent(_sFilter)
-  local event = { os.pullEventRaw(_sFilter) }
+    local event = { os.pullEventRaw(_sFilter) }
      if event[1] == "terminate" then
        error("Terminate Event Found", 0)

@@ Line 7: / Line 7: @@
 {{Example
 |desc=This overides the [[os.pullEvent]] function to display a custom message when a program is terminated
-|code=function os.pullEvent(_sFilter)
+|code=  function os.pullEvent(_sFilter)
    local event = { os.pullEventRaw(_sFilter) }
-  if event[1] == "terminate" then
+    if event[1] == "terminate" then
-    error("Terminate Event Found", 0)
+      error("Terminate Event Found", 0)
    end
 }}

@@ Line 6: / Line 6: @@
 }}
 {{Example
-|desc=This overides the [[os.pullEvent()]] function to display a custom message when a program is terminated
+|desc=This overides the [[os.pullEvent]] function to display a custom message when a program is terminated
 |code=function os.pullEvent(_sFilter)
    local event = { os.pullEventRaw(_sFilter) }