2020-07-14 00:21:00 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
< html >
2020-07-14 00:21:00 +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/" / >
2022-01-08 16:38:41 +01:00
< title > evennia.contrib.tutorials.mirror.mirror — 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" / >
2022-02-06 18:34:09 +00:00
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "evennia.contrib.tutorials.red_button" href = "evennia.contrib.tutorials.red_button.html" / >
< link rel = "prev" title = "evennia.contrib.tutorials.mirror" href = "evennia.contrib.tutorials.mirror.html" / >
2020-07-14 00:21:00 +02:00
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
2022-02-06 18:34:09 +00:00
< li class = "right" >
< a href = "evennia.contrib.tutorials.red_button.html" title = "evennia.contrib.tutorials.red_button"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "evennia.contrib.tutorials.mirror.html" title = "evennia.contrib.tutorials.mirror"
accesskey="P">previous< / 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 >
2022-02-06 18:34:09 +00:00
< li class = "nav-item nav-item-1" > < a href = "../Evennia-API.html" > API Summary< / a > » < / li >
< li class = "nav-item nav-item-2" > < a href = "evennia-api.html" > evennia< / a > » < / li >
< li class = "nav-item nav-item-3" > < a href = "evennia.html" > evennia< / a > » < / li >
< li class = "nav-item nav-item-4" > < a href = "evennia.contrib.html" > evennia.contrib< / a > » < / li >
< li class = "nav-item nav-item-5" > < a href = "evennia.contrib.tutorials.html" > evennia.contrib.tutorials< / a > » < / li >
< li class = "nav-item nav-item-6" > < a href = "evennia.contrib.tutorials.mirror.html" accesskey = "U" > evennia.contrib.tutorials.mirror< / a > » < / li >
2022-01-08 16:38:41 +01:00
< li class = "nav-item nav-item-this" > < a href = "" > evennia.contrib.tutorials.mirror.mirror< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-07-14 00:21:00 +02:00
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2022-01-08 16:38:41 +01:00
< section id = "module-evennia.contrib.tutorials.mirror.mirror" >
< span id = "evennia-contrib-tutorials-mirror-mirror" > < / span > < h1 > evennia.contrib.tutorials.mirror.mirror< a class = "headerlink" href = "#module-evennia.contrib.tutorials.mirror.mirror" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-06-23 18:58:26 +02:00
< p > TutorialMirror< / p >
< p > A simple mirror object to experiment with.< / p >
< dl class = "py class" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.tutorials.mirror.mirror.TutorialMirror" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > evennia.contrib.tutorials.mirror.mirror.< / code > < code class = "sig-name descname" > TutorialMirror< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "o" > *< / span > < span class = "n" > args< / span > < / em > , < em class = "sig-param" > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/evennia/contrib/tutorials/mirror/mirror.html#TutorialMirror" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.contrib.tutorials.mirror.mirror.TutorialMirror" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-06-23 18:58:26 +02:00
< dd > < p > Bases: < a class = "reference internal" href = "evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title = "evennia.objects.objects.DefaultObject" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > evennia.objects.objects.DefaultObject< / span > < / code > < / a > < / p >
< p > A simple mirror object that
- echoes back the description of the object looking at it
- echoes back whatever is being sent to its .msg - to the< / p >
< blockquote >
< div > < p > sender, if given, otherwise to the location of the mirror.< / p >
< / div > < / blockquote >
< dl class = "py method" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.tutorials.mirror.mirror.TutorialMirror.return_appearance" >
< code class = "sig-name descname" > return_appearance< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > looker< / span > < / em > , < em class = "sig-param" > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/evennia/contrib/tutorials/mirror/mirror.html#TutorialMirror.return_appearance" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.contrib.tutorials.mirror.mirror.TutorialMirror.return_appearance" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-06-23 18:58:26 +02:00
< dd > < p > This formats the description of this object. Called by the ‘ ’ < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > looker< / strong > (< em > Object< / em > ) – < / p > < / li >
< li > < p > < strong > **kwargs< / strong > (< em > dict< / em > ) –
overriding the call (unused by default).< / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.tutorials.mirror.mirror.TutorialMirror.msg" >
< code class = "sig-name descname" > msg< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > text< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > from_obj< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/evennia/contrib/tutorials/mirror/mirror.html#TutorialMirror.msg" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.contrib.tutorials.mirror.mirror.TutorialMirror.msg" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-06-23 18:58:26 +02:00
< dd > < p > Simply override .msg to echo back to the messenger or to the current
location.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > text< / strong > (< em > str< / em > < em > or < / em > < em > tuple< / em > < em > , < / em > < em > optional< / em > ) –
is treated internally like any send-command, so its
value can be a tuple if sending multiple arguments to
the < strong > text< / strong > oob command.< / p > < / li >
< li > < p > < strong > from_obj< / strong > (< em > obj< / em > < em > or < / em > < em > iterable< / em > ) –
passed on to the protocol. If iterable, will execute hook
on all entities in it.< / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py exception" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.tutorials.mirror.mirror.TutorialMirror.DoesNotExist" >
< em class = "property" > exception < / em > < code class = "sig-name descname" > DoesNotExist< / code > < a class = "headerlink" href = "#evennia.contrib.tutorials.mirror.mirror.TutorialMirror.DoesNotExist" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-06-23 18:58:26 +02:00
< dd > < p > Bases: < a class = "reference internal" href = "evennia.objects.objects.html#evennia.objects.objects.DefaultObject.DoesNotExist" title = "evennia.objects.objects.DefaultObject.DoesNotExist" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > evennia.objects.objects.DefaultObject.DoesNotExist< / span > < / code > < / a > < / p >
< / dd > < / dl >
< dl class = "py exception" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.tutorials.mirror.mirror.TutorialMirror.MultipleObjectsReturned" >
< em class = "property" > exception < / em > < code class = "sig-name descname" > MultipleObjectsReturned< / code > < a class = "headerlink" href = "#evennia.contrib.tutorials.mirror.mirror.TutorialMirror.MultipleObjectsReturned" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-06-23 18:58:26 +02:00
< dd > < p > Bases: < a class = "reference internal" href = "evennia.objects.objects.html#evennia.objects.objects.DefaultObject.MultipleObjectsReturned" title = "evennia.objects.objects.DefaultObject.MultipleObjectsReturned" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > evennia.objects.objects.DefaultObject.MultipleObjectsReturned< / span > < / code > < / a > < / p >
< / dd > < / dl >
< dl class = "py attribute" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.tutorials.mirror.mirror.TutorialMirror.path" >
< code class = "sig-name descname" > path< / code > < em class = "property" > = 'evennia.contrib.tutorials.mirror.mirror.TutorialMirror'< / em > < a class = "headerlink" href = "#evennia.contrib.tutorials.mirror.mirror.TutorialMirror.path" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-06-23 18:58:26 +02:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.tutorials.mirror.mirror.TutorialMirror.typename" >
< code class = "sig-name descname" > typename< / code > < em class = "property" > = 'TutorialMirror'< / em > < a class = "headerlink" href = "#evennia.contrib.tutorials.mirror.mirror.TutorialMirror.typename" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-06-23 18:58:26 +02:00
< dd > < / dd > < / dl >
< / dd > < / dl >
2021-05-16 00:06:01 +02:00
< / section >
2020-07-14 00:21:00 +02:00
2020-10-15 01:31:30 +02:00
< div class = "clearer" > < / div >
2020-07-14 00:21:00 +02:00
< / div >
< / div >
< / div >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo" / >
< / a > < / p >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../search.html" method = "get" >
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
2022-02-06 18:34:09 +00:00
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "evennia.contrib.tutorials.mirror.html"
title="previous chapter">evennia.contrib.tutorials.mirror< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "evennia.contrib.tutorials.red_button.html"
title="next chapter">evennia.contrib.tutorials.red_button< / a > < / p >
2020-07-14 00:21:00 +02:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
2022-01-08 16:38:41 +01:00
< li > < a href = "../_sources/api/evennia.contrib.tutorials.mirror.mirror.md.txt"
2020-07-14 00:21:00 +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-07-14 00:21:00 +02:00
< h3 > Versions< / h3 >
< ul >
2022-01-08 16:38:41 +01:00
< li > < a href = "evennia.contrib.tutorials.mirror.mirror.html" > 1.0-dev (develop branch)< / a > < / li >
2022-02-05 18:41:59 +00:00
< li > < a href = "../../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
< / 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" >
< a href = "../genindex.html" title = "General Index"
>index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
2022-02-06 18:34:09 +00:00
< li class = "right" >
< a href = "evennia.contrib.tutorials.red_button.html" title = "evennia.contrib.tutorials.red_button"
>next< / a > |< / li >
< li class = "right" >
< a href = "evennia.contrib.tutorials.mirror.html" title = "evennia.contrib.tutorials.mirror"
>previous< / 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 >
2022-02-06 18:34:09 +00:00
< li class = "nav-item nav-item-1" > < a href = "../Evennia-API.html" > API Summary< / a > » < / li >
< li class = "nav-item nav-item-2" > < a href = "evennia-api.html" > evennia< / a > » < / li >
< li class = "nav-item nav-item-3" > < a href = "evennia.html" > evennia< / a > » < / li >
< li class = "nav-item nav-item-4" > < a href = "evennia.contrib.html" > evennia.contrib< / a > » < / li >
< li class = "nav-item nav-item-5" > < a href = "evennia.contrib.tutorials.html" > evennia.contrib.tutorials< / a > » < / li >
< li class = "nav-item nav-item-6" > < a href = "evennia.contrib.tutorials.mirror.html" > evennia.contrib.tutorials.mirror< / a > » < / li >
2022-01-08 16:38:41 +01:00
< li class = "nav-item nav-item-this" > < a href = "" > evennia.contrib.tutorials.mirror.mirror< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-07-14 00:21:00 +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-07-14 00:21:00 +02:00
< / div >
< / body >
< / html >
