library-mirrors/beholder.lua
1
0
Fork 0
mirror of https://github.com/kikito/beholder.lua.git synced 2024-12-16 00:34:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

added halting event observation section on README

Browse Source
This commit is contained in:
Enrique García 2011-11-01 22:45:05 +01:00
parent abf046d8db
commit 6f4eff548f
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.textile
View File

@ -72,6 +72,16 @@ This library allows you to build "walls" between them: your keyboard code will j
You can obviously attach any number of observers to any given event. Similarly, you are You can obviously attach any number of observers to any given event. Similarly, you are
h1. Halting event observation
Every call to @beholder:observe@ returns an identifier which can be stored:
<pre>local id = beholder:observe("FOO", bar, baz)</pre>
That identifier can be used to cancel the observation at any moment. You can do so by using the @beholder:stopObserving@ method:
<pre>beholder:stopObserving(id)</pre>
h1. Composed events h1. Composed events
Events can be any type of Lua object. On the example, we used the "PAUSE" string. It could also be a number, a function or a table. The == operator is used in all cases. Events can be any type of Lua object. On the example, we used the "PAUSE" string. It could also be a number, a function or a table. The == operator is used in all cases.