2022-11-14 22:43:45 +01:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.17.1: http://docutils.sourceforge.net/" / >
2023-10-19 20:22:27 +00:00
< title > Protocols — Evennia 2.x documentation< / title >
2022-11-14 22:43:45 +01: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" / >
2022-11-26 14:42:25 +00:00
< link rel = "next" title = "New Models" href = "Models.html" / >
2022-11-14 22:43:45 +01:00
< link rel = "prev" title = "Banning" href = "Banning.html" / >
< / head > < body >
2023-10-19 20:22:27 +00:00
2022-11-14 22:43:45 +01:00
< 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 >
< li class = "right" >
2022-11-26 14:42:25 +00:00
< a href = "Models.html" title = "New Models"
2022-11-14 22:43:45 +01:00
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "Banning.html" title = "Banning"
accesskey="P">previous< / a > |< / li >
2023-10-19 20:22:27 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-1" > < a href = "Concepts-Overview.html" accesskey = "U" > Core Concepts< / a > » < / li >
2022-11-27 10:46:09 +00:00
< li class = "nav-item nav-item-this" > < a href = "" > Protocols< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
2023-06-10 08:53:19 +00:00
< / div >
2022-11-14 22:43:45 +01:00
< div class = "document" >
< div class = "documentwrapper" >
< 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 >
< h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul >
2022-11-27 10:46:09 +00:00
< li > < a class = "reference internal" href = "#" > Protocols< / a > < ul >
< li > < a class = "reference internal" href = "#adding-a-new-protocol" > Adding a new Protocol< / a > < ul >
< li > < a class = "reference internal" href = "#writing-your-own-protocol" > Writing your own Protocol< / a > < / li >
2022-11-14 22:43:45 +01:00
< li > < a class = "reference internal" href = "#sending-data-out" > Sending data out< / a > < / li >
< li > < a class = "reference internal" href = "#receiving-data" > Receiving data< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "Banning.html"
title="previous chapter">Banning< / a > < / p >
< h4 > Next topic< / h4 >
2022-11-26 14:42:25 +00:00
< p class = "topless" > < a href = "Models.html"
title="next chapter">New Models< / a > < / p >
2022-11-14 22:43:45 +01:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
2022-11-26 14:42:25 +00:00
< li > < a href = "../_sources/Concepts/Protocols.md.txt"
2022-11-14 22:43:45 +01:00
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / div > < h3 > Links< / h3 >
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "https://www.evennia.com/docs/latest/index.html" > Documentation Top< / a > < / li >
< li > < a href = "https://www.evennia.com" > Evennia Home< / a > < / li >
< li > < a href = "https://github.com/evennia/evennia" > Github< / a > < / li >
2022-11-14 22:43:45 +01:00
< li > < a href = "http://games.evennia.com" > Game Index< / a > < / li >
< li >
< a href = "https://discord.gg/AJJpcRUhtF" > Discord< / a > -
< a href = "https://github.com/evennia/evennia/discussions" > Discussions< / a > -
< a href = "https://evennia.blogspot.com/" > Blog< / a >
< / li >
< / ul >
2023-10-19 20:22:27 +00:00
< h3 > Doc Versions< / h3 >
2022-11-14 22:43:45 +01:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "Protocols.html" > 2.x (main branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "../1.3.0/index.html" > 1.3.0 (v1.3.0 branch)< / a > < / li >
< li > < a href = "../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2022-11-27 10:46:09 +00:00
< section class = "tex2jax_ignore mathjax_ignore" id = "protocols" >
< h1 > Protocols< a class = "headerlink" href = "#protocols" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > Internet│ Protocol
┌─────┐ │ |
┌──────┐ │Text │ │ ┌──────────┐ ┌────────────┐ ┌─────┐
│Client◄────┤JSON ├─┼──┤outputfunc◄────┤commandtuple◄───┤msg()│
└──────┘ │etc │ │ └──────────┘ └────────────┘ └─────┘
└─────┘ │
│Evennia
2022-11-14 22:43:45 +01:00
< / pre > < / div >
< / div >
2022-11-27 10:46:09 +00:00
< p > The < em > Protocol< / em > describes how Evennia sends and receives data over the wire to the client. Each connection-type (telnet, ssh, webclient etc) has its own protocol. Some protocols may also have variations (such plain-text Telnet vs Telnet SSL).< / p >
< p > See the < a class = "reference internal" href = "Messagepath.html" > < span class = "doc std std-doc" > Message Path< / span > < / a > for the bigger picture of how data flows through Evennia.< / p >
< p > In Evennia, the < code class = "docutils literal notranslate" > < span class = "pre" > PortalSession< / span > < / code > represents the client connection. The session is told to use a particular protocol. When sending data out, the session must provide an “Outputfunc” to convert the generic < code class = "docutils literal notranslate" > < span class = "pre" > commandtuple< / span > < / code > to a form the protocol understands. For ingoing data, the server must also provide suitable < a class = "reference internal" href = "../Components/Inputfuncs.html" > < span class = "doc std std-doc" > Inputfuncs< / span > < / a > to handle the instructions sent to the server.< / p >
< section id = "adding-a-new-protocol" >
< h2 > Adding a new Protocol< a class = "headerlink" href = "#adding-a-new-protocol" title = "Permalink to this headline" > ¶< / a > < / h2 >
2022-11-14 22:43:45 +01:00
< p > Evennia has a plugin-system that add the protocol as a new “service” to the application.< / p >
2022-11-27 10:46:09 +00:00
< p > To add a new service of your own (for example your own custom client protocol) to the Portal or Server, expand < code class = "docutils literal notranslate" > < span class = "pre" > mygame/server/conf/server_services_plugins< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > portal_services_plugins< / span > < / code > .< / p >
< p > To expand where Evennia looks for plugins, use the following settings:< / p >
2022-11-14 22:43:45 +01:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # add to the Server< / span >
< span class = "n" > SERVER_SERVICES_PLUGIN_MODULES< / span > < span class = "o" > .< / span > < span class = "n" > append< / span > < span class = "p" > (< / span > < span class = "s1" > ' server.conf.my_server_plugins' < / span > < span class = "p" > )< / span >
< span class = "c1" > # or, if you want to add to the Portal< / span >
< span class = "n" > PORTAL_SERVICES_PLUGIN_MODULES< / span > < span class = "o" > .< / span > < span class = "n" > append< / span > < span class = "p" > (< / span > < span class = "s1" > ' server.conf.my_portal_plugins' < / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
2022-11-27 10:46:09 +00:00
< blockquote >
< div > < p > When adding a new client connection you’ < / p >
< / div > < / blockquote >
< p > The plugin module must contain a function < code class = "docutils literal notranslate" > < span class = "pre" > start_plugin_services(app)< / span > < / code > , where the < code class = "docutils literal notranslate" > < span class = "pre" > app< / span > < / code > arguments refers to the Portal/Server application itself. This is called by the Server or Portal when it starts up. It must contatin all startup code needed.< / p >
< p > Example:< / p >
2022-11-14 22:43:45 +01:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # mygame/server/conf/portal_services_plugins.py< / span >
< span class = "c1" > # here the new Portal Twisted protocol is defined< / span >
< span class = "k" > class< / span > < span class = "nc" > MyOwnFactory< / span > < span class = "p" > (< / span > < span class = "o" > ...< / span > < span class = "p" > ):< / span >
2022-11-27 10:46:09 +00:00
< span class = "c1" > # [...]< / span >
2022-11-14 22:43:45 +01:00
< span class = "c1" > # some configs< / span >
< span class = "n" > MYPROC_ENABLED< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "c1" > # convenient off-flag to avoid having to edit settings all the time< / span >
< span class = "n" > MY_PORT< / span > < span class = "o" > =< / span > < span class = "mi" > 6666< / span >
< span class = "k" > def< / span > < span class = "nf" > start_plugin_services< / span > < span class = "p" > (< / span > < span class = "n" > portal< / span > < span class = "p" > ):< / span >
< span class = "s2" > " This is called by the Portal during startup" < / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > MYPROC_ENABLED< / span > < span class = "p" > :< / span >
< span class = "k" > return< / span >
< span class = "c1" > # output to list this with the other services at startup< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "sa" > f< / span > < span class = "s2" > " myproc: < / span > < span class = "si" > {< / span > < span class = "n" > MY_PORT< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span > < span class = "p" > )< / span >
< span class = "c1" > # some setup (simple example)< / span >
< span class = "n" > factory< / span > < span class = "o" > =< / span > < span class = "n" > MyOwnFactory< / span > < span class = "p" > ()< / span >
< span class = "n" > my_service< / span > < span class = "o" > =< / span > < span class = "n" > internet< / span > < span class = "o" > .< / span > < span class = "n" > TCPServer< / span > < span class = "p" > (< / span > < span class = "n" > MY_PORT< / span > < span class = "p" > ,< / span > < span class = "n" > factory< / span > < span class = "p" > )< / span >
< span class = "c1" > # all Evennia services must be uniquely named< / span >
< span class = "n" > my_service< / span > < span class = "o" > .< / span > < span class = "n" > setName< / span > < span class = "p" > (< / span > < span class = "s2" > " MyService" < / span > < span class = "p" > )< / span >
< span class = "c1" > # add to the main portal application< / span >
< span class = "n" > portal< / span > < span class = "o" > .< / span > < span class = "n" > services< / span > < span class = "o" > .< / span > < span class = "n" > addService< / span > < span class = "p" > (< / span > < span class = "n" > my_service< / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
< p > Once the module is defined and targeted in settings, just reload the server and your new
protocol/services should start with the others.< / p >
< section id = "writing-your-own-protocol" >
2022-11-27 10:46:09 +00:00
< h3 > Writing your own Protocol< a class = "headerlink" href = "#writing-your-own-protocol" title = "Permalink to this headline" > ¶< / a > < / h3 >
< div class = "admonition important" >
< p class = "admonition-title" > Important< / p >
< p > This is considered an advanced topic.< / p >
< / div >
< p > Writing a stable communication protocol from scratch is not something we’ ’ < / p >
< p > Writing a protocol implementation in Twisted usually involves creating a class inheriting from an already existing Twisted protocol class and from < code class = "docutils literal notranslate" > < span class = "pre" > evennia.server.session.Session< / span > < / code > (multiple
2022-11-14 22:43:45 +01:00
inheritance), then overloading the methods that particular protocol uses to link them to the
Evennia-specific inputs.< / p >
< p > Here’ < / p >
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # In module that we' ll later add to the system through PORTAL_SERVICE_PLUGIN_MODULES< / span >
< span class = "c1" > # pseudo code < / span >
< span class = "kn" > from< / span > < span class = "nn" > twisted.something< / span > < span class = "kn" > import< / span > < span class = "n" > TwistedClient< / span >
< span class = "c1" > # this class is used both for Portal- and Server Sessions< / span >
< span class = "kn" > from< / span > < span class = "nn" > evennia.server.session< / span > < span class = "kn" > import< / span > < span class = "n" > Session< / span >
< span class = "kn" > from< / span > < span class = "nn" > evennia.server.portal.portalsessionhandler< / span > < span class = "kn" > import< / span > < span class = "n" > PORTAL_SESSIONS< / span >
< span class = "k" > class< / span > < span class = "nc" > MyCustomClient< / span > < span class = "p" > (< / span > < span class = "n" > TwistedClient< / span > < span class = "p" > ,< / span > < span class = "n" > Session< / span > < span class = "p" > ):< / span >
< span class = "k" > def< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "o" > =< / span > < span class = "n" > PORTAL_SESSIONS< / span >
< span class = "c1" > # these are methods we must know that TwistedClient uses for < / span >
< span class = "c1" > # communication. Name and arguments could vary for different Twisted protocols< / span >
< span class = "k" > def< / span > < span class = "nf" > onOpen< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "c1" > # let' s say this is called when the client first connects< / span >
< span class = "c1" > # we need to init the session and connect to the sessionhandler. The .factory< / span >
< span class = "c1" > # is available through the Twisted parents< / span >
< span class = "n" > client_address< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > getClientAddress< / span > < span class = "p" > ()< / span > < span class = "c1" > # get client address somehow< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > init_session< / span > < span class = "p" > (< / span > < span class = "s2" > " mycustom_protocol" < / span > < span class = "p" > ,< / span > < span class = "n" > client_address< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > factory< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "o" > .< / span > < span class = "n" > connect< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > onClose< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > reason< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "c1" > # called when the client connection is dropped< / span >
< span class = "c1" > # link to the Evennia equivalent< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > disconnect< / span > < span class = "p" > (< / span > < span class = "n" > reason< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > onMessage< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > indata< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "c1" > # called with incoming data< / span >
< span class = "c1" > # convert as needed here < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > data_in< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "n" > indata< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > sendMessage< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > outdata< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "c1" > # called to send data out< / span >
< span class = "c1" > # modify if needed < / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > sendMessage< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > outdata< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span >
< span class = "c1" > # these are Evennia methods. They must all exist and look exactly like this< / span >
< span class = "c1" > # The above twisted-methods call them and vice-versa. This connects the protocol< / span >
< span class = "c1" > # the Evennia internals. < / span >
< span class = "k" > def< / span > < span class = "nf" > disconnect< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > reason< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Called when connection closes. < / span >
< span class = "sd" > This can also be called directly by Evennia when manually closing the connection.< / span >
< span class = "sd" > Do any cleanups here.< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "o" > .< / span > < span class = "n" > disconnect< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > at_login< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Called when this session authenticates by the server (if applicable)< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > def< / span > < span class = "nf" > data_in< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Data going into the server should go through this method. It < / span >
< span class = "sd" > should pass data into `sessionhandler.data_in`. THis will be called< / span >
< span class = "sd" > by the sessionhandler with the data it gets from the approrpriate < / span >
< span class = "sd" > send_* method found later in this protocol. < / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "o" > .< / span > < span class = "n" > data_in< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > text< / span > < span class = "o" > =< / span > < span class = "n" > kwargs< / span > < span class = "p" > [< / span > < span class = "s1" > ' data' < / span > < span class = "p" > ])< / span >
< span class = "k" > def< / span > < span class = "nf" > data_out< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Data going out from the server should go through this method. It should< / span >
< span class = "sd" > hand off to the protocol' s send method, whatever it' s called.< / span >
< span class = "sd" > " " " < / span >
< span class = "c1" > # we assume we have a ' text' outputfunc< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > onMessage< / span > < span class = "p" > (< / span > < span class = "n" > kwargs< / span > < span class = "p" > [< / span > < span class = "s1" > ' text' < / span > < span class = "p" > ])< / span >
< span class = "c1" > # ' outputfuncs' are defined as `send_< outputfunc_name> `. From in-code, they are called < / span >
< span class = "c1" > # with `msg(outfunc_name=< data> )`. < / span >
< span class = "k" > def< / span > < span class = "nf" > send_text< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > txt< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Send text, used with e.g. `session.msg(text=" foo" )`< / span >
< span class = "sd" > " " " < / span >
< span class = "c1" > # we make use of the < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > data_out< / span > < span class = "p" > (< / span > < span class = "n" > text< / span > < span class = "o" > =< / span > < span class = "n" > txt< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > send_default< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > cmdname< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Handles all outputfuncs without an explicit `send_*` method to handle them.< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > data_out< / span > < span class = "p" > (< / span > < span class = "o" > **< / span > < span class = "p" > {< / span > < span class = "n" > cmdname< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > )})< / span >
< / pre > < / div >
< / div >
< p > The principle here is that the Twisted-specific methods are overridden to redirect inputs/outputs to
the Evennia-specific methods.< / p >
2022-11-27 10:46:09 +00:00
< / section >
2022-11-14 22:43:45 +01:00
< section id = "sending-data-out" >
< h3 > Sending data out< a class = "headerlink" href = "#sending-data-out" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > To send data out through this protocol, you’ < / p >
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > session< / span > < span class = "o" > .< / span > < span class = "n" > msg< / span > < span class = "p" > (< / span > < span class = "n" > text< / span > < span class = "o" > =< / span > < span class = "s2" > " foo" < / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
2022-11-27 10:46:09 +00:00
< p > The message will pass through the system such that the sessionhandler will dig out the session and check if it has a < code class = "docutils literal notranslate" > < span class = "pre" > send_text< / span > < / code > method (it has). It will then pass the “foo” into that method, which
2022-11-14 22:43:45 +01:00
in our case means sending “foo” across the network.< / p >
< / section >
< section id = "receiving-data" >
< h3 > Receiving data< a class = "headerlink" href = "#receiving-data" title = "Permalink to this headline" > ¶< / a > < / h3 >
2022-11-27 10:46:09 +00:00
< p > Just because the protocol is there, does not mean Evennia knows what to do with it. An < a class = "reference internal" href = "../Components/Inputfuncs.html" > < span class = "doc std std-doc" > Inputfunc< / span > < / a > must exist to receive it. In the case of the < code class = "docutils literal notranslate" > < span class = "pre" > text< / span > < / code > input exemplified above, Evennia alredy handles this input - it will parse it as a Command name followed by its inputs. So handle that you need to simply add a cmdset with commands on your receiving Session (and/or the Object/Character it is puppeting). If not you may need to add your own Inputfunc (see the < a class = "reference internal" href = "../Components/Inputfuncs.html" > < span class = "doc std std-doc" > Inputfunc< / span > < / a > page for how to do this.< / p >
< p > These might not be as clear-cut in all protocols, but the principle is there. These four basic components - however they are accessed - links to the < em > Portal Session< / em > , which is the actual common interface between the different low-level protocols and Evennia.< / p >
2022-11-14 22:43:45 +01:00
< / section >
< / section >
< / section >
< / div >
< / div >
< / 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 >
< li class = "right" >
2022-11-26 14:42:25 +00:00
< a href = "Models.html" title = "New Models"
2022-11-14 22:43:45 +01:00
>next< / a > |< / li >
< li class = "right" >
< a href = "Banning.html" title = "Banning"
>previous< / a > |< / li >
2023-10-19 20:22:27 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-1" > < a href = "Concepts-Overview.html" > Core Concepts< / a > » < / li >
2022-11-27 10:46:09 +00:00
< li class = "nav-item nav-item-this" > < a href = "" > Protocols< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
2023-10-19 20:22:27 +00:00
2022-11-14 22:43:45 +01:00
< div class = "footer" role = "contentinfo" >
2023-10-19 20:22:27 +00:00
© Copyright 2023, The Evennia developer community.
2022-11-14 22:43:45 +01:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
< / div >
< / body >
< / html >
