Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-20 23:06:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/Evennia-API.html

254 lines
19 KiB
HTML
Raw Normal View History

Updated HTML docs
2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<html>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<head>
<meta charset="utf-8" />
Updated HTML docs
2020-10-15 01:31:30 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
Updated HTML docs
2020-07-14 00:21:00 +02:00
<title>API Summary &#8212; Evennia 1.0-dev documentation</title>
Updated HTML docs
2020-06-15 21:52:33 +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>
Updated HTML docs
2020-06-13 23:31:27 +02:00
<link rel="shortcut icon" href="_static/favicon.ico"/>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<link rel="index" title="Index" href="genindex.html" />
Updated HTML docs
2020-10-19 22:46:24 +02:00
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Coding and development help" href="Coding/Coding-Overview.html" />
<link rel="prev" title="Core Concepts" href="Concepts/Concepts-Overview.html" />
Updated HTML docs
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">
<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>
Updated HTML docs
2020-10-19 22:46:24 +02:00
<li class="right" >
<a href="Coding/Coding-Overview.html" title="Coding and development help"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Concepts/Concepts-Overview.html" title="Core Concepts"
accesskey="P">previous</a> |</li>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Summary</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-11-14 11:55:52 +01:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
Updated HTML docs
2020-06-13 00:36:45 +02:00
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="section" id="api-summary">
<h1>API Summary<a class="headerlink" href="#api-summary" title="Permalink to this headline"></a></h1>
<p><a class="reference external" href="api/evennia.html">evennia</a> - library root</p>
<ul class="simple">
<li><p><a class="reference external" href="api/evennia.accounts.html">evennia.accounts</a> - the out-of-character entities representing players</p></li>
<li><p><a class="reference external" href="api/evennia.commands.html">evennia.commands</a> - handle all inputs. Also includes default commands</p></li>
<li><p><a class="reference external" href="api/evennia.comms.html">evennia.comms</a> - in-game channels and messaging</p></li>
<li><p><a class="reference external" href="api/evennia.contrib.html">evennia.contrib</a> - game-specific tools and code contributed by the community</p></li>
<li><p><a class="reference external" href="api/evennia.help.html">evennia.help</a> - in-game help system</p></li>
<li><p><a class="reference external" href="api/evennia.locks.html">evennia.locks</a> - limiting access to various systems and resources</p></li>
<li><p><a class="reference external" href="api/evennia.objects.html">evennia.objects</a> - all in-game entities, like Rooms, Characters, Exits etc</p></li>
<li><p><a class="reference external" href="api/evennia.prototypes.html">evennia.prototypes</a> - customize entities using dicts</p></li>
<li><p><a class="reference external" href="api/evennia.scripts.html">evennia.scripts</a> - all out-of-character game objects</p></li>
<li><p><a class="reference external" href="api/evennia.server.html">evennia.server</a> - core Server and Portal programs, also network protocols</p></li>
<li><p><a class="reference external" href="api/evennia.typeclasses.html">evennia.typeclasses</a> - core database-python bridge</p></li>
<li><p><a class="reference external" href="api/evennia.utils.html">evennia.utils</a> - lots of useful coding tools and utilities</p></li>
<li><p><a class="reference external" href="api/evennia.web.html">evennia.web</a> - webclient, website and other web resources</p></li>
</ul>
<div class="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/master/evennia/__init__.py">viewable here</a></p>
<div class="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 external" href="https://github.com/evennia/evennia/blob/master/evennia/settings_default.py">evennia.settings_default</a> - all settings (modify/override in <code class="docutils literal notranslate"><span class="pre">mygame/server/settings.py</span></code>)</p></li>
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="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 external" href="api/evennia.utils.search.html#evennia.utils.search.search_account">evennia.search_account</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.search.html#evennia.utils.search.search_object">evennia.search_object</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.search.html#evennia.utils.search_object_by_tag">evennia.search_object_by_tag</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.search.html#evennia.utils.search_script">evennia.search_script</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.search.html#evennia.utils.search_channel">evennia.search_channel</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.search.html#evennia.utils.search_message">evennia.search_message</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.search.html#evennia.utils.search.search_help">evennia.search_help</a></p></li>
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="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 external" href="api/evennia.utils.create.html#evennia.utils.create.create_account">evennia.create_account</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.create.html#evennia.utils.create.create_object">evennia.create_object</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.create.html#evennia.utils.create.create_script">evennia.create_script</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.create.html#evennia.utils.create.create_channel">evennia.create_channel</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.create.html#evennia.utils.create.create_help_entry">evennia.create_help_entry</a></p></li>
<li><p><a class="reference external" href="api/evennia.utils.create.html#evennia.utils.create.create_message">evennia.create_message</a></p></li>
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="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 external" href="api/evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount">evennia.Defaultaccount</a> - player account class (<a class="reference internal" href="Components/Accounts.html"><span class="doc">docs</span></a>)</p></li>
<li><p><a class="reference external" href="api/evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultGuest">evennia.DefaultGuest</a> - base guest account class</p></li>
<li><p><a class="reference external" href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject">evennia.DefaultObject</a> - base class for all objects (<a class="reference internal" href="Components/Objects.html"><span class="doc">docs</span></a>)</p></li>
<li><p><a class="reference external" href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter">evennia.DefaultCharacter</a> - base class for in-game characters (<a class="reference external" href="Components/Objects.html#Character">docs</a>)</p></li>
<li><p><a class="reference external" href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultRoom">evennia.DefaultRoom</a> - base class for rooms (<a class="reference external" href="Components/Objects.html#Room">docs</a>)</p></li>
<li><p><a class="reference external" href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultExit">evennia.DefaultExit</a> - base class for exits (<a class="reference external" href="Components/Objects.html#Exit">docs</a>)</p></li>
<li><p><a class="reference external" href="api/evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript">evennia.DefaultScript</a> - base class for OOC-objects (<a class="reference internal" href="Components/Scripts.html"><span class="doc">docs</span></a>)</p></li>
<li><p><a class="reference external" href="api/evennia.comms.comms.html#evennia.comms.comms.DefaultChannel">evennia.DefaultChannel</a> - base class for in-game channels (<a class="reference internal" href="Components/Channels.html"><span class="doc">docs</span></a>)</p></li>
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="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 external" href="api/evennia.commands.command.html#evennia.commands.command.Command">evennia.Command</a> - base <a class="reference internal" href="Components/Commands.html"><span class="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 external" href="api/evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet">evennia.CmdSet</a> - base <a class="reference internal" href="Components/Command-Sets.html"><span class="doc">Cmdset</span></a> class</p></li>
<li><p><a class="reference external" href="api/Default-Command-Help.html">evennia.default_cmds</a> - access all default command classes as properties</p></li>
<li><p><a class="reference external" href="api/Commands.html#System-Commands">evennia.syscmdkeys</a> - access system command keys as properties</p></li>
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="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 external" href="api/evennia.utils.utils.html">evennia.utils.utils</a> - mixed useful utilities</p></li>
<li><p><a class="reference external" href="api/evennia.utils.gametime.html">evennia.gametime</a> - server run- and game time (<a class="reference external" href="Components/Coding-Utils.html#gametime">docs</a>)</p></li>
<li><p><a class="reference external" href="api/evennia.utils.logger.html">evennia.logger</a> - logging tools</p></li>
<li><p><a class="reference external" href="api/evennia.utils.ansi.html">evennia.ansi</a> - ansi coloring tools</p></li>
<li><p><a class="reference external" href="api/evennia.prototypes.spawner.html#evennia.prototypes.spawner.Spawn">evennia.spawn</a> - spawn/prototype system (<a class="reference internal" href="Components/Spawner-and-Prototypes.html"><span class="doc">docs</span></a>)</p></li>
<li><p><a class="reference external" href="api/evennia.locks.lockfuncs.html">evennia.lockfuncs</a> - default lock functions for access control (<a class="reference internal" href="Components/Locks.html"><span class="doc">docs</span></a>)</p></li>
<li><p><a class="reference external" href="api/evennia.utils.evmenu.html#evennia.utils.evmenu.EvMenu">evennia.EvMenu</a> - menu system (<a class="reference internal" href="Components/EvMenu.html"><span class="doc">docs</span></a>)</p></li>
<li><p><a class="reference external" href="api/evennia.utils.evtable.html#evennia.utils.evtable.EvTable">evennia.EvTable</a> - text table creater</p></li>
<li><p><a class="reference external" href="api/evennia.utils.evform.html#evennia.utils.evform.EvForm">evennia.EvForm</a> - text form creator</p></li>
Updated HTML docs
2020-10-19 22:46:24 +02:00
<li><p>Evennia.EvMore - text paginator</p></li>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<li><p><a class="reference external" href="api/evennia.utils.eveditor.html#evennia.utils.eveditor.EvEditor">evennia.EvEditor</a> - in game text line editor (<a class="reference internal" href="Components/EvEditor.html"><span class="doc">docs</span></a>)</p></li>
</ul>
</div>
<div class="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 external" href="api/evennia.scripts.tickerhandler.html">evennia.TICKER_HANDLER</a> - allow objects subscribe to tickers (<a class="reference internal" href="Components/TickerHandler.html"><span class="doc">docs</span></a>)</p></li>
<li><p><a class="reference external" href="api/evennia.scripts.monitorhandler.html">evennia.MONITOR_HANDLER</a> - monitor changes (<a class="reference internal" href="Components/MonitorHandler.html"><span class="doc">docs</span></a>)</p></li>
<li><p><a class="reference external" href="api/evennia.comms.channelhandler.html">evennia.CHANNEL_HANDLER</a> - maintains channels</p></li>
<li><p><a class="reference external" href="api/evennia.server.serverhandler.html">evennia.SESSION_HANDLER</a> - manages all sessionsmain session handler</p></li>
</ul>
</div>
<div class="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 external" href="api/evennia.objects.models.html#evennia.objects.models.ObjectDB">evennia.ObjectDB</a></p></li>
<li><p><a class="reference external" href="api/evennia.accounts.models.html#evennia.accounts.models.AccountDB">evennia.accountDB</a></p></li>
<li><p><a class="reference external" href="api/evennia.scripts.models.html#evennia.scripts.models.ScriptDB">evennia.ScriptDB</a></p></li>
<li><p><a class="reference external" href="api/evennia.channels.models.html#evennia.channels.models.ChannelDB">evennia.ChannelDB</a></p></li>
<li><p><a class="reference external" href="api/evennia.comms.models.html#evennia.comms.models.Msg">evennia.Msg</a></p></li>
<li><p>evennia.managers - contains shortcuts to all database managers</p></li>
</ul>
</div>
<div class="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 external" href="https://github.com/evennia/evennia/blob/master/evennia/contrib/">evennia.contrib</a> -
game-specific contributions and plugins (<a class="reference external" href="https://github.com/evennia/evennia/blob/master/evennia/contrib/README.md">docs</a>)</p></li>
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
</div>
</div>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<div class="clearer"></div>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
</div>
</div>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<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>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<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>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
</li>
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
Updated HTML docs
2020-10-19 22:46:24 +02:00
<h4>Previous topic</h4>
<p class="topless"><a href="Concepts/Concepts-Overview.html"
title="previous chapter">Core Concepts</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Coding/Coding-Overview.html"
title="next chapter">Coding and development help</a></p>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<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>Versions</h3>
<ul>
<li><a href="Evennia-API.html">1.0-dev (develop branch)</a></li>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<li><a href="../0.9.5/Evennia-API.html">0.9.5 (master branch)</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-06-14 21:48:02 +02:00
Updated HTML docs
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">
<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>
Updated HTML docs
2020-10-19 22:46:24 +02:00
<li class="right" >
<a href="Coding/Coding-Overview.html" title="Coding and development help"
>next</a> |</li>
<li class="right" >
<a href="Concepts/Concepts-Overview.html" title="Core Concepts"
>previous</a> |</li>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Summary</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-11-14 11:55:52 +01:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Updated HTML docs
2020-10-15 01:31:30 +02:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
</body>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</html>
Reference in a new issue Copy permalink