2021-05-15 00:35:21 +02:00
<!DOCTYPE html>
< html >
< 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/" / >
2021-05-15 00:35:21 +02:00
< title > Msg — Evennia 1.0-dev documentation< / title >
< 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 >
2021-10-26 21:41:11 +02:00
< script async = "async" src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML" > < / script >
< script type = "text/x-mathjax-config" > MathJax . Hub . Config ( { "tex2jax" : { "processClass" : "tex2jax_process|mathjax_process|math|output_area" } } ) < / script >
2021-05-15 00:35:21 +02:00
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< / 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 >
< 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 = "" > Msg< / a > < / li >
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2021-05-15 00:35:21 +02:00
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2021-10-26 21:41:11 +02:00
< section class = "tex2jax_ignore mathjax_ignore" id = "msg" >
2021-05-15 00:35:21 +02:00
< h1 > Msg< a class = "headerlink" href = "#msg" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-10-26 21:41:11 +02:00
< p > The < a class = "reference internal" href = "../api/evennia.comms.models.html#evennia.comms.models.Msg" title = "evennia.comms.models.Msg" > < span class = "xref myst py py-class" > Msg< / span > < / a > object represents a database-saved
2021-05-15 00:35:21 +02:00
piece of communication. Think of it as a discrete piece of email - it contains
a message, some metadata and will always have a sender and one or more
recipients.< / p >
< p > Once created, a Msg is normally not changed. It is persitently saved in the
database. This allows for comprehensive logging of communications. Here are some
good uses for < code class = "docutils literal notranslate" > < span class = "pre" > Msg< / span > < / code > objects:< / p >
< ul class = "simple" >
< li > < p > page/tells (the < code class = "docutils literal notranslate" > < span class = "pre" > page< / span > < / code > command is how Evennia uses them out of the box)< / p > < / li >
< li > < p > messages in a bulletin board< / p > < / li >
< li > < p > game-wide email stored in ‘ ’ < / p > < / li >
< / ul >
< div class = "admonition important" >
< p class = "admonition-title" > Important< / p >
2021-10-26 21:41:11 +02:00
< p > A < code class = "docutils literal notranslate" > < span class = "pre" > Msg< / span > < / code > does not have any in-game representation. So if you want to use them
2021-05-15 00:35:21 +02:00
to represent in-game mail/letters, the physical letters would never be
visible in a room (possible to steal, spy on etc) unless you make your
spy-system access the Msgs directly (or go to the trouble of spawning an
actual in-game letter-object based on the Msg)< / p >
< / div >
< div class = "versionchanged" >
2021-10-26 21:41:11 +02:00
< p > < span class = "versionmodified changed" > Changed in version 1.0: < / span > Channels dropped Msg-support. Now only used in < code class = "docutils literal notranslate" > < span class = "pre" > page< / span > < / code > command by default.< / p >
2021-05-15 00:35:21 +02:00
< / div >
2021-05-16 00:06:01 +02:00
< section id = "msg-in-code" >
2021-05-15 00:35:21 +02:00
< h2 > Msg in code< a class = "headerlink" href = "#msg-in-code" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The Msg is intended to be used exclusively in code, to build other game systems. It is < em > not< / em >
2021-10-26 21:41:11 +02:00
a < a class = "reference internal" href = "Typeclasses.html" > < span class = "doc std std-doc" > Typeclassed< / span > < / a > entity, which means it cannot (easily) be overridden. It
doesn’ < em > does< / em > support < a class = "reference internal" href = "Tags.html" > < span class = "doc std std-doc" > Tags< / span > < / a > ). It tries to be lean
2021-05-15 00:35:21 +02:00
and small since a new one is created for every message.< / p >
< p > You create a new message with < code class = "docutils literal notranslate" > < span class = "pre" > evennia.create_message< / span > < / code > :< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > from< / span > < span class = "nn" > evennia< / span > < span class = "kn" > import< / span > < span class = "n" > create_message< / span >
2021-05-16 00:06:01 +02:00
< span class = "n" > message< / span > < span class = "o" > =< / span > < span class = "n" > create_message< / span > < span class = "p" > (< / span > < span class = "n" > senders< / span > < span class = "p" > ,< / span > < span class = "n" > message< / span > < span class = "p" > ,< / span > < span class = "n" > receivers< / span > < span class = "p" > ,< / span >
2021-05-15 00:35:21 +02:00
< span class = "n" > locks< / span > < span class = "o" > =...< / span > < span class = "p" > ,< / span > < span class = "n" > tags< / span > < span class = "o" > =...< / span > < span class = "p" > ,< / span > < span class = "n" > header< / span > < span class = "o" > =...< / span > < span class = "p" > )< / span >
< / pre > < / div >
2021-10-26 21:41:11 +02:00
< / div >
2021-05-15 00:35:21 +02:00
< p > You can search for < code class = "docutils literal notranslate" > < span class = "pre" > Msg< / span > < / code > objects in various ways:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > from< / span > < span class = "nn" > evennia< / span > < span class = "kn" > import< / span > < span class = "n" > search_message< / span > < span class = "p" > ,< / span > < span class = "n" > Msg< / span >
2021-05-15 00:35:21 +02:00
< span class = "c1" > # args are optional. Only a single sender/receiver should be passed< / span >
< span class = "n" > messages< / span > < span class = "o" > =< / span > < span class = "n" > search_message< / span > < span class = "p" > (< / span > < span class = "n" > sender< / span > < span class = "o" > =...< / span > < span class = "p" > ,< / span > < span class = "n" > receiver< / span > < span class = "o" > =...< / span > < span class = "p" > ,< / span > < span class = "n" > freetext< / span > < span class = "o" > =...< / span > < span class = "p" > ,< / span > < span class = "n" > dbref< / span > < span class = "o" > =...< / span > < span class = "p" > )< / span >
< span class = "c1" > # get all messages for a given sender/receiver< / span >
< span class = "n" > messages< / span > < span class = "o" > =< / span > < span class = "n" > Msg< / span > < span class = "o" > .< / span > < span class = "n" > objects< / span > < span class = "o" > .< / span > < span class = "n" > get_msg_by_sender< / span > < span class = "p" > (< / span > < span class = "n" > sender< / span > < span class = "p" > )< / span >
< span class = "n" > messages< / span > < span class = "o" > =< / span > < span class = "n" > Msg< / span > < span class = "o" > .< / span > < span class = "n" > objects< / span > < span class = "o" > .< / span > < span class = "n" > get_msg_by_receiver< / span > < span class = "p" > (< / span > < span class = "n" > recipient< / span > < span class = "p" > )< / span >
2021-10-26 21:41:11 +02:00
2021-05-15 00:35:21 +02:00
< / pre > < / div >
2021-10-26 21:41:11 +02:00
< / div >
2021-05-16 00:06:01 +02:00
< section id = "properties-on-msg" >
2021-05-15 00:35:21 +02:00
< h3 > Properties on Msg< a class = "headerlink" href = "#properties-on-msg" title = "Permalink to this headline" > ¶< / a > < / h3 >
< ul class = "simple" >
2021-05-16 00:06:01 +02:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > senders< / span > < / code > - there must always be at least one sender. This is a set of< / p > < / li >
2021-10-26 21:41:11 +02:00
< li > < p > < a class = "reference internal" href = "Accounts.html" > < span class = "doc std std-doc" > Account< / span > < / a > , < a class = "reference internal" href = "Objects.html" > < span class = "doc std std-doc" > Object< / span > < / a > , < a class = "reference internal" href = "Scripts.html" > < span class = "doc std std-doc" > Script< / span > < / a >
2021-05-16 00:06:01 +02:00
or < code class = "docutils literal notranslate" > < span class = "pre" > str< / span > < / code > in any combination (but usually a message only targets one type).
Using a < code class = "docutils literal notranslate" > < span class = "pre" > str< / span > < / code > for a sender indicates it’ ‘ ’
and can be used to point to a sender that is not a typeclassed entity. This is not used by default
and what this would be depends on the system (it could be a unique id or a
python-path, for example). While most systems expect a single sender, it’
possible to have any number of them.< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > receivers< / span > < / code > - these are the ones to see the Msg. These are again any combination of
2021-10-26 21:41:11 +02:00
< a class = "reference internal" href = "Accounts.html" > < span class = "doc std std-doc" > Account< / span > < / a > , < a class = "reference internal" href = "Objects.html" > < span class = "doc std std-doc" > Object< / span > < / a > or < a class = "reference internal" href = "Scripts.html" > < span class = "doc std std-doc" > Script< / span > < / a > or < code class = "docutils literal notranslate" > < span class = "pre" > str< / span > < / code > (an ‘ ’
2021-05-16 00:06:01 +02:00
It’ < / p > < / li >
2021-05-15 00:35:21 +02:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > header< / span > < / code > - this is an optional text field that can contain meta-information about the message. For
an email-like system it would be the subject line. This can be independently searched, making
this a powerful place for quickly finding messages.< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > message< / span > < / code > - the actual text being sent.< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > date_sent< / span > < / code > - this is auto-set to the time the Msg was created (and thus presumably sent).< / p > < / li >
2021-10-26 21:41:11 +02:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > locks< / span > < / code > - the Evennia < a class = "reference internal" href = "Locks.html" > < span class = "doc std std-doc" > lock handler< / span > < / a > . Use with < code class = "docutils literal notranslate" > < span class = "pre" > locks.add()< / span > < / code > etc and check locks with < code class = "docutils literal notranslate" > < span class = "pre" > msg.access()< / span > < / code >
2021-05-15 00:35:21 +02:00
like for all other lockable entities. This can be used to limit access to the contents
of the Msg. The default lock-type to check is < code class = "docutils literal notranslate" > < span class = "pre" > 'read'< / span > < / code > .< / p > < / li >
2021-10-26 21:41:11 +02:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > hide_from< / span > < / code > - this is an optional list of < a class = "reference internal" href = "Accounts.html" > < span class = "doc std std-doc" > Accounts< / span > < / a > or < a class = "reference internal" href = "Objects.html" > < span class = "doc std std-doc" > Objects< / span > < / a > that
2021-05-15 00:35:21 +02:00
will not see this Msg. This relationship is available mainly for optimization
reasons since it allows quick filtering of messages not intended for a given
target.< / p > < / li >
< / ul >
2021-05-16 00:06:01 +02:00
< / section >
< / section >
< section id = "tempmsg" >
2021-05-15 00:35:21 +02:00
< h2 > TempMsg< a class = "headerlink" href = "#tempmsg" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-10-26 21:41:11 +02:00
< p > < a class = "reference internal" href = "../api/evennia.comms.models.html#evennia.comms.models.TempMsg" title = "evennia.comms.models.TempMsg" > < span class = "xref myst py py-class" > evennia.comms.models.TempMsg< / span > < / a > is an object
2021-05-15 00:35:21 +02:00
that implements the same API as the regular < code class = "docutils literal notranslate" > < span class = "pre" > Msg< / span > < / code > , but which has no database
component (and thus cannot be searched). It’
expecting a < code class = "docutils literal notranslate" > < span class = "pre" > Msg< / span > < / code > but where you just want to process the message without saving
it.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< / section >
2021-05-15 00:35:21 +02:00
< div class = "clearer" > < / div >
< / 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 >
< p > < h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul >
< li > < a class = "reference internal" href = "#" > Msg< / a > < ul >
< li > < a class = "reference internal" href = "#msg-in-code" > Msg in code< / a > < ul >
< li > < a class = "reference internal" href = "#properties-on-msg" > Properties on Msg< / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#tempmsg" > TempMsg< / a > < / li >
< / ul >
< / li >
< / ul >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Components/Msg.md.txt"
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / 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-05-15 00:35:21 +02:00
< / li >
< / ul >
< h3 > Versions< / h3 >
< ul >
< li > < a href = "Msg.html" > 1.0-dev (develop branch)< / a > < / li >
< / 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 >
< 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 = "" > Msg< / a > < / li >
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2021-05-15 00:35:21 +02:00
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2020, The Evennia developer community.
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
< / div >
< / body >
< / html >
