Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-18 05:46:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/2.x/Evennia-API.html
Evennia docbuilder action e535f5782a Updated HTML docs.
2023-10-19 20:22:27 +00:00

278 lines
No EOL
24 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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/" />
<title>API Summary &#8212; Evennia 2.x 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>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="evennia" href="api/evennia-api.html" />
<link rel="prev" title="Links" href="Links.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="right" >
<a href="api/evennia-api.html" title="evennia"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Links.html" title="Links"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 2.x</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Summary</a></li>
</ul>
</div>
<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>
<li><a class="reference internal" href="#">API Summary</a><ul>
<li><a class="reference internal" href="#shortcuts">Shortcuts</a><ul>
<li><a class="reference internal" href="#main-config">Main config</a></li>
<li><a class="reference internal" href="#search-functions">Search functions</a></li>
<li><a class="reference internal" href="#create-functions">Create functions</a></li>
<li><a class="reference internal" href="#typeclasses">Typeclasses</a></li>
<li><a class="reference internal" href="#commands">Commands</a></li>
<li><a class="reference internal" href="#utilities">Utilities</a></li>
<li><a class="reference internal" href="#global-singleton-handlers">Global singleton handlers</a></li>
<li><a class="reference internal" href="#database-core-models-for-more-advanced-lookups">Database core models (for more advanced lookups)</a></li>
<li><a class="reference internal" href="#contributions">Contributions</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="Links.html"
title="previous chapter">Links</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="api/evennia-api.html"
title="next chapter">evennia</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="_sources/Evennia-API.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<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>
<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>
<h3>Doc Versions</h3>
<ul>
<li><a href="Evennia-API.html">2.x (main branch)</a></li>
<ul>
<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>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section class="tex2jax_ignore mathjax_ignore" id="api-summary">
<h1>API Summary<a class="headerlink" href="#api-summary" title="Permalink to this headline"></a></h1>
<p><a class="reference internal" href="api/evennia-api.html"><span class="doc std std-doc">evennia</span></a> - library source tree</p>
<ul class="simple">
<li><p><a class="reference internal" href="api/evennia.accounts.html#evennia-accounts"><span class="std std-ref">evennia.accounts</span></a> - the out-of-character entities representing players</p></li>
<li><p><a class="reference internal" href="api/evennia.commands.html#evennia-commands"><span class="std std-ref">evennia.commands</span></a> - handle all inputs. Also includes default commands</p></li>
<li><p><a class="reference internal" href="api/evennia.comms.html#evennia-comms"><span class="std std-ref">evennia.comms</span></a> - in-game channels and messaging</p></li>
<li><p><a class="reference internal" href="api/evennia.contrib.html#evennia-contrib"><span class="std std-ref">evennia.contrib</span></a> - game-specific tools and code contributed by the community</p></li>
<li><p><a class="reference internal" href="api/evennia.help.html#evennia-help"><span class="std std-ref">evennia.help</span></a> - in-game help system</p></li>
<li><p><a class="reference internal" href="api/evennia.locks.html#evennia-locks"><span class="std std-ref">evennia.locks</span></a> - limiting access to various systems and resources</p></li>
<li><p><a class="reference internal" href="api/evennia.objects.html#evennia-objects"><span class="std std-ref">evennia.objects</span></a> - all in-game entities, like Rooms, Characters, Exits etc</p></li>
<li><p><a class="reference internal" href="api/evennia.prototypes.html#evennia-prototypes"><span class="std std-ref">evennia.prototypes</span></a> - customize entities using dicts</p></li>
<li><p><a class="reference internal" href="api/evennia.scripts.html#evennia-scripts"><span class="std std-ref">evennia.scripts</span></a> - all out-of-character game objects</p></li>
<li><p><a class="reference internal" href="api/evennia.server.html#evennia-server"><span class="std std-ref">evennia.server</span></a> - core Server and Portal programs, also network protocols</p></li>
<li><p><a class="reference internal" href="api/evennia.typeclasses.html#evennia-typeclasses"><span class="std std-ref">evennia.typeclasses</span></a> - core database-python bridge</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.html#evennia-utils"><span class="std std-ref">evennia.utils</span></a> - lots of useful coding tools and utilities</p></li>
<li><p><a class="reference internal" href="api/evennia.web.html#evennia-web"><span class="std std-ref">evennia.web</span></a> - webclient, website and other web resources</p></li>
</ul>
<section id="shortcuts">
<h2>Shortcuts<a class="headerlink" href="#shortcuts" title="Permalink to this headline"></a></h2>
<p>Evennia’s ‘flat API’ has shortcuts to common tools, available by only importing <code class="docutils literal notranslate"><span class="pre">evennia</span></code>.
The flat API is defined in <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code> <a class="reference external" href="https://github.com/evennia/evennia/blob/main/evennia/__init__.py">viewable here</a></p>
<section id="main-config">
<h3>Main config<a class="headerlink" href="#main-config" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="Setup/Settings-Default.html"><span class="doc std std-doc">evennia.settings_default</span></a> - all settings (modify/override in <code class="docutils literal notranslate"><span class="pre">mygame/server/settings.py</span></code>)</p></li>
</ul>
</section>
<section id="search-functions">
<h3>Search functions<a class="headerlink" href="#search-functions" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="api/evennia.utils.search.html#evennia.utils.search.search_account" title="evennia.utils.search.search_account"><span class="xref myst py py-func">evennia.search_account</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.search.html#evennia.utils.search.search_object" title="evennia.utils.search.search_object"><span class="xref myst py py-func">evennia.search_object</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.search.html#evennia.utils.search.search_tag" title="evennia.utils.search.search_tag"><span class="xref myst py py-func">evennia.search_tag</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.search.html#evennia.utils.search.search_script" title="evennia.utils.search.search_script"><span class="xref myst py py-func">evennia.search_script</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.search.html#evennia.utils.search.search_channel" title="evennia.utils.search.search_channel"><span class="xref myst py py-func">evennia.search_channel</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.search.html#evennia.utils.search.search_message" title="evennia.utils.search.search_message"><span class="xref myst py py-func">evennia.search_message</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.search.html#evennia.utils.search.search_help_entry" title="evennia.utils.search.search_help_entry"><span class="xref myst py py-func">evennia.search_help</span></a></p></li>
</ul>
</section>
<section id="create-functions">
<h3>Create functions<a class="headerlink" href="#create-functions" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="api/evennia.utils.create.html#evennia.utils.create.create_account" title="evennia.utils.create.create_account"><span class="xref myst py py-func">evennia.create_account</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.create.html#evennia.utils.create.create_object" title="evennia.utils.create.create_object"><span class="xref myst py py-func">evennia.create_object</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.create.html#evennia.utils.create.create_script" title="evennia.utils.create.create_script"><span class="xref myst py py-func">evennia.create_script</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.create.html#evennia.utils.create.create_channel" title="evennia.utils.create.create_channel"><span class="xref myst py py-func">evennia.create_channel</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.create.html#evennia.utils.create.create_help_entry" title="evennia.utils.create.create_help_entry"><span class="xref myst py py-func">evennia.create_help_entry</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.utils.create.html#evennia.utils.create.create_message" title="evennia.utils.create.create_message"><span class="xref myst py py-func">evennia.create_message</span></a></p></li>
</ul>
</section>
<section id="typeclasses">
<h3>Typeclasses<a class="headerlink" href="#typeclasses" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="api/evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount" title="evennia.accounts.accounts.DefaultAccount"><span class="xref myst py py-class">evennia.DefaultAccount</span></a> - player account class (<a class="reference internal" href="Components/Accounts.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultGuest" title="evennia.accounts.accounts.DefaultGuest"><span class="xref myst py py-class">evennia.DefaultGuest</span></a> - base guest account class</p></li>
<li><p><a class="reference internal" href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><span class="xref myst py py-class">evennia.DefaultObject</span></a> - base class for all objects (<a class="reference internal" href="Components/Objects.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><span class="xref myst py py-class">evennia.DefaultCharacter</span></a> - base class for in-game characters (<a class="reference internal" href="Components/Characters.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultRoom" title="evennia.objects.objects.DefaultRoom"><span class="xref myst py py-class">evennia.DefaultRoom</span></a> - base class for rooms (<a class="reference internal" href="Components/Rooms.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultExit" title="evennia.objects.objects.DefaultExit"><span class="xref myst py py-class">evennia.DefaultExit</span></a> - base class for exits (<a class="reference internal" href="Components/Exits.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><span class="xref myst py py-class">evennia.DefaultScript</span></a> - base class for OOC-objects (<a class="reference internal" href="Components/Scripts.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.comms.comms.html#evennia.comms.comms.DefaultChannel" title="evennia.comms.comms.DefaultChannel"><span class="xref myst py py-class">evennia.DefaultChannel</span></a> - base class for in-game channels (<a class="reference internal" href="Components/Channels.html"><span class="doc std std-doc">docs</span></a>)</p></li>
</ul>
</section>
<section id="commands">
<h3>Commands<a class="headerlink" href="#commands" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="api/evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><span class="xref myst py py-class">evennia.Command</span></a> - base <a class="reference internal" href="Components/Commands.html"><span class="doc std std-doc">Command</span></a> class. See also <code class="docutils literal notranslate"><span class="pre">evennia.default_cmds.MuxCommand</span></code></p></li>
<li><p><a class="reference internal" href="api/evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><span class="xref myst py py-class">evennia.CmdSet</span></a> - base <a class="reference internal" href="Components/Command-Sets.html"><span class="doc std std-doc">CmdSet</span></a> class</p></li>
<li><p><a class="reference internal" href="Components/Default-Commands.html"><span class="doc std std-doc">evennia.default_cmds</span></a> - access all default command classes as properties</p></li>
<li><p><a class="reference internal" href="Components/Commands.html#system-commands"><span class="std std-doc">evennia.syscmdkeys</span></a> - access system command keys as properties</p></li>
</ul>
</section>
<section id="utilities">
<h3>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="api/evennia.utils.utils.html#evennia-utils-utils"><span class="std std-ref">evennia.utils.utils</span></a> - mixed useful utilities</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.gametime.html#evennia.utils.gametime.TimeScript" title="evennia.utils.gametime.TimeScript"><span class="xref myst py py-class">evennia.gametime</span></a> - server run- and game time (<a class="reference internal" href="Components/Coding-Utils.html#game-time"><span class="std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.logger.html#evennia-utils-logger"><span class="std std-ref">evennia.logger</span></a> - logging tools</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.ansi.html#evennia-utils-ansi"><span class="std std-ref">evennia.ansi</span></a> - ansi coloring tools</p></li>
<li><p><a class="reference internal" href="api/evennia.prototypes.spawner.html#evennia.prototypes.spawner.spawn" title="evennia.prototypes.spawner.spawn"><span class="xref myst py py-func">evennia.spawn</span></a> - spawn/prototype system (<a class="reference internal" href="Components/Prototypes.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.locks.lockfuncs.html#evennia-locks-lockfuncs"><span class="std std-ref">evennia.lockfuncs</span></a> - default lock functions for access control (<a class="reference internal" href="Components/Locks.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.evmenu.html#evennia.utils.evmenu.EvMenu" title="evennia.utils.evmenu.EvMenu"><span class="xref myst py py-class">evennia.EvMenu</span></a> - menu system (<a class="reference internal" href="Components/EvMenu.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.evtable.html#evennia.utils.evtable.EvTable" title="evennia.utils.evtable.EvTable"><span class="xref myst py py-class">evennia.EvTable</span></a> - text table creater</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.evform.html#evennia.utils.evform.EvForm" title="evennia.utils.evform.EvForm"><span class="xref myst py py-class">evennia.EvForm</span></a> - text form creator</p></li>
<li><p>Evennia.EvMore - text paginator</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.eveditor.html#evennia.utils.eveditor.EvEditor" title="evennia.utils.eveditor.EvEditor"><span class="xref myst py py-class">evennia.EvEditor</span></a> - in game text line editor (<a class="reference internal" href="Components/EvEditor.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.utils.funcparser.html#evennia.utils.funcparser.FuncParser" title="evennia.utils.funcparser.FuncParser"><span class="xref myst py py-class">evennia.utils.funcparser.Funcparser</span></a> - inline parsing of functions (<a class="reference internal" href="Components/FuncParser.html"><span class="doc std std-doc">docs</span></a>)</p></li>
</ul>
</section>
<section id="global-singleton-handlers">
<h3>Global singleton handlers<a class="headerlink" href="#global-singleton-handlers" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="api/evennia.scripts.tickerhandler.html#evennia.scripts.tickerhandler.TickerHandler" title="evennia.scripts.tickerhandler.TickerHandler"><span class="xref myst py py-class">evennia.TICKER_HANDLER</span></a> - allow objects subscribe to tickers (<a class="reference internal" href="Components/TickerHandler.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.scripts.monitorhandler.html#evennia.scripts.monitorhandler.MonitorHandler" title="evennia.scripts.monitorhandler.MonitorHandler"><span class="xref myst py py-class">evennia.MONITOR_HANDLER</span></a> - monitor changes (<a class="reference internal" href="Components/MonitorHandler.html"><span class="doc std std-doc">docs</span></a>)</p></li>
<li><p><a class="reference internal" href="api/evennia.server.sessionhandler.html#evennia.server.sessionhandler.SessionHandler" title="evennia.server.sessionhandler.SessionHandler"><span class="xref myst py py-class">evennia.SESSION_HANDLER</span></a> - manages all sessionsmain session handler</p></li>
</ul>
</section>
<section id="database-core-models-for-more-advanced-lookups">
<h3>Database core models (for more advanced lookups)<a class="headerlink" href="#database-core-models-for-more-advanced-lookups" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="api/evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><span class="xref myst py py-class">evennia.ObjectDB</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><span class="xref myst py py-class">evennia.accountDB</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.scripts.models.html#evennia.scripts.models.ScriptDB" title="evennia.scripts.models.ScriptDB"><span class="xref myst py py-class">evennia.ScriptDB</span></a></p></li>
<li><p><a class="reference internal" href="api/evennia.comms.models.html#evennia.comms.models.ChannelDB" title="evennia.comms.models.ChannelDB"><span class="xref myst py py-class">evennia.ChannelDB</span></a></p></li>
<li><p><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">evennia.Msg</span></a></p></li>
<li><p>evennia.managers - contains shortcuts to all database managers</p></li>
</ul>
</section>
<section id="contributions">
<h3>Contributions<a class="headerlink" href="#contributions" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="Contribs/Contribs-Overview.html"><span class="doc std std-doc">evennia.contrib</span></a> game-specific contributions and plugins</p></li>
</ul>
<div class="toctree-wrapper compound">
</div>
</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" >
<a href="api/evennia-api.html" title="evennia"
>next</a> |</li>
<li class="right" >
<a href="Links.html" title="Links"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 2.x</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Summary</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink