2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
< html >
2020-06-15 21:52:33 +02:00
< head >
< meta charset = "utf-8" / >
2021-05-16 00:06:01 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.17.1: http://docutils.sourceforge.net/" / >
2020-06-15 21:52:33 +02:00
< title > MonitorHandler — Evennia 1.0-dev documentation< / title >
2020-07-14 00:21:00 +02:00
< link rel = "stylesheet" href = "../_static/nature.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
< script id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script src = "../_static/language_data.js" > < / script >
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
2020-06-15 21:52:33 +02:00
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
2020-07-14 00:21:00 +02:00
< a href = "../genindex.html" title = "General Index"
2020-06-15 21:52:33 +02:00
accesskey="I">index< / a > < / li >
< li class = "right" >
2020-07-14 00:21:00 +02:00
< a href = "../py-modindex.html" title = "Python Module Index"
2020-06-15 21:52:33 +02:00
>modules< / a > |< / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > MonitorHandler< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-06-15 21:52:33 +02:00
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2020-06-13 00:36:45 +02:00
2021-05-16 00:06:01 +02:00
< section id = "monitorhandler" >
2020-06-13 00:36:45 +02:00
< h1 > MonitorHandler< a class = "headerlink" href = "#monitorhandler" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-06-16 22:49:43 +02:00
< p > The < em > MonitorHandler< / em > is a system for watching changes in properties or Attributes on objects. A
monitor can be thought of as a sort of trigger that responds to change.< / p >
< p > The main use for the MonitorHandler is to report changes to the client; for example the client
Session may ask Evennia to monitor the value of the Characer’ < code class = "docutils literal notranslate" > < span class = "pre" > health< / span > < / code > attribute and report
whenever it changes. This way the client could for example update its health bar graphic as needed.< / p >
2021-05-16 00:06:01 +02:00
< section id = "using-the-monitorhandler" >
2020-06-13 00:36:45 +02:00
< h2 > Using the MonitorHandler< a class = "headerlink" href = "#using-the-monitorhandler" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-06-16 22:49:43 +02:00
< p > The MontorHandler is accessed from the singleton < code class = "docutils literal notranslate" > < span class = "pre" > evennia.MONITOR_HANDLER< / span > < / code > . The code for the handler
is in < code class = "docutils literal notranslate" > < span class = "pre" > evennia.scripts.monitorhandler< / span > < / code > .< / p >
2020-06-13 00:36:45 +02:00
< p > Here’ < / p >
2021-05-16 00:06:01 +02:00
< div class = "highlight-python notranslate" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span class = "normal" > 1< / span >
< span class = "normal" > 2< / span >
< span class = "normal" > 3< / span >
< span class = "normal" > 4< / span > < / pre > < / div > < / td > < td class = "code" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > from< / span > < span class = "nn" > evennia< / span > < span class = "kn" > import< / span > < span class = "n" > MONITOR_HANDLER< / span >
2020-06-13 00:36:45 +02:00
< span class = "n" > MONITOR_HANDLER< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "n" > fieldname< / span > < span class = "p" > ,< / span > < span class = "n" > callback< / span > < span class = "p" > ,< / span >
2020-12-20 14:36:24 +01:00
< span class = "n" > idstring< / span > < span class = "o" > =< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span > < span class = "n" > persistent< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span >
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / td > < / tr > < / table > < / div >
< ul class = "simple" >
2020-06-16 22:49:43 +02:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > obj< / span > < / code > (< a class = "reference internal" href = "Typeclasses.html" > < span class = "doc" > Typeclassed< / span > < / a > entity) - the object to monitor. Since this must be
typeclassed, it means you can’ < a class = "reference internal" href = "Sessions.html" > < span class = "doc" > Sessions< / span > < / a > with the monitorhandler, for
example.< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > fieldname< / span > < / code > (str) - the name of a field or < a class = "reference internal" href = "Attributes.html" > < span class = "doc" > Attribute< / span > < / a > on < code class = "docutils literal notranslate" > < span class = "pre" > obj< / span > < / code > . If you want to
monitor a database field you must specify its full name, including the starting < code class = "docutils literal notranslate" > < span class = "pre" > db_< / span > < / code > (like
< code class = "docutils literal notranslate" > < span class = "pre" > db_key< / span > < / code > , < code class = "docutils literal notranslate" > < span class = "pre" > db_location< / span > < / code > etc). Any names not starting with < code class = "docutils literal notranslate" > < span class = "pre" > db_< / span > < / code > are instead assumed to be the names
of Attributes. This difference matters, since the MonitorHandler will automatically know to watch
the < code class = "docutils literal notranslate" > < span class = "pre" > db_value< / span > < / code > field of the Attribute.< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > callback< / span > < / code > (callable) - This will be called as < code class = "docutils literal notranslate" > < span class = "pre" > callback(fieldname=fieldname,< / span > < span class = "pre" > obj=obj,< / span > < span class = "pre" > **kwargs)< / span > < / code >
when the field updates.< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > idstring< / span > < / code > (str) - this is used to separate multiple monitors on the same object and fieldname.
This is required in order to properly identify and remove the monitor later. It’
saving it.< / p > < / li >
2020-06-13 00:36:45 +02:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > persistent< / span > < / code > (bool) - if True, the monitor will survive a server reboot.< / p > < / li >
< / ul >
< p > Example:< / p >
2021-05-16 00:06:01 +02:00
< div class = "highlight-python notranslate" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span class = "normal" > 1< / span >
< span class = "normal" > 2< / span >
< span class = "normal" > 3< / span >
< span class = "normal" > 4< / span >
< span class = "normal" > 5< / span >
< span class = "normal" > 6< / span >
< span class = "normal" > 7< / span >
< span class = "normal" > 8< / span >
< span class = "normal" > 9< / span >
< span class = "normal" > 10< / span >
< span class = "normal" > 11< / span >
< span class = "normal" > 12< / span >
< span class = "normal" > 13< / span >
< span class = "normal" > 14< / span >
< span class = "normal" > 15< / span >
< span class = "normal" > 16< / span >
< span class = "normal" > 17< / span >
< span class = "normal" > 18< / span >
< span class = "normal" > 19< / span >
< span class = "normal" > 20< / span >
< span class = "normal" > 21< / span > < / pre > < / div > < / td > < td class = "code" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > from< / span > < span class = "nn" > evennia< / span > < span class = "kn" > import< / span > < span class = "n" > MONITOR_HANDLER< / span > < span class = "k" > as< / span > < span class = "n" > monitorhandler< / span >
2020-06-13 00:36:45 +02:00
2020-12-20 14:36:24 +01:00
< span class = "k" > def< / span > < span class = "nf" > _monitor_callback< / span > < span class = "p" > (< / span > < span class = "n" > fieldname< / span > < span class = "o" > =< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span > < span class = "n" > obj< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
2020-06-13 00:36:45 +02:00
< span class = "c1" > # reporting callback that works both< / span >
< span class = "c1" > # for db-fields and Attributes< / span >
< span class = "k" > if< / span > < span class = "n" > fieldname< / span > < span class = "o" > .< / span > < span class = "n" > startswith< / span > < span class = "p" > (< / span > < span class = "s2" > " db_" < / span > < span class = "p" > ):< / span >
< span class = "n" > new_value< / span > < span class = "o" > =< / span > < span class = "nb" > getattr< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "n" > fieldname< / span > < span class = "p" > )< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span > < span class = "c1" > # an attribute < / span >
< span class = "n" > new_value< / span > < span class = "o" > =< / span > < span class = "n" > obj< / span > < span class = "o" > .< / span > < span class = "n" > attributes< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "n" > fieldname< / span > < span class = "p" > )< / span >
< span class = "n" > obj< / span > < span class = "o" > .< / span > < span class = "n" > msg< / span > < span class = "p" > (< / span > < span class = "s2" > " < / span > < span class = "si" > %s< / span > < span class = "s2" > .< / span > < span class = "si" > %s< / span > < span class = "s2" > changed to ' < / span > < span class = "si" > %s< / span > < span class = "s2" > ' ." < / span > < span class = "o" > %< / span > \
< span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "o" > .< / span > < span class = "n" > key< / span > < span class = "p" > ,< / span > < span class = "n" > fieldname< / span > < span class = "p" > ,< / span > < span class = "n" > new_value< / span > < span class = "p" > ))< / span >
< span class = "c1" > # (we could add _some_other_monitor_callback here too)< / span >
< span class = "c1" > # monitor Attribute (assume we have obj from before)< / span >
< span class = "n" > monitorhandler< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "s2" > " desc" < / span > < span class = "p" > ,< / span > < span class = "n" > _monitor_callback< / span > < span class = "p" > )< / span >
< span class = "c1" > # monitor same db-field with two different callbacks (must separate by id_string)< / span >
< span class = "n" > monitorhandler< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "s2" > " db_key" < / span > < span class = "p" > ,< / span > < span class = "n" > _monitor_callback< / span > < span class = "p" > ,< / span > < span class = "n" > id_string< / span > < span class = "o" > =< / span > < span class = "s2" > " foo" < / span > < span class = "p" > )< / span >
< span class = "n" > monitorhandler< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "s2" > " db_key" < / span > < span class = "p" > ,< / span > < span class = "n" > _some_other_monitor_callback< / span > < span class = "p" > ,< / span > < span class = "n" > id_string< / span > < span class = "o" > =< / span > < span class = "s2" > " bar" < / span > < span class = "p" > )< / span >
< / pre > < / div >
< / td > < / tr > < / table > < / div >
2020-06-16 22:49:43 +02:00
< p > A monitor is uniquely identified by the combination of the < em > object instance< / em > it is monitoring, the
< em > name< / em > of the field/attribute to monitor on that object and its < code class = "docutils literal notranslate" > < span class = "pre" > idstring< / span > < / code > (< code class = "docutils literal notranslate" > < span class = "pre" > obj< / span > < / code > + < code class = "docutils literal notranslate" > < span class = "pre" > fieldname< / span > < / code > +
< code class = "docutils literal notranslate" > < span class = "pre" > idstring< / span > < / code > ). The < code class = "docutils literal notranslate" > < span class = "pre" > idstring< / span > < / code > will be the empty string unless given explicitly.< / p >
< p > So to “un-monitor” the above you need to supply enough information for the system to uniquely find
the monitor to remove:< / p >
2020-06-13 00:36:45 +02:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > monitorhandler< / span > < span class = "o" > .< / span > < span class = "n" > remove< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "s2" > " desc" < / span > < span class = "p" > )< / span >
< span class = "n" > monitorhandler< / span > < span class = "o" > .< / span > < span class = "n" > remove< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "s2" > " db_key" < / span > < span class = "p" > ,< / span > < span class = "n" > idstring< / span > < span class = "o" > =< / span > < span class = "s2" > " foo" < / span > < span class = "p" > )< / span >
< span class = "n" > monitorhandler< / span > < span class = "o" > .< / span > < span class = "n" > remove< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "s2" > " db_key" < / span > < span class = "p" > ,< / span > < span class = "n" > idstring< / span > < span class = "o" > =< / span > < span class = "s2" > " bar" < / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
2021-05-16 00:06:01 +02:00
< / section >
< / section >
2020-06-13 00:36:45 +02:00
2020-10-15 01:31:30 +02:00
< div class = "clearer" > < / div >
2020-06-13 00:36:45 +02:00
< / div >
< / div >
< / div >
2020-06-15 21:52:33 +02:00
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
2020-07-14 00:21:00 +02:00
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo" / >
2020-06-15 21:52:33 +02:00
< / a > < / p >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
2020-07-14 00:21:00 +02:00
< form class = "search" action = "../search.html" method = "get" >
2020-06-15 21:52:33 +02:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
2020-07-14 00:21:00 +02:00
< p > < h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
2020-06-15 21:52:33 +02:00
< ul >
< li > < a class = "reference internal" href = "#" > MonitorHandler< / a > < ul >
< li > < a class = "reference internal" href = "#using-the-monitorhandler" > Using the MonitorHandler< / a > < / li >
< / ul >
< / li >
< / ul >
2020-06-13 00:36:45 +02:00
2020-06-15 21:52:33 +02:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
2020-07-14 00:21:00 +02:00
< li > < a href = "../_sources/Components/MonitorHandler.md.txt"
2020-06-15 21:52:33 +02:00
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
2021-03-06 01:37:43 +01:00
< / div > < h3 > Links< / h3 >
< ul >
< li > < a href = "https://www.evennia.com" > Home page< / a > < / li >
< li > < a href = "https://github.com/evennia/evennia" > Evennia Github< / a > < / li >
< li > < a href = "http://games.evennia.com" > Game Index< / a > < / li >
2021-08-06 00:47:51 +02:00
< li >
< a href = "https://discord.gg/AJJpcRUhtF" > Discord< / a > -
< a href = "https://github.com/evennia/evennia/discussions" > Discussions< / a > -
2021-08-06 00:53:44 +02:00
< a href = "https://evennia.blogspot.com/" > Blog< / a >
2021-03-06 01:37:43 +01:00
< / li >
< / ul >
2020-06-15 21:52:33 +02:00
< h3 > Versions< / h3 >
< ul >
< li > < a href = "MonitorHandler.html" > 1.0-dev (develop branch)< / a > < / li >
2020-11-14 13:44:49 +01:00
< li > < a href = "../../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2020-06-14 21:48:02 +02:00
2020-06-15 21:52:33 +02:00
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
2020-07-14 00:21:00 +02:00
< a href = "../genindex.html" title = "General Index"
2020-06-15 21:52:33 +02:00
>index< / a > < / li >
< li class = "right" >
2020-07-14 00:21:00 +02:00
< a href = "../py-modindex.html" title = "Python Module Index"
2020-06-15 21:52:33 +02:00
>modules< / a > |< / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > MonitorHandler< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-06-15 21:52:33 +02:00
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2020, The Evennia developer community.
2020-10-15 01:31:30 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
2020-06-15 21:52:33 +02:00
< / div >
< / body >
2020-06-13 00:36:45 +02:00
< / html >
