Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-05 23:47:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2021-05-16 00:06:01 +02:00
parent 58f5ece91b
commit 1bbc93507a
1000 changed files with 39106 additions and 33861 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/1.0-dev/Evennia-API.html
View file

@ -4,7 +4,8 @@
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<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 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" />
@ -45,7 +46,7 @@
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="api-summary">
<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">
@ -63,17 +64,17 @@
<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">
<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">
<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>
</div>
<div class="section" id="search-functions">
</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 external" href="api/evennia.utils.search.html#evennia.utils.search.search_account">evennia.search_account</a></p></li>
@ -84,8 +85,8 @@ The flat API is defined in <code class="docutils literal notranslate"><span clas
<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>
</div>
<div class="section" id="create-functions">
</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 external" href="api/evennia.utils.create.html#evennia.utils.create.create_account">evennia.create_account</a></p></li>
@ -95,8 +96,8 @@ The flat API is defined in <code class="docutils literal notranslate"><span clas
<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>
</div>
<div class="section" id="typeclasses">
</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 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>
@ -108,8 +109,8 @@ The flat API is defined in <code class="docutils literal notranslate"><span clas
<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>
</div>
<div class="section" id="commands">
</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 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>
@ -117,8 +118,8 @@ The flat API is defined in <code class="docutils literal notranslate"><span clas
<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>
</div>
<div class="section" id="utilities">
</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 external" href="api/evennia.utils.utils.html">evennia.utils.utils</a> - mixed useful utilities</p></li>
@ -134,8 +135,8 @@ The flat API is defined in <code class="docutils literal notranslate"><span clas
<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>
<li><p><a class="reference external" href="api/evennia.utils.funcparser.html">evennia.utils.funcparser.Funcparser</a> - inline parsing of functions (<a class="reference internal" href="Components/FuncParser.html"><span class="doc">docs</span></a>)</p></li>
</ul>
</div>
<div class="section" id="global-singleton-handlers">
</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 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>
@ -143,8 +144,8 @@ The flat API is defined in <code class="docutils literal notranslate"><span clas
<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">
</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 external" href="api/evennia.objects.models.html#evennia.objects.models.ObjectDB">evennia.ObjectDB</a></p></li>
@ -154,16 +155,16 @@ The flat API is defined in <code class="docutils literal notranslate"><span clas
<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">
</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 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>
</div>
</div>
</div>
</section>
</section>
</section>
<div class="clearer"></div>