mirror of
https://github.com/evennia/evennia.git
synced 2026-03-23 08:16:30 +01:00
211 lines
No EOL
8.4 KiB
HTML
211 lines
No EOL
8.4 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<title>evennia — Evennia 1.0-dev documentation</title>
|
||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/language_data.js"></script>
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="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.BASE_ACCOUNT_TYPECLASS</p></li>
|
||
<li><p>evennia.BASE_CHANNEL_TYPECLASS</p></li>
|
||
<li><p>evennia.BASE_CHARACTER_TYPECLASS</p></li>
|
||
<li><p>evennia.BASE_EXIT_TYPECLASS</p></li>
|
||
<li><p>evennia.BASE_GUEST_TYPECLASS</p></li>
|
||
<li><p>evennia.BASE_OBJECT_TYPECLASS</p></li>
|
||
<li><p>evennia.BASE_ROOM_TYPECLASS</p></li>
|
||
<li><p>evennia.BASE_SCRIPT_TYPECLASS</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="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">term_size=(140</em>, <em class="sig-param">80)</em>, <em class="sig-param">debugger='auto'</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="section" id="modules">
|
||
<h2>Modules<a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="packages-folders">
|
||
<h2>Packages/folders<a class="headerlink" href="#packages-folders" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||
</a></p>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
<p><h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">evennia</a><ul>
|
||
<li><a class="reference internal" href="#modules">Modules</a></li>
|
||
<li><a class="reference internal" href="#packages-folders">Packages/folders</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.rst.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="evennia.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="../../0.9.5/api/evennia.html">0.9.5 (master branch)</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, The Evennia developer community.
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
|
||
</div>
|
||
</body>
|
||
</html> |