Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-18 13:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/0.x/api/evennia.html
Griatch fe3ad71ae6 Add 0.x legacy docs
2023-12-20 19:10:09 +01:00

500 lines
No EOL
38 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>evennia &#8212; Evennia 0.9.5 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>
<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>
<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 0.9.5</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia">
<span id="evennia"></span><h1>evennia<a class="headerlink" href="#module-evennia" title="Permalink to this headline"></a></h1>
<p>Evennia MU* creation system.</p>
<p>Online manual and API docs are found at <a class="reference external" href="http://www.evennia.com">http://www.evennia.com</a>.</p>
<p>Flat-API shortcut names:</p>
<ul class="simple">
<li><p>evennia.ANSIString</p></li>
<li><p>evennia.AccountDB</p></li>
<li><p>evennia.CHANNEL_HANDLER</p></li>
<li><p>evennia.ChannelDB</p></li>
<li><p>evennia.CmdSet</p></li>
<li><p>evennia.Command</p></li>
<li><p>evennia.DefaultAccount</p></li>
<li><p>evennia.DefaultChannel</p></li>
<li><p>evennia.DefaultCharacter</p></li>
<li><p>evennia.DefaultExit</p></li>
<li><p>evennia.DefaultGuest</p></li>
<li><p>evennia.DefaultObject</p></li>
<li><p>evennia.DefaultRoom</p></li>
<li><p>evennia.DefaultScript</p></li>
<li><p>evennia.EvEditor</p></li>
<li><p>evennia.EvForm</p></li>
<li><p>evennia.EvMenu</p></li>
<li><p>evennia.EvMore</p></li>
<li><p>evennia.EvTable</p></li>
<li><p>evennia.GLOBAL_SCRIPTS</p></li>
<li><p>evennia.InterruptCommand</p></li>
<li><p>evennia.MONITOR_HANDLER</p></li>
<li><p>evennia.Msg</p></li>
<li><p>evennia.OPTION_CLASSES</p></li>
<li><p>evennia.ObjectDB</p></li>
<li><p>evennia.SESSION_HANDLER</p></li>
<li><p>evennia.ScriptDB</p></li>
<li><p>evennia.TASK_HANDLER</p></li>
<li><p>evennia.TICKER_HANDLER</p></li>
<li><p>evennia.ansi</p></li>
<li><p>evennia.contrib</p></li>
<li><p>evennia.create_account</p></li>
<li><p>evennia.create_channel</p></li>
<li><p>evennia.create_help_entry</p></li>
<li><p>evennia.create_message</p></li>
<li><p>evennia.create_object</p></li>
<li><p>evennia.create_script</p></li>
<li><p>evennia.default_cmds</p></li>
<li><p>evennia.gametime</p></li>
<li><p>evennia.inputhandler</p></li>
<li><p>evennia.lockfuncs</p></li>
<li><p>evennia.logger</p></li>
<li><p>evennia.managers</p></li>
<li><p>evennia.search_account</p></li>
<li><p>evennia.search_channel</p></li>
<li><p>evennia.search_help</p></li>
<li><p>evennia.search_message</p></li>
<li><p>evennia.search_object</p></li>
<li><p>evennia.search_script</p></li>
<li><p>evennia.search_tag</p></li>
<li><p>evennia.set_trace</p></li>
<li><p>evennia.settings</p></li>
<li><p>evennia.signals</p></li>
<li><p>evennia.spawn</p></li>
<li><p>evennia.syscmdkeys</p></li>
</ul>
<dl class="py function">
<dt id="evennia.set_trace">
<code class="sig-prename descclassname">evennia.</code><code class="sig-name descname">set_trace</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">term_size</span><span class="o">=</span><span class="default_value">140, 80</span></em>, <em class="sig-param"><span class="n">debugger</span><span class="o">=</span><span class="default_value">'auto'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia.html#set_trace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.set_trace" title="Permalink to this definition"></a></dt>
<dd><p>Helper function for running a debugger inside the Evennia event loop.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>term_size</strong> (<em>tuple</em><em>, </em><em>optional</em>) – Only used for Pudb and defines the size of the terminal
(width, height) in number of characters.</p></li>
<li><p><strong>debugger</strong> (<em>str</em><em>, </em><em>optional</em>) – One of ‘auto’, ‘pdb’ or ‘pudb’. Pdb is the standard debugger. Pudb
is an external package with a different, more ‘graphical’, ncurses-based UI. With
‘auto’, will use pudb if possible, otherwise fall back to pdb. Pudb is available through
<strong>pip install pudb</strong>.</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>To use:</p>
<ol class="arabic">
<li><p>add this to a line to act as a breakpoint for entering the debugger:</p>
<blockquote>
<div><p>from evennia import set_trace; set_trace()</p>
</div></blockquote>
</li>
<li><p>restart evennia in interactive mode</p>
<blockquote>
<div><p>evennia istart</p>
</div></blockquote>
</li>
<li><p>debugger will appear in the interactive terminal when breakpoint is reached. Exit
with ‘q’, remove the break line and restart server when finished.</p></li>
</ol>
</dd></dl>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.settings_default.html">evennia.settings_default</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.html">evennia.accounts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.accounts.html">evennia.accounts.accounts</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.admin.html">evennia.accounts.admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.bots.html">evennia.accounts.bots</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.manager.html">evennia.accounts.manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.models.html">evennia.accounts.models</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.html">evennia.commands</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.cmdhandler.html">evennia.commands.cmdhandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.cmdparser.html">evennia.commands.cmdparser</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.cmdset.html">evennia.commands.cmdset</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.cmdsethandler.html">evennia.commands.cmdsethandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.command.html">evennia.commands.command</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.default.html">evennia.commands.default</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.account.html">evennia.commands.default.account</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.admin.html">evennia.commands.default.admin</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.batchprocess.html">evennia.commands.default.batchprocess</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.building.html">evennia.commands.default.building</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.cmdset_account.html">evennia.commands.default.cmdset_account</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.cmdset_character.html">evennia.commands.default.cmdset_character</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.cmdset_session.html">evennia.commands.default.cmdset_session</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.cmdset_unloggedin.html">evennia.commands.default.cmdset_unloggedin</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.comms.html">evennia.commands.default.comms</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.general.html">evennia.commands.default.general</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.help.html">evennia.commands.default.help</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.muxcommand.html">evennia.commands.default.muxcommand</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.syscommands.html">evennia.commands.default.syscommands</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.system.html">evennia.commands.default.system</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.tests.html">evennia.commands.default.tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.unloggedin.html">evennia.commands.default.unloggedin</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.comms.html">evennia.comms</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.admin.html">evennia.comms.admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.channelhandler.html">evennia.comms.channelhandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.comms.html">evennia.comms.comms</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.managers.html">evennia.comms.managers</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.models.html">evennia.comms.models</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.html">evennia.contrib</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.barter.html">evennia.contrib.barter</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.building_menu.html">evennia.contrib.building_menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.chargen.html">evennia.contrib.chargen</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.clothing.html">evennia.contrib.clothing</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.color_markups.html">evennia.contrib.color_markups</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.custom_gametime.html">evennia.contrib.custom_gametime</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.dice.html">evennia.contrib.dice</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.email_login.html">evennia.contrib.email_login</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.extended_room.html">evennia.contrib.extended_room</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.fieldfill.html">evennia.contrib.fieldfill</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.gendersub.html">evennia.contrib.gendersub</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.health_bar.html">evennia.contrib.health_bar</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.mail.html">evennia.contrib.mail</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.mapbuilder.html">evennia.contrib.mapbuilder</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.menu_login.html">evennia.contrib.menu_login</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.multidescer.html">evennia.contrib.multidescer</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.puzzles.html">evennia.contrib.puzzles</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.random_string_generator.html">evennia.contrib.random_string_generator</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rplanguage.html">evennia.contrib.rplanguage</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpsystem.html">evennia.contrib.rpsystem</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.simpledoor.html">evennia.contrib.simpledoor</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.slow_exit.html">evennia.contrib.slow_exit</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.talking_npc.html">evennia.contrib.talking_npc</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tree_select.html">evennia.contrib.tree_select</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.unixcommand.html">evennia.contrib.unixcommand</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.wilderness.html">evennia.contrib.wilderness</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.html">evennia.contrib.ingame_python</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.callbackhandler.html">evennia.contrib.ingame_python.callbackhandler</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.commands.html">evennia.contrib.ingame_python.commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.eventfuncs.html">evennia.contrib.ingame_python.eventfuncs</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.scripts.html">evennia.contrib.ingame_python.scripts</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.tests.html">evennia.contrib.ingame_python.tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.typeclasses.html">evennia.contrib.ingame_python.typeclasses</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.utils.html">evennia.contrib.ingame_python.utils</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.security.html">evennia.contrib.security</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.security.auditing.html">evennia.contrib.security.auditing</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.security.auditing.outputs.html">evennia.contrib.security.auditing.outputs</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.security.auditing.server.html">evennia.contrib.security.auditing.server</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.security.auditing.tests.html">evennia.contrib.security.auditing.tests</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.turnbattle.html">evennia.contrib.turnbattle</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_basic.html">evennia.contrib.turnbattle.tb_basic</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_equip.html">evennia.contrib.turnbattle.tb_equip</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_items.html">evennia.contrib.turnbattle.tb_items</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_magic.html">evennia.contrib.turnbattle.tb_magic</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_range.html">evennia.contrib.turnbattle.tb_range</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_examples.html">evennia.contrib.tutorial_examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.bodyfunctions.html">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.cmdset_red_button.html">evennia.contrib.tutorial_examples.cmdset_red_button</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.example_batch_code.html">evennia.contrib.tutorial_examples.example_batch_code</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button.html">evennia.contrib.tutorial_examples.red_button</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button_scripts.html">evennia.contrib.tutorial_examples.red_button_scripts</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.tests.html">evennia.contrib.tutorial_examples.tests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_world.html">evennia.contrib.tutorial_world</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.intro_menu.html">evennia.contrib.tutorial_world.intro_menu</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.mob.html">evennia.contrib.tutorial_world.mob</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.objects.html">evennia.contrib.tutorial_world.objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.rooms.html">evennia.contrib.tutorial_world.rooms</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.help.html">evennia.help</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.admin.html">evennia.help.admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.manager.html">evennia.help.manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html">evennia.help.models</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.locks.html">evennia.locks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockfuncs.html#mux-name-affects-effect">MUX Name: Affects: Effect:</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockhandler.html">evennia.locks.lockhandler</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.objects.html">evennia.objects</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.admin.html">evennia.objects.admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.manager.html">evennia.objects.manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.models.html">evennia.objects.models</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.objects.html">evennia.objects.objects</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.prototypes.html">evennia.prototypes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.menus.html">evennia.prototypes.menus</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.protfuncs.html">evennia.prototypes.protfuncs</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.prototypes.html">evennia.prototypes.prototypes</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.spawner.html">evennia.prototypes.spawner</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.scripts.html">evennia.scripts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.admin.html">evennia.scripts.admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.manager.html">evennia.scripts.manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.models.html">evennia.scripts.models</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.monitorhandler.html">evennia.scripts.monitorhandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.scripthandler.html">evennia.scripts.scripthandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.scripts.html">evennia.scripts.scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.taskhandler.html">evennia.scripts.taskhandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.tickerhandler.html">evennia.scripts.tickerhandler</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.html">evennia.server</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.admin.html">evennia.server.admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.amp_client.html">evennia.server.amp_client</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.connection_wizard.html">evennia.server.connection_wizard</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.deprecations.html">evennia.server.deprecations</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.evennia_launcher.html">evennia.server.evennia_launcher</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.initial_setup.html">evennia.server.initial_setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.inputfuncs.html">evennia.server.inputfuncs</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.manager.html">evennia.server.manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.models.html">evennia.server.models</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.server.html">evennia.server.server</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.serversession.html">evennia.server.serversession</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.session.html">evennia.server.session</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.sessionhandler.html">evennia.server.sessionhandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.signals.html">evennia.server.signals</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.throttle.html">evennia.server.throttle</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.validators.html">evennia.server.validators</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.webserver.html">evennia.server.webserver</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.game_index_client.html">evennia.server.game_index_client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.game_index_client.client.html">evennia.server.game_index_client.client</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.game_index_client.service.html">evennia.server.game_index_client.service</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.html">evennia.server.portal</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.amp.html">evennia.server.portal.amp</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.amp_server.html">evennia.server.portal.amp_server</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.grapevine.html">evennia.server.portal.grapevine</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.irc.html">evennia.server.portal.irc</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.mccp.html">evennia.server.portal.mccp</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.mssp.html">evennia.server.portal.mssp</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.mxp.html">evennia.server.portal.mxp</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.naws.html">evennia.server.portal.naws</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.portal.html">evennia.server.portal.portal</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.portalsessionhandler.html">evennia.server.portal.portalsessionhandler</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.rss.html">evennia.server.portal.rss</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.ssh.html">evennia.server.portal.ssh</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.ssl.html">evennia.server.portal.ssl</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.suppress_ga.html">evennia.server.portal.suppress_ga</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.telnet.html">evennia.server.portal.telnet</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.telnet_oob.html">evennia.server.portal.telnet_oob</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.telnet_ssl.html">evennia.server.portal.telnet_ssl</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.tests.html">evennia.server.portal.tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.ttype.html">evennia.server.portal.ttype</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.webclient.html">evennia.server.portal.webclient</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.webclient_ajax.html">evennia.server.portal.webclient_ajax</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.profiling.html">evennia.server.profiling</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.profiling.dummyrunner.html">evennia.server.profiling.dummyrunner</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.profiling.dummyrunner_settings.html">evennia.server.profiling.dummyrunner_settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.profiling.memplot.html">evennia.server.profiling.memplot</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.profiling.settings_mixin.html">evennia.server.profiling.settings_mixin</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.profiling.test_queries.html">evennia.server.profiling.test_queries</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.profiling.tests.html">evennia.server.profiling.tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.profiling.timetrace.html">evennia.server.profiling.timetrace</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.typeclasses.html">evennia.typeclasses</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.admin.html">evennia.typeclasses.admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.attributes.html">evennia.typeclasses.attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.managers.html">evennia.typeclasses.managers</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.models.html">evennia.typeclasses.models</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.tags.html">evennia.typeclasses.tags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.utils.html">evennia.utils</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.ansi.html">evennia.utils.ansi</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.batchprocessors.html">evennia.utils.batchprocessors</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.batchprocessors.html#batch-command-processor-file-syntax">Batch-Command processor file syntax</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.batchprocessors.html#batch-code-processor-file-syntax">Batch-Code processor file syntax</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.containers.html">evennia.utils.containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.create.html">evennia.utils.create</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.dbserialize.html">evennia.utils.dbserialize</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.eveditor.html">evennia.utils.eveditor</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.evform.html">evennia.utils.evform</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.evmenu.html">evennia.utils.evmenu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.evmenu.html#menu-generation-from-template-string">Menu generation from template string</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.evmore.html">evennia.utils.evmore</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.evtable.html">evennia.utils.evtable</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.gametime.html">evennia.utils.gametime</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.inlinefuncs.html">evennia.utils.inlinefuncs</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.logger.html">evennia.utils.logger</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.optionclasses.html">evennia.utils.optionclasses</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.optionhandler.html">evennia.utils.optionhandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.picklefield.html">evennia.utils.picklefield</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.search.html">evennia.utils.search</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.test_resources.html">evennia.utils.test_resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.text2html.html">evennia.utils.text2html</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.utils.html">evennia.utils.utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.validatorfuncs.html">evennia.utils.validatorfuncs</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.idmapper.html">evennia.utils.idmapper</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.idmapper.manager.html">evennia.utils.idmapper.manager</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.idmapper.models.html">evennia.utils.idmapper.models</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.idmapper.tests.html">evennia.utils.idmapper.tests</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.web.html">evennia.web</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.urls.html">evennia.web.urls</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.backends.html">evennia.web.utils.backends</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.general_context.html">evennia.web.utils.general_context</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.middleware.html">evennia.web.utils.middleware</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.tests.html">evennia.web.utils.tests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.webclient.html">evennia.web.webclient</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.webclient.urls.html">evennia.web.webclient.urls</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.webclient.views.html">evennia.web.webclient.views</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html">evennia.web.website</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.forms.html">evennia.web.website.forms</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.tests.html">evennia.web.website.tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.urls.html">evennia.web.website.urls</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.templatetags.html">evennia.web.website.templatetags</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.templatetags.addclass.html">evennia.web.website.templatetags.addclass</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<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>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.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>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="../../1.0-dev/api/evennia.html">1.0-dev (develop branch)</a></li>
<li><a href="evennia.html">0.9.5 (v0.9.5 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 0.9.5</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, 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