mirror of
https://github.com/evennia/evennia.git
synced 2026-03-22 07:46:30 +01:00
Updated HTML docs
This commit is contained in:
Griatch
parent
998c2157a6
commit
ef0e7c8aec
1239 changed files with 642730 additions and 0 deletions
289
docs/versions/1.0-dev/api/evennia-api.html
Normal file
289
docs/versions/1.0-dev/api/evennia-api.html
Normal file
|
|
@ -0,0 +1,289 @@
|
|||
|
||||
<!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/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="evennia">
|
||||
<h1>evennia<a class="headerlink" href="#evennia" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.html">evennia package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.accounts.html">evennia.accounts package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.accounts">evennia.accounts.accounts module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.admin">evennia.accounts.admin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.bots">evennia.accounts.bots module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.manager">evennia.accounts.manager module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.models">evennia.accounts.models module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.tests">evennia.accounts.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.html">evennia.commands package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.cmdhandler">evennia.commands.cmdhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.cmdparser">evennia.commands.cmdparser module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.cmdset">evennia.commands.cmdset module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.cmdsethandler">evennia.commands.cmdsethandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.command">evennia.commands.command module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.tests">evennia.commands.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.comms.html">evennia.comms package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.admin">evennia.comms.admin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.channelhandler">evennia.comms.channelhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.comms">evennia.comms.comms module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.managers">evennia.comms.managers module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.models">evennia.comms.models module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.tests">evennia.comms.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.html">evennia.contrib package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.barter">evennia.contrib.barter module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.building_menu">evennia.contrib.building_menu module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.chargen">evennia.contrib.chargen module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.clothing">evennia.contrib.clothing module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.color_markups">evennia.contrib.color_markups module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.custom_gametime">evennia.contrib.custom_gametime module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.dice">evennia.contrib.dice module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.email_login">evennia.contrib.email_login module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.extended_room">evennia.contrib.extended_room module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.fieldfill">evennia.contrib.fieldfill module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.gendersub">evennia.contrib.gendersub module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.health_bar">evennia.contrib.health_bar module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.mail">evennia.contrib.mail module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.mapbuilder">evennia.contrib.mapbuilder module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.menu_login">evennia.contrib.menu_login module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.multidescer">evennia.contrib.multidescer module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.puzzles">evennia.contrib.puzzles module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.random_string_generator">evennia.contrib.random_string_generator module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.rplanguage">evennia.contrib.rplanguage module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.rpsystem">evennia.contrib.rpsystem module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.simpledoor">evennia.contrib.simpledoor module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.slow_exit">evennia.contrib.slow_exit module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.talking_npc">evennia.contrib.talking_npc module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.test_traits">evennia.contrib.test_traits module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.tests">evennia.contrib.tests module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.traits">evennia.contrib.traits module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.tree_select">evennia.contrib.tree_select module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.unixcommand">evennia.contrib.unixcommand module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.wilderness">evennia.contrib.wilderness module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.game_template.html">evennia.game_template package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.html#subpackages">Subpackages</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.help.html">evennia.help package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.help.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.help.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.help.html#module-evennia.help.admin">evennia.help.admin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.help.html#module-evennia.help.manager">evennia.help.manager module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.help.html#module-evennia.help.models">evennia.help.models module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.html">evennia.locks package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.locks.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.locks.html#module-evennia.locks.lockfuncs">evennia.locks.lockfuncs module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.locks.html#module-evennia.locks.lockhandler">evennia.locks.lockhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.locks.html#module-evennia.locks.tests">evennia.locks.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.objects.html">evennia.objects package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.admin">evennia.objects.admin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.manager">evennia.objects.manager module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.models">evennia.objects.models module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.objects">evennia.objects.objects module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.tests">evennia.objects.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.prototypes.html">evennia.prototypes package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.prototypes.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.menus">evennia.prototypes.menus module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.protfuncs">evennia.prototypes.protfuncs module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.prototypes">evennia.prototypes.prototypes module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.spawner">evennia.prototypes.spawner module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.tests">evennia.prototypes.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.scripts.html">evennia.scripts package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.admin">evennia.scripts.admin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.manager">evennia.scripts.manager module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.models">evennia.scripts.models module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.monitorhandler">evennia.scripts.monitorhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.scripthandler">evennia.scripts.scripthandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.scripts">evennia.scripts.scripts module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.taskhandler">evennia.scripts.taskhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.tests">evennia.scripts.tests module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.tickerhandler">evennia.scripts.tickerhandler module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.html">evennia.server package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.admin">evennia.server.admin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.amp_client">evennia.server.amp_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.connection_wizard">evennia.server.connection_wizard module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.deprecations">evennia.server.deprecations module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.evennia_launcher">evennia.server.evennia_launcher module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.initial_setup">evennia.server.initial_setup module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.inputfuncs">evennia.server.inputfuncs module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.manager">evennia.server.manager module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.models">evennia.server.models module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.server">evennia.server.server module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.serversession">evennia.server.serversession module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.session">evennia.server.session module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.sessionhandler">evennia.server.sessionhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.signals">evennia.server.signals module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.throttle">evennia.server.throttle module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.validators">evennia.server.validators module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#module-evennia.server.webserver">evennia.server.webserver module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.typeclasses.html">evennia.typeclasses package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.admin">evennia.typeclasses.admin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.attributes">evennia.typeclasses.attributes module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.managers">evennia.typeclasses.managers module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.models">evennia.typeclasses.models module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.tags">evennia.typeclasses.tags module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.tests">evennia.typeclasses.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.html">evennia.utils package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.ansi">evennia.utils.ansi module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.batchprocessors">evennia.utils.batchprocessors module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.containers">evennia.utils.containers module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.create">evennia.utils.create module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.dbserialize">evennia.utils.dbserialize module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.eveditor">evennia.utils.eveditor module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.evform">evennia.utils.evform module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.evmenu">evennia.utils.evmenu module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.evmore">evennia.utils.evmore module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.evtable">evennia.utils.evtable module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.gametime">evennia.utils.gametime module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.inlinefuncs">evennia.utils.inlinefuncs module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.logger">evennia.utils.logger module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.optionclasses">evennia.utils.optionclasses module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.optionhandler">evennia.utils.optionhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.picklefield">evennia.utils.picklefield module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.search">evennia.utils.search module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.test_resources">evennia.utils.test_resources module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.text2html">evennia.utils.text2html module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.utils">evennia.utils.utils module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.validatorfuncs">evennia.utils.validatorfuncs module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.html">evennia.web package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.html#module-evennia.web.urls">evennia.web.urls module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.html#module-evennia.settings_default">evennia.settings_default module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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 class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia-api.rst.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>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia-api.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia-api.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
2487
docs/versions/1.0-dev/api/evennia.accounts.html
Normal file
2487
docs/versions/1.0-dev/api/evennia.accounts.html
Normal file
File diff suppressed because it is too large
Load diff
8315
docs/versions/1.0-dev/api/evennia.commands.default.html
Normal file
8315
docs/versions/1.0-dev/api/evennia.commands.default.html
Normal file
File diff suppressed because it is too large
Load diff
2738
docs/versions/1.0-dev/api/evennia.commands.html
Normal file
2738
docs/versions/1.0-dev/api/evennia.commands.html
Normal file
File diff suppressed because it is too large
Load diff
2408
docs/versions/1.0-dev/api/evennia.comms.html
Normal file
2408
docs/versions/1.0-dev/api/evennia.comms.html
Normal file
File diff suppressed because it is too large
Load diff
12670
docs/versions/1.0-dev/api/evennia.contrib.html
Normal file
12670
docs/versions/1.0-dev/api/evennia.contrib.html
Normal file
File diff suppressed because it is too large
Load diff
1677
docs/versions/1.0-dev/api/evennia.contrib.ingame_python.html
Normal file
1677
docs/versions/1.0-dev/api/evennia.contrib.ingame_python.html
Normal file
File diff suppressed because one or more lines are too long
264
docs/versions/1.0-dev/api/evennia.contrib.security.auditing.html
Normal file
264
docs/versions/1.0-dev/api/evennia.contrib.security.auditing.html
Normal file
|
|
@ -0,0 +1,264 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.contrib.security.auditing package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.contrib.security.auditing">
|
||||
<span id="evennia-contrib-security-auditing-package"></span><h1>evennia.contrib.security.auditing package<a class="headerlink" href="#module-evennia.contrib.security.auditing" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.contrib.security.auditing.outputs">
|
||||
<span id="evennia-contrib-security-auditing-outputs-module"></span><h2>evennia.contrib.security.auditing.outputs module<a class="headerlink" href="#module-evennia.contrib.security.auditing.outputs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Auditable Server Sessions - Example Outputs
|
||||
Example methods demonstrating output destinations for logs generated by
|
||||
audited server sessions.</p>
|
||||
<p>This is designed to be a single source of events for developers to customize
|
||||
and add any additional enhancements before events are written out– i.e. if you
|
||||
want to keep a running list of what IPs a user logs in from on account/character
|
||||
objects, or if you want to perform geoip or ASN lookups on IPs before committing,
|
||||
or tag certain events with the results of a reputational lookup, this should be
|
||||
the easiest place to do it. Write a method and invoke it via
|
||||
<cite>settings.AUDIT_CALLBACK</cite> to have log data objects passed to it.</p>
|
||||
<p>Evennia contribution - Johnny 2017</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.contrib.security.auditing.outputs.to_file">
|
||||
<code class="sig-prename descclassname">evennia.contrib.security.auditing.outputs.</code><code class="sig-name descname">to_file</code><span class="sig-paren">(</span><em class="sig-param">data</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/outputs.html#to_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.outputs.to_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes dictionaries of data generated by an AuditedServerSession to files
|
||||
in JSON format, bucketed by date.</p>
|
||||
<p>Uses Evennia’s native logger and writes to the default
|
||||
log directory (~/yourgame/server/logs/ or settings.LOG_DIR)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>data</strong> (<em>dict</em>) – Parsed session transmission data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.contrib.security.auditing.outputs.to_syslog">
|
||||
<code class="sig-prename descclassname">evennia.contrib.security.auditing.outputs.</code><code class="sig-name descname">to_syslog</code><span class="sig-paren">(</span><em class="sig-param">data</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/outputs.html#to_syslog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.outputs.to_syslog" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes dictionaries of data generated by an AuditedServerSession to syslog.</p>
|
||||
<p>Takes advantage of your system’s native logger and writes to wherever
|
||||
you have it configured, which is independent of Evennia.
|
||||
Linux systems tend to write to /var/log/syslog.</p>
|
||||
<p>If you’re running rsyslog, you can configure it to dump and/or forward logs
|
||||
to disk and/or an external data warehouse (recommended– if your server is
|
||||
compromised or taken down, losing your logs along with it is no help!).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>data</strong> (<em>dict</em>) – Parsed session transmission data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.contrib.security.auditing.server">
|
||||
<span id="evennia-contrib-security-auditing-server-module"></span><h2>evennia.contrib.security.auditing.server module<a class="headerlink" href="#module-evennia.contrib.security.auditing.server" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Auditable Server Sessions:
|
||||
Extension of the stock ServerSession that yields objects representing
|
||||
user inputs and system outputs.</p>
|
||||
<p>Evennia contribution - Johnny 2017</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.contrib.security.auditing.server.AuditedServerSession">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.security.auditing.server.</code><code class="sig-name descname">AuditedServerSession</code><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/server.html#AuditedServerSession"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.server.AuditedServerSession" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.server.html#evennia.server.serversession.ServerSession" title="evennia.server.serversession.ServerSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.server.serversession.ServerSession</span></code></a></p>
|
||||
<p>This particular implementation parses all server inputs and/or outputs and
|
||||
passes a dict containing the parsed metadata to a callback method of your
|
||||
creation. This is useful for recording player activity where necessary for
|
||||
security auditing, usage analysis or post-incident forensic discovery.</p>
|
||||
<p><strong>* WARNING *</strong>
|
||||
All strings are recorded and stored in plaintext. This includes those strings
|
||||
which might contain sensitive data (create, connect, @password). These commands
|
||||
have their arguments masked by default, but you must mask or mask any
|
||||
custom commands of your own that handle sensitive information.</p>
|
||||
<p>See README.md for installation/configuration instructions.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.contrib.security.auditing.server.AuditedServerSession.audit">
|
||||
<code class="sig-name descname">audit</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/server.html#AuditedServerSession.audit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.server.AuditedServerSession.audit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Extracts messages and system data from a Session object upon message
|
||||
send or receive.</p>
|
||||
<dl>
|
||||
<dt>Kwargs:</dt><dd><p>src (str): Source of data; ‘client’ or ‘server’. Indicates direction.
|
||||
text (str or list): Client sends messages to server in the form of</p>
|
||||
<blockquote>
|
||||
<div><p>lists. Server sends messages to client as string.</p>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><dl class="simple">
|
||||
<dt>Dictionary object containing parsed system and user data</dt><dd><p>related to this message.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>log (dict)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.contrib.security.auditing.server.AuditedServerSession.data_in">
|
||||
<code class="sig-name descname">data_in</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/server.html#AuditedServerSession.data_in"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.server.AuditedServerSession.data_in" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook for protocols to send incoming data to the engine.</p>
|
||||
<dl class="simple">
|
||||
<dt>Kwargs:</dt><dd><p>kwargs (any): Other data from the protocol.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.contrib.security.auditing.server.AuditedServerSession.data_out">
|
||||
<code class="sig-name descname">data_out</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/server.html#AuditedServerSession.data_out"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.server.AuditedServerSession.data_out" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generic hook for sending data out through the protocol.</p>
|
||||
<dl class="simple">
|
||||
<dt>Kwargs:</dt><dd><p>kwargs (any): Other data to the protocol.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.contrib.security.auditing.server.AuditedServerSession.mask">
|
||||
<code class="sig-name descname">mask</code><span class="sig-paren">(</span><em class="sig-param">msg</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/server.html#AuditedServerSession.mask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.server.AuditedServerSession.mask" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Masks potentially sensitive user information within messages before
|
||||
writing to log. Recording cleartext password attempts is bad policy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>msg</strong> (<em>str</em>) – Raw text string sent from client <-> server</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Text string with sensitive information masked out.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>msg (str)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.contrib.security.auditing.tests">
|
||||
<span id="evennia-contrib-security-auditing-tests-module"></span><h2>evennia.contrib.security.auditing.tests module<a class="headerlink" href="#module-evennia.contrib.security.auditing.tests" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Module containing the test cases for the Audit system.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.contrib.security.auditing.tests.AuditingTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.security.auditing.tests.</code><code class="sig-name descname">AuditingTest</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/tests.html#AuditingTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.tests.AuditingTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.contrib.security.auditing.tests.AuditingTest.test_audit">
|
||||
<code class="sig-name descname">test_audit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/tests.html#AuditingTest.test_audit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.tests.AuditingTest.test_audit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make sure the ‘audit’ function is returning a dictionary based on values
|
||||
parsed from the Session object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.contrib.security.auditing.tests.AuditingTest.test_mask">
|
||||
<code class="sig-name descname">test_mask</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/security/auditing/tests.html#AuditingTest.test_mask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.security.auditing.tests.AuditingTest.test_mask" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make sure the ‘mask’ function is properly masking potentially sensitive
|
||||
information from strings.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.contrib.security.auditing package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.contrib.security.auditing.outputs">evennia.contrib.security.auditing.outputs module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.contrib.security.auditing.server">evennia.contrib.security.auditing.server module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.contrib.security.auditing.tests">evennia.contrib.security.auditing.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.security.auditing.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.security.auditing.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.contrib.security.auditing.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.contrib.security.auditing.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
115
docs/versions/1.0-dev/api/evennia.contrib.security.html
Normal file
115
docs/versions/1.0-dev/api/evennia.contrib.security.html
Normal file
|
|
@ -0,0 +1,115 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.contrib.security package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.contrib.security">
|
||||
<span id="evennia-contrib-security-package"></span><h1>evennia.contrib.security package<a class="headerlink" href="#module-evennia.contrib.security" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.security.auditing.html">evennia.contrib.security.auditing package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.security.auditing.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.security.auditing.html#module-evennia.contrib.security.auditing.outputs">evennia.contrib.security.auditing.outputs module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.security.auditing.html#module-evennia.contrib.security.auditing.server">evennia.contrib.security.auditing.server module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.security.auditing.html#module-evennia.contrib.security.auditing.tests">evennia.contrib.security.auditing.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.contrib.security package</a><ul>
|
||||
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.security.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.security.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.contrib.security.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.contrib.security.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
5584
docs/versions/1.0-dev/api/evennia.contrib.turnbattle.html
Normal file
5584
docs/versions/1.0-dev/api/evennia.contrib.turnbattle.html
Normal file
File diff suppressed because it is too large
Load diff
1250
docs/versions/1.0-dev/api/evennia.contrib.tutorial_examples.html
Normal file
1250
docs/versions/1.0-dev/api/evennia.contrib.tutorial_examples.html
Normal file
File diff suppressed because it is too large
Load diff
2643
docs/versions/1.0-dev/api/evennia.contrib.tutorial_world.html
Normal file
2643
docs/versions/1.0-dev/api/evennia.contrib.tutorial_world.html
Normal file
File diff suppressed because it is too large
Load diff
290
docs/versions/1.0-dev/api/evennia.game_template.commands.html
Normal file
290
docs/versions/1.0-dev/api/evennia.game_template.commands.html
Normal file
|
|
@ -0,0 +1,290 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.game_template.commands package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.game_template.commands">
|
||||
<span id="evennia-game-template-commands-package"></span><h1>evennia.game_template.commands package<a class="headerlink" href="#module-evennia.game_template.commands" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.commands.command">
|
||||
<span id="evennia-game-template-commands-command-module"></span><h2>evennia.game_template.commands.command module<a class="headerlink" href="#module-evennia.game_template.commands.command" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Commands</p>
|
||||
<p>Commands describe the input the account can do to the game.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.game_template.commands.command.Command">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.game_template.commands.command.</code><code class="sig-name descname">Command</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/command.html#Command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.command.Command" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Inherit from this if you want to create your own command styles
|
||||
from scratch. Note that Evennia’s default commands inherits from
|
||||
MuxCommand instead.</p>
|
||||
<p>Note that the class’s <cite>__doc__</cite> string (this text) is
|
||||
used by Evennia to create the automatic help entry for
|
||||
the command, so make sure to document consistently here.</p>
|
||||
<p>Each Command implements the following methods, called
|
||||
in this order (only func() is actually required):</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><p>at_pre_cmd(): If this returns anything truthy, execution is aborted.</p></li>
|
||||
<li><dl class="simple">
|
||||
<dt>parse(): Should perform any extra parsing needed on self.args</dt><dd><p>and store the result on self.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><p>func(): Performs the actual work.</p></li>
|
||||
<li><dl class="simple">
|
||||
<dt>at_post_cmd(): Extra actions, often things done after</dt><dd><p>every command, like prompts.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.command.Command._keyaliases">
|
||||
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('command',)</em><a class="headerlink" href="#evennia.game_template.commands.command.Command._keyaliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.command.Command._matchset">
|
||||
<code class="sig-name descname">_matchset</code><em class="property"> = {'command'}</em><a class="headerlink" href="#evennia.game_template.commands.command.Command._matchset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.command.Command.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.game_template.commands.command.Command.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.command.Command.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.game_template.commands.command.Command.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.command.Command.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'command'</em><a class="headerlink" href="#evennia.game_template.commands.command.Command.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.command.Command.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.game_template.commands.command.Command.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.command.Command.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'tags': '', 'text': "\n Inherit from this if you want to create your own command styles\n from scratch. Note that Evennia's default commands inherits from\n MuxCommand instead.\n\n Note that the class's `__doc__` string (this text) is\n used by Evennia to create the automatic help entry for\n the command, so make sure to document consistently here.\n\n Each Command implements the following methods, called\n in this order (only func() is actually required):\n - at_pre_cmd(): If this returns anything truthy, execution is aborted.\n - parse(): Should perform any extra parsing needed on self.args\n and store the result on self.\n - func(): Performs the actual work.\n - at_post_cmd(): Extra actions, often things done after\n every command, like prompts.\n\n "}</em><a class="headerlink" href="#evennia.game_template.commands.command.Command.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.commands.default_cmdsets">
|
||||
<span id="evennia-game-template-commands-default-cmdsets-module"></span><h2>evennia.game_template.commands.default_cmdsets module<a class="headerlink" href="#module-evennia.game_template.commands.default_cmdsets" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Command sets</p>
|
||||
<p>All commands in the game must be grouped in a cmdset. A given command
|
||||
can be part of any number of cmdsets and cmdsets can be added/removed
|
||||
and merged onto entities at runtime.</p>
|
||||
<p>To create new commands to populate the cmdset, see
|
||||
<cite>commands/command.py</cite>.</p>
|
||||
<p>This module wraps the default command sets of Evennia; overloads them
|
||||
to add/remove commands from the default lineup. You can create your
|
||||
own cmdsets by inheriting from them or directly from <cite>evennia.CmdSet</cite>.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.AccountCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.game_template.commands.default_cmdsets.</code><code class="sig-name descname">AccountCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/default_cmdsets.html#AccountCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.AccountCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.html#evennia.commands.default.cmdset_account.AccountCmdSet" title="evennia.commands.default.cmdset_account.AccountCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_account.AccountCmdSet</span></code></a></p>
|
||||
<p>This is the cmdset available to the Account at all times. It is
|
||||
combined with the <cite>CharacterCmdSet</cite> when the Account puppets a
|
||||
Character. It holds game-account-specific commands, channel
|
||||
commands, etc.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.AccountCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/default_cmdsets.html#AccountCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.AccountCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Populates the cmdset</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.AccountCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultAccount'</em><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.AccountCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.AccountCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.game_template.commands.default_cmdsets.AccountCmdSet'</em><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.AccountCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.CharacterCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.game_template.commands.default_cmdsets.</code><code class="sig-name descname">CharacterCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/default_cmdsets.html#CharacterCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.CharacterCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.html#evennia.commands.default.cmdset_character.CharacterCmdSet" title="evennia.commands.default.cmdset_character.CharacterCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_character.CharacterCmdSet</span></code></a></p>
|
||||
<p>The <cite>CharacterCmdSet</cite> contains general in-game commands like <cite>look</cite>,
|
||||
<cite>get</cite>, etc available on in-game Character objects. It is merged with
|
||||
the <cite>AccountCmdSet</cite> when an Account puppets a Character.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.CharacterCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/default_cmdsets.html#CharacterCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.CharacterCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Populates the cmdset</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.CharacterCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.CharacterCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.CharacterCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.game_template.commands.default_cmdsets.CharacterCmdSet'</em><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.CharacterCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.SessionCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.game_template.commands.default_cmdsets.</code><code class="sig-name descname">SessionCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/default_cmdsets.html#SessionCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.SessionCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.html#evennia.commands.default.cmdset_session.SessionCmdSet" title="evennia.commands.default.cmdset_session.SessionCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_session.SessionCmdSet</span></code></a></p>
|
||||
<p>This cmdset is made available on Session level once logged in. It
|
||||
is empty by default.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.SessionCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/default_cmdsets.html#SessionCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.SessionCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the only method defined in a cmdset, called during
|
||||
its creation. It should populate the set with command instances.</p>
|
||||
<p>As and example we just add the empty base <cite>Command</cite> object.
|
||||
It prints some info.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.SessionCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultSession'</em><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.SessionCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.SessionCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.game_template.commands.default_cmdsets.SessionCmdSet'</em><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.SessionCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.game_template.commands.default_cmdsets.</code><code class="sig-name descname">UnloggedinCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/default_cmdsets.html#UnloggedinCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.html#evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet" title="evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet</span></code></a></p>
|
||||
<p>Command set available to the Session before being logged in. This
|
||||
holds commands like creating a new account, logging in, etc.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/commands/default_cmdsets.html#UnloggedinCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Populates the cmdset</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultUnloggedin'</em><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet'</em><a class="headerlink" href="#evennia.game_template.commands.default_cmdsets.UnloggedinCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.game_template.commands package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.commands.command">evennia.game_template.commands.command module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.commands.default_cmdsets">evennia.game_template.commands.default_cmdsets module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.game_template.commands.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.game_template.commands.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.game_template.commands.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.game_template.commands.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
163
docs/versions/1.0-dev/api/evennia.game_template.html
Normal file
163
docs/versions/1.0-dev/api/evennia.game_template.html
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.game_template package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.game_template">
|
||||
<span id="evennia-game-template-package"></span><h1>evennia.game_template package<a class="headerlink" href="#module-evennia.game_template" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This sub-package holds the template for creating a new game folder.
|
||||
The new game folder (when running evennia –init) is a copy of this
|
||||
folder.</p>
|
||||
<div class="section" id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.game_template.commands.html">evennia.game_template.commands package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.commands.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.commands.html#module-evennia.game_template.commands.command">evennia.game_template.commands.command module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.commands.html#module-evennia.game_template.commands.default_cmdsets">evennia.game_template.commands.default_cmdsets module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.game_template.server.html">evennia.game_template.server package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.game_template.server.conf.html">evennia.game_template.server.conf package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_initial_setup">evennia.game_template.server.conf.at_initial_setup module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_search">evennia.game_template.server.conf.at_search module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_server_startstop">evennia.game_template.server.conf.at_server_startstop module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.cmdparser">evennia.game_template.server.conf.cmdparser module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.connection_screens">evennia.game_template.server.conf.connection_screens module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.inlinefuncs">evennia.game_template.server.conf.inlinefuncs module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.inputfuncs">evennia.game_template.server.conf.inputfuncs module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.lockfuncs">evennia.game_template.server.conf.lockfuncs module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.mssp">evennia.game_template.server.conf.mssp module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.portal_services_plugins">evennia.game_template.server.conf.portal_services_plugins module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#evennia-game-template-server-conf-secret-settings-module">evennia.game_template.server.conf.secret_settings module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.server_services_plugins">evennia.game_template.server.conf.server_services_plugins module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.serversession">evennia.game_template.server.conf.serversession module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#evennia-game-template-server-conf-settings-module">evennia.game_template.server.conf.settings module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.web_plugins">evennia.game_template.server.conf.web_plugins module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.game_template.typeclasses.html">evennia.game_template.typeclasses package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.typeclasses.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-accounts-module">evennia.game_template.typeclasses.accounts module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-channels-module">evennia.game_template.typeclasses.channels module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-characters-module">evennia.game_template.typeclasses.characters module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-exits-module">evennia.game_template.typeclasses.exits module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-objects-module">evennia.game_template.typeclasses.objects module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-rooms-module">evennia.game_template.typeclasses.rooms module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-scripts-module">evennia.game_template.typeclasses.scripts module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.game_template.web.html">evennia.game_template.web package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.web.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.web.html#module-evennia.game_template.web.urls">evennia.game_template.web.urls module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.game_template.world.html">evennia.game_template.world package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.world.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.world.html#module-evennia.game_template.world.prototypes">evennia.game_template.world.prototypes module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.game_template package</a><ul>
|
||||
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.game_template.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.game_template.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.game_template.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.game_template.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
554
docs/versions/1.0-dev/api/evennia.game_template.server.conf.html
Normal file
554
docs/versions/1.0-dev/api/evennia.game_template.server.conf.html
Normal file
|
|
@ -0,0 +1,554 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.game_template.server.conf package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.game_template.server.conf">
|
||||
<span id="evennia-game-template-server-conf-package"></span><h1>evennia.game_template.server.conf package<a class="headerlink" href="#module-evennia.game_template.server.conf" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.at_initial_setup">
|
||||
<span id="evennia-game-template-server-conf-at-initial-setup-module"></span><h2>evennia.game_template.server.conf.at_initial_setup module<a class="headerlink" href="#module-evennia.game_template.server.conf.at_initial_setup" title="Permalink to this headline">¶</a></h2>
|
||||
<p>At_initial_setup module template</p>
|
||||
<p>Custom at_initial_setup method. This allows you to hook special
|
||||
modifications to the initial server startup process. Note that this
|
||||
will only be run once - when the server starts up for the very first
|
||||
time! It is called last in the startup process and can thus be used to
|
||||
overload things that happened before it.</p>
|
||||
<p>The module must contain a global function at_initial_setup(). This
|
||||
will be called without arguments. Note that tracebacks in this module
|
||||
will be QUIETLY ignored, so make sure to check it well to make sure it
|
||||
does what you expect it to.</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.at_initial_setup.at_initial_setup">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.at_initial_setup.</code><code class="sig-name descname">at_initial_setup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/at_initial_setup.html#at_initial_setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.at_initial_setup.at_initial_setup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.at_search">
|
||||
<span id="evennia-game-template-server-conf-at-search-module"></span><h2>evennia.game_template.server.conf.at_search module<a class="headerlink" href="#module-evennia.game_template.server.conf.at_search" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Search and multimatch handling</p>
|
||||
<p>This module allows for overloading two functions used by Evennia’s
|
||||
search functionality:</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>at_search_result:</dt><dd><p>This is called whenever a result is returned from an object
|
||||
search (a common operation in commands). It should (together
|
||||
with at_multimatch_input below) define some way to present and
|
||||
differentiate between multiple matches (by default these are
|
||||
presented as 1-ball, 2-ball etc)</p>
|
||||
</dd>
|
||||
<dt>at_multimatch_input:</dt><dd><p>This is called with a search term and should be able to
|
||||
identify if the user wants to separate a multimatch-result
|
||||
(such as that from a previous search). By default, this
|
||||
function understands input on the form 1-ball, 2-ball etc as
|
||||
indicating that the 1st or 2nd match for “ball” should be
|
||||
used.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<p>This module is not called by default, to use it, add the following
|
||||
line to your settings file:</p>
|
||||
<blockquote>
|
||||
<div><p>SEARCH_AT_RESULT = “server.conf.at_search.at_search_result”</p>
|
||||
</div></blockquote>
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.at_search.at_search_result">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.at_search.</code><code class="sig-name descname">at_search_result</code><span class="sig-paren">(</span><em class="sig-param">matches</em>, <em class="sig-param">caller</em>, <em class="sig-param">query=''</em>, <em class="sig-param">quiet=False</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/at_search.html#at_search_result"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.at_search.at_search_result" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is a generic hook for handling all processing of a search
|
||||
result, including error reporting.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>matches</strong> (<em>list</em>) – This is a list of 0, 1 or more typeclass instances,
|
||||
the matched result of the search. If 0, a nomatch error should
|
||||
be echoed, and if >1, multimatch errors should be given. Only
|
||||
if a single match should the result pass through.</p></li>
|
||||
<li><p><strong>caller</strong> (<em>Object</em>) – The object performing the search and/or which should</p></li>
|
||||
<li><p><strong>error messages.</strong> (<em>receive</em>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>query (str, optional): The search query used to produce <cite>matches</cite>.</dt><dd><dl class="simple">
|
||||
<dt>quiet (bool, optional): If <cite>True</cite>, no messages will be echoed to caller</dt><dd><p>on errors.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Kwargs:</dt><dd><p>nofound_string (str): Replacement string to echo on a notfound error.
|
||||
multimatch_string (str): Replacement string to echo on a multimatch error.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><dl class="simple">
|
||||
<dt>This is always a single result</dt><dd><p>or <cite>None</cite>. If <cite>None</cite>, any error reporting/handling should
|
||||
already have happened.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>processed_result (Object or None)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.at_server_startstop">
|
||||
<span id="evennia-game-template-server-conf-at-server-startstop-module"></span><h2>evennia.game_template.server.conf.at_server_startstop module<a class="headerlink" href="#module-evennia.game_template.server.conf.at_server_startstop" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Server startstop hooks</p>
|
||||
<p>This module contains functions called by Evennia at various
|
||||
points during its startup, reload and shutdown sequence. It
|
||||
allows for customizing the server operation as desired.</p>
|
||||
<p>This module must contain at least these global functions:</p>
|
||||
<p>at_server_start()
|
||||
at_server_stop()
|
||||
at_server_reload_start()
|
||||
at_server_reload_stop()
|
||||
at_server_cold_start()
|
||||
at_server_cold_stop()</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.at_server_startstop.at_server_cold_start">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.at_server_startstop.</code><code class="sig-name descname">at_server_cold_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/at_server_startstop.html#at_server_cold_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.at_server_startstop.at_server_cold_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called only when the server starts “cold”, i.e. after a
|
||||
shutdown or a reset.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.at_server_startstop.at_server_cold_stop">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.at_server_startstop.</code><code class="sig-name descname">at_server_cold_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/at_server_startstop.html#at_server_cold_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.at_server_startstop.at_server_cold_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called only when the server goes down due to a shutdown or
|
||||
reset.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.at_server_startstop.at_server_reload_start">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.at_server_startstop.</code><code class="sig-name descname">at_server_reload_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/at_server_startstop.html#at_server_reload_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.at_server_startstop.at_server_reload_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called only when server starts back up after a reload.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.at_server_startstop.at_server_reload_stop">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.at_server_startstop.</code><code class="sig-name descname">at_server_reload_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/at_server_startstop.html#at_server_reload_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.at_server_startstop.at_server_reload_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called only time the server stops before a reload.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.at_server_startstop.at_server_start">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.at_server_startstop.</code><code class="sig-name descname">at_server_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/at_server_startstop.html#at_server_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.at_server_startstop.at_server_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called every time the server starts up, regardless of
|
||||
how it was shut down.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.at_server_startstop.at_server_stop">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.at_server_startstop.</code><code class="sig-name descname">at_server_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/at_server_startstop.html#at_server_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.at_server_startstop.at_server_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called just before the server is shut down, regardless
|
||||
of it is for a reload, reset or shutdown.</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.cmdparser">
|
||||
<span id="evennia-game-template-server-conf-cmdparser-module"></span><h2>evennia.game_template.server.conf.cmdparser module<a class="headerlink" href="#module-evennia.game_template.server.conf.cmdparser" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Changing the default command parser</p>
|
||||
<p>The cmdparser is responsible for parsing the raw text inserted by the
|
||||
user, identifying which command/commands match and return one or more
|
||||
matching command objects. It is called by Evennia’s cmdhandler and
|
||||
must accept input and return results on the same form. The default
|
||||
handler is very generic so you usually don’t need to overload this
|
||||
unless you have very exotic parsing needs; advanced parsing is best
|
||||
done at the Command.parse level.</p>
|
||||
<p>The default cmdparser understands the following command combinations
|
||||
(where [] marks optional parts.)</p>
|
||||
<p>[cmdname[ cmdname2 cmdname3 …] [the rest]</p>
|
||||
<p>A command may consist of any number of space-separated words of any
|
||||
length, and contain any character. It may also be empty.</p>
|
||||
<p>The parser makes use of the cmdset to find command candidates. The
|
||||
parser return a list of matches. Each match is a tuple with its first
|
||||
three elements being the parsed cmdname (lower case), the remaining
|
||||
arguments, and the matched cmdobject from the cmdset.</p>
|
||||
<p>This module is not accessed by default. To tell Evennia to use it
|
||||
instead of the default command parser, add the following line to
|
||||
your settings file:</p>
|
||||
<blockquote>
|
||||
<div><p>COMMAND_PARSER = “server.conf.cmdparser.cmdparser”</p>
|
||||
</div></blockquote>
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.cmdparser.cmdparser">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.cmdparser.</code><code class="sig-name descname">cmdparser</code><span class="sig-paren">(</span><em class="sig-param">raw_string</em>, <em class="sig-param">cmdset</em>, <em class="sig-param">caller</em>, <em class="sig-param">match_index=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/cmdparser.html#cmdparser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.cmdparser.cmdparser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This function is called by the cmdhandler once it has
|
||||
gathered and merged all valid cmdsets valid for this particular parsing.</p>
|
||||
<p>raw_string - the unparsed text entered by the caller.
|
||||
cmdset - the merged, currently valid cmdset
|
||||
caller - the caller triggering this parsing
|
||||
match_index - an optional integer index to pick a given match in a</p>
|
||||
<blockquote>
|
||||
<div><p>list of same-named command matches.</p>
|
||||
</div></blockquote>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><dl class="simple">
|
||||
<dt>[(cmdname, args, cmdobj, cmdlen, mratio), …]</dt><dd><p>where cmdname is the matching command name and args is
|
||||
everything not included in the cmdname. Cmdobj is the actual
|
||||
command instance taken from the cmdset, cmdlen is the length
|
||||
of the command name and the mratio is some quality value to
|
||||
(possibly) separate multiple matches.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>list of tuples</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.connection_screens">
|
||||
<span id="evennia-game-template-server-conf-connection-screens-module"></span><h2>evennia.game_template.server.conf.connection_screens module<a class="headerlink" href="#module-evennia.game_template.server.conf.connection_screens" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Connection screen</p>
|
||||
<p>This is the text to show the user when they first connect to the game (before
|
||||
they log in).</p>
|
||||
<p>To change the login screen in this module, do one of the following:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Define a function <cite>connection_screen()</cite>, taking no arguments. This will be
|
||||
called first and must return the full string to act as the connection screen.
|
||||
This can be used to produce more dynamic screens.</p></li>
|
||||
<li><p>Alternatively, define a string variable in the outermost scope of this module
|
||||
with the connection string that should be displayed. If more than one such
|
||||
variable is given, Evennia will pick one of them at random.</p></li>
|
||||
</ul>
|
||||
<p>The commands available to the user when the connection screen is shown
|
||||
are defined in evennia.default_cmds.UnloggedinCmdSet. The parsing and display
|
||||
of the screen is done by the unlogged-in “look” command.</p>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.inlinefuncs">
|
||||
<span id="evennia-game-template-server-conf-inlinefuncs-module"></span><h2>evennia.game_template.server.conf.inlinefuncs module<a class="headerlink" href="#module-evennia.game_template.server.conf.inlinefuncs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Inlinefunc</p>
|
||||
<p>Inline functions allow for direct conversion of text users mark in a
|
||||
special way. Inlinefuncs are deactivated by default. To activate, add</p>
|
||||
<blockquote>
|
||||
<div><p>INLINEFUNC_ENABLED = True</p>
|
||||
</div></blockquote>
|
||||
<p>to your settings file. The default inlinefuncs are found in
|
||||
evennia.utils.inlinefunc.</p>
|
||||
<p>In text, usage is straightforward:</p>
|
||||
<p>$funcname([arg1,[arg2,…]])</p>
|
||||
<dl class="simple">
|
||||
<dt>Example 1 (using the “pad” inlinefunc):</dt><dd><p>say This is $pad(“a center-padded text”, 50,c,-) of width 50.
|
||||
->
|
||||
John says, “This is ————– a center-padded text————— of width 50.”</p>
|
||||
</dd>
|
||||
<dt>Example 2 (using nested “pad” and “time” inlinefuncs):</dt><dd><p>say The time is $pad($time(), 30)right now.
|
||||
->
|
||||
John says, “The time is Oct 25, 11:09 right now.”</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>To add more inline functions, add them to this module, using
|
||||
the following call signature:</p>
|
||||
<blockquote>
|
||||
<div><p>def funcname(text, <a href="#id1"><span class="problematic" id="id2">*</span></a>args, <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs)</p>
|
||||
</div></blockquote>
|
||||
<p>where <cite>text</cite> is always the part between {funcname(args) and
|
||||
{/funcname and the <a href="#id5"><span class="problematic" id="id6">*</span></a>args are taken from the appropriate part of the
|
||||
call. If no {/funcname is given, <cite>text</cite> will be the empty string.</p>
|
||||
<p>It is important that the inline function properly clean the
|
||||
incoming <cite>args</cite>, checking their type and replacing them with sane
|
||||
defaults if needed. If impossible to resolve, the unmodified text
|
||||
should be returned. The inlinefunc should never cause a traceback.</p>
|
||||
<p>While the inline function should accept <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs, the keyword is
|
||||
never accepted as a valid call - this is only intended to be used
|
||||
internally by Evennia, notably to send the <cite>session</cite> keyword to
|
||||
the function; this is the session of the object viewing the string
|
||||
and can be used to customize it to each session.</p>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.inputfuncs">
|
||||
<span id="evennia-game-template-server-conf-inputfuncs-module"></span><h2>evennia.game_template.server.conf.inputfuncs module<a class="headerlink" href="#module-evennia.game_template.server.conf.inputfuncs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Input functions</p>
|
||||
<p>Input functions are always called from the client (they handle server
|
||||
input, hence the name).</p>
|
||||
<p>This module is loaded by being included in the
|
||||
<cite>settings.INPUT_FUNC_MODULES</cite> tuple.</p>
|
||||
<p>All <em>global functions</em> included in this module are considered
|
||||
input-handler functions and can be called by the client to handle
|
||||
input.</p>
|
||||
<p>An input function must have the following call signature:</p>
|
||||
<blockquote>
|
||||
<div><p>cmdname(session, <a href="#id9"><span class="problematic" id="id10">*</span></a>args, <a href="#id11"><span class="problematic" id="id12">**</span></a>kwargs)</p>
|
||||
</div></blockquote>
|
||||
<p>Where session will be the active session and <a href="#id13"><span class="problematic" id="id14">*</span></a>args, <a href="#id15"><span class="problematic" id="id16">**</span></a>kwargs are extra
|
||||
incoming arguments and keyword properties.</p>
|
||||
<p>A special command is the “default” command, which is will be called
|
||||
when no other cmdname matches. It also receives the non-found cmdname
|
||||
as argument.</p>
|
||||
<blockquote>
|
||||
<div><p>default(session, cmdname, <a href="#id17"><span class="problematic" id="id18">*</span></a>args, <a href="#id19"><span class="problematic" id="id20">**</span></a>kwargs)</p>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.lockfuncs">
|
||||
<span id="evennia-game-template-server-conf-lockfuncs-module"></span><h2>evennia.game_template.server.conf.lockfuncs module<a class="headerlink" href="#module-evennia.game_template.server.conf.lockfuncs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Lockfuncs</p>
|
||||
<p>Lock functions are functions available when defining lock strings,
|
||||
which in turn limits access to various game systems.</p>
|
||||
<p>All functions defined globally in this module are assumed to be
|
||||
available for use in lockstrings to determine access. See the
|
||||
Evennia documentation for more info on locks.</p>
|
||||
<p>A lock function is always called with two arguments, accessing_obj and
|
||||
accessed_obj, followed by any number of arguments. All possible
|
||||
arguments should be handled with <a href="#id21"><span class="problematic" id="id22">*</span></a>args, <a href="#id23"><span class="problematic" id="id24">**</span></a>kwargs. The lock function
|
||||
should handle all eventual tracebacks by logging the error and
|
||||
returning False.</p>
|
||||
<p>Lock functions in this module extend (and will overload same-named)
|
||||
lock functions from evennia.locks.lockfuncs.</p>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.mssp">
|
||||
<span id="evennia-game-template-server-conf-mssp-module"></span><h2>evennia.game_template.server.conf.mssp module<a class="headerlink" href="#module-evennia.game_template.server.conf.mssp" title="Permalink to this headline">¶</a></h2>
|
||||
<p>MSSP (Mud Server Status Protocol) meta information</p>
|
||||
<p>Modify this file to specify what MUD listing sites will report about your game.
|
||||
All fields are static. The number of currently active players and your game’s
|
||||
current uptime will be added automatically by Evennia.</p>
|
||||
<p>You don’t have to fill in everything (and most fields are not shown/used by all
|
||||
crawlers anyway); leave the default if so needed. You need to reload the server
|
||||
before the updated information is made available to crawlers (reloading does
|
||||
not affect uptime).</p>
|
||||
<p>After changing the values in this file, you must register your game with the
|
||||
MUD website list you want to track you. The listing crawler will then regularly
|
||||
connect to your server to get the latest info. No further configuration is
|
||||
needed on the Evennia side.</p>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.portal_services_plugins">
|
||||
<span id="evennia-game-template-server-conf-portal-services-plugins-module"></span><h2>evennia.game_template.server.conf.portal_services_plugins module<a class="headerlink" href="#module-evennia.game_template.server.conf.portal_services_plugins" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Start plugin services</p>
|
||||
<p>This plugin module can define user-created services for the Portal to
|
||||
start.</p>
|
||||
<p>This module must handle all imports and setups required to start
|
||||
twisted services (see examples in evennia.server.portal.portal). It
|
||||
must also contain a function start_plugin_services(application).
|
||||
Evennia will call this function with the main Portal application (so
|
||||
your services can be added to it). The function should not return
|
||||
anything. Plugin services are started last in the Portal startup
|
||||
process.</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.portal_services_plugins.start_plugin_services">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.portal_services_plugins.</code><code class="sig-name descname">start_plugin_services</code><span class="sig-paren">(</span><em class="sig-param">portal</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/portal_services_plugins.html#start_plugin_services"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.portal_services_plugins.start_plugin_services" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This hook is called by Evennia, last in the Portal startup process.</p>
|
||||
<p>portal - a reference to the main portal application.</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-server-conf-secret-settings-module">
|
||||
<h2>evennia.game_template.server.conf.secret_settings module<a class="headerlink" href="#evennia-game-template-server-conf-secret-settings-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.server_services_plugins">
|
||||
<span id="evennia-game-template-server-conf-server-services-plugins-module"></span><h2>evennia.game_template.server.conf.server_services_plugins module<a class="headerlink" href="#module-evennia.game_template.server.conf.server_services_plugins" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Server plugin services</p>
|
||||
<p>This plugin module can define user-created services for the Server to
|
||||
start.</p>
|
||||
<p>This module must handle all imports and setups required to start a
|
||||
twisted service (see examples in evennia.server.server). It must also
|
||||
contain a function start_plugin_services(application). Evennia will
|
||||
call this function with the main Server application (so your services
|
||||
can be added to it). The function should not return anything. Plugin
|
||||
services are started last in the Server startup process.</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.server_services_plugins.start_plugin_services">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.server_services_plugins.</code><code class="sig-name descname">start_plugin_services</code><span class="sig-paren">(</span><em class="sig-param">server</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/server_services_plugins.html#start_plugin_services"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.server_services_plugins.start_plugin_services" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This hook is called by Evennia, last in the Server startup process.</p>
|
||||
<p>server - a reference to the main server application.</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.serversession">
|
||||
<span id="evennia-game-template-server-conf-serversession-module"></span><h2>evennia.game_template.server.conf.serversession module<a class="headerlink" href="#module-evennia.game_template.server.conf.serversession" title="Permalink to this headline">¶</a></h2>
|
||||
<p>ServerSession</p>
|
||||
<p>The serversession is the Server-side in-memory representation of a
|
||||
user connecting to the game. Evennia manages one Session per
|
||||
connection to the game. So a user logged into the game with multiple
|
||||
clients (if Evennia is configured to allow that) will have multiple
|
||||
sessions tied to one Account object. All communication between Evennia
|
||||
and the real-world user goes through the Session(s) associated with that user.</p>
|
||||
<p>It should be noted that modifying the Session object is not usually
|
||||
necessary except for the most custom and exotic designs - and even
|
||||
then it might be enough to just add custom session-level commands to
|
||||
the SessionCmdSet instead.</p>
|
||||
<p>This module is not normally called. To tell Evennia to use the class
|
||||
in this module instead of the default one, add the following to your
|
||||
settings file:</p>
|
||||
<blockquote>
|
||||
<div><p>SERVER_SESSION_CLASS = “server.conf.serversession.ServerSession”</p>
|
||||
</div></blockquote>
|
||||
<dl class="class">
|
||||
<dt id="evennia.game_template.server.conf.serversession.ServerSession">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.game_template.server.conf.serversession.</code><code class="sig-name descname">ServerSession</code><a class="reference internal" href="../_modules/evennia/game_template/server/conf/serversession.html#ServerSession"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.serversession.ServerSession" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.server.html#evennia.server.serversession.ServerSession" title="evennia.server.serversession.ServerSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.server.serversession.ServerSession</span></code></a></p>
|
||||
<p>This class represents a player’s session and is a template for
|
||||
individual protocols to communicate with Evennia.</p>
|
||||
<p>Each account gets one or more sessions assigned to them whenever they connect
|
||||
to the game server. All communication between game and account goes
|
||||
through their session(s).</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-server-conf-settings-module">
|
||||
<h2>evennia.game_template.server.conf.settings module<a class="headerlink" href="#evennia-game-template-server-conf-settings-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.server.conf.web_plugins">
|
||||
<span id="evennia-game-template-server-conf-web-plugins-module"></span><h2>evennia.game_template.server.conf.web_plugins module<a class="headerlink" href="#module-evennia.game_template.server.conf.web_plugins" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Web plugin hooks.</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.web_plugins.at_webproxy_root_creation">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.web_plugins.</code><code class="sig-name descname">at_webproxy_root_creation</code><span class="sig-paren">(</span><em class="sig-param">web_root</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/web_plugins.html#at_webproxy_root_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.web_plugins.at_webproxy_root_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This function can modify the portal proxy service.
|
||||
:param web_root: The Evennia</p>
|
||||
<blockquote>
|
||||
<div><p>Website application. Use .putChild() to add new
|
||||
subdomains that are Portal-accessible over TCP;
|
||||
primarily for new protocol development, but suitable
|
||||
for other shenanigans.</p>
|
||||
</div></blockquote>
|
||||
<dl class="field-list simple">
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.game_template.server.conf.web_plugins.at_webserver_root_creation">
|
||||
<code class="sig-prename descclassname">evennia.game_template.server.conf.web_plugins.</code><code class="sig-name descname">at_webserver_root_creation</code><span class="sig-paren">(</span><em class="sig-param">web_root</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/game_template/server/conf/web_plugins.html#at_webserver_root_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.game_template.server.conf.web_plugins.at_webserver_root_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called as the web server has finished building its default
|
||||
path tree. At this point, the media/ and static/ URIs have already
|
||||
been added to the web root.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>web_root</strong> (<em>twisted.web.resource.Resource</em>) – The root
|
||||
resource of the URI tree. Use .putChild() to
|
||||
add new subdomains to the tree.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><dl class="simple">
|
||||
<dt>The potentially</dt><dd><p>modified root structure.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>web_root (twisted.web.resource.Resource)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Example</p>
|
||||
<p>from twisted.web import static
|
||||
my_page = static.File(“web/mypage/”)
|
||||
my_page.indexNames = [“index.html”]
|
||||
web_root.putChild(“mypage”, my_page)</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.game_template.server.conf package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.at_initial_setup">evennia.game_template.server.conf.at_initial_setup module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.at_search">evennia.game_template.server.conf.at_search module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.at_server_startstop">evennia.game_template.server.conf.at_server_startstop module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.cmdparser">evennia.game_template.server.conf.cmdparser module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.connection_screens">evennia.game_template.server.conf.connection_screens module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.inlinefuncs">evennia.game_template.server.conf.inlinefuncs module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.inputfuncs">evennia.game_template.server.conf.inputfuncs module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.lockfuncs">evennia.game_template.server.conf.lockfuncs module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.mssp">evennia.game_template.server.conf.mssp module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.portal_services_plugins">evennia.game_template.server.conf.portal_services_plugins module</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-server-conf-secret-settings-module">evennia.game_template.server.conf.secret_settings module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.server_services_plugins">evennia.game_template.server.conf.server_services_plugins module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.serversession">evennia.game_template.server.conf.serversession module</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-server-conf-settings-module">evennia.game_template.server.conf.settings module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.server.conf.web_plugins">evennia.game_template.server.conf.web_plugins module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.game_template.server.conf.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.game_template.server.conf.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.game_template.server.conf.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.game_template.server.conf.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
127
docs/versions/1.0-dev/api/evennia.game_template.server.html
Normal file
127
docs/versions/1.0-dev/api/evennia.game_template.server.html
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.game_template.server package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.game_template.server">
|
||||
<span id="evennia-game-template-server-package"></span><h1>evennia.game_template.server package<a class="headerlink" href="#module-evennia.game_template.server" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.game_template.server.conf.html">evennia.game_template.server.conf package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_initial_setup">evennia.game_template.server.conf.at_initial_setup module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_search">evennia.game_template.server.conf.at_search module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_server_startstop">evennia.game_template.server.conf.at_server_startstop module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.cmdparser">evennia.game_template.server.conf.cmdparser module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.connection_screens">evennia.game_template.server.conf.connection_screens module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.inlinefuncs">evennia.game_template.server.conf.inlinefuncs module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.inputfuncs">evennia.game_template.server.conf.inputfuncs module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.lockfuncs">evennia.game_template.server.conf.lockfuncs module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.mssp">evennia.game_template.server.conf.mssp module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.portal_services_plugins">evennia.game_template.server.conf.portal_services_plugins module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#evennia-game-template-server-conf-secret-settings-module">evennia.game_template.server.conf.secret_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.server_services_plugins">evennia.game_template.server.conf.server_services_plugins module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.serversession">evennia.game_template.server.conf.serversession module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#evennia-game-template-server-conf-settings-module">evennia.game_template.server.conf.settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.web_plugins">evennia.game_template.server.conf.web_plugins module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.game_template.server package</a><ul>
|
||||
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.game_template.server.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.game_template.server.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.game_template.server.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.game_template.server.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
132
docs/versions/1.0-dev/api/evennia.game_template.typeclasses.html
Normal file
132
docs/versions/1.0-dev/api/evennia.game_template.typeclasses.html
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.game_template.typeclasses package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.game_template.typeclasses">
|
||||
<span id="evennia-game-template-typeclasses-package"></span><h1>evennia.game_template.typeclasses package<a class="headerlink" href="#module-evennia.game_template.typeclasses" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-typeclasses-accounts-module">
|
||||
<h2>evennia.game_template.typeclasses.accounts module<a class="headerlink" href="#evennia-game-template-typeclasses-accounts-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-typeclasses-channels-module">
|
||||
<h2>evennia.game_template.typeclasses.channels module<a class="headerlink" href="#evennia-game-template-typeclasses-channels-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-typeclasses-characters-module">
|
||||
<h2>evennia.game_template.typeclasses.characters module<a class="headerlink" href="#evennia-game-template-typeclasses-characters-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-typeclasses-exits-module">
|
||||
<h2>evennia.game_template.typeclasses.exits module<a class="headerlink" href="#evennia-game-template-typeclasses-exits-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-typeclasses-objects-module">
|
||||
<h2>evennia.game_template.typeclasses.objects module<a class="headerlink" href="#evennia-game-template-typeclasses-objects-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-typeclasses-rooms-module">
|
||||
<h2>evennia.game_template.typeclasses.rooms module<a class="headerlink" href="#evennia-game-template-typeclasses-rooms-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="evennia-game-template-typeclasses-scripts-module">
|
||||
<h2>evennia.game_template.typeclasses.scripts module<a class="headerlink" href="#evennia-game-template-typeclasses-scripts-module" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.game_template.typeclasses package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-typeclasses-accounts-module">evennia.game_template.typeclasses.accounts module</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-typeclasses-channels-module">evennia.game_template.typeclasses.channels module</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-typeclasses-characters-module">evennia.game_template.typeclasses.characters module</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-typeclasses-exits-module">evennia.game_template.typeclasses.exits module</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-typeclasses-objects-module">evennia.game_template.typeclasses.objects module</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-typeclasses-rooms-module">evennia.game_template.typeclasses.rooms module</a></li>
|
||||
<li><a class="reference internal" href="#evennia-game-template-typeclasses-scripts-module">evennia.game_template.typeclasses.scripts module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.game_template.typeclasses.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.game_template.typeclasses.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.game_template.typeclasses.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.game_template.typeclasses.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
111
docs/versions/1.0-dev/api/evennia.game_template.web.html
Normal file
111
docs/versions/1.0-dev/api/evennia.game_template.web.html
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.game_template.web package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.game_template.web">
|
||||
<span id="evennia-game-template-web-package"></span><h1>evennia.game_template.web package<a class="headerlink" href="#module-evennia.game_template.web" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.web.urls">
|
||||
<span id="evennia-game-template-web-urls-module"></span><h2>evennia.game_template.web.urls module<a class="headerlink" href="#module-evennia.game_template.web.urls" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Url definition file to redistribute incoming URL requests to django
|
||||
views. Search the Django documentation for “URL dispatcher” for more
|
||||
help.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.game_template.web package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.web.urls">evennia.game_template.web.urls module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.game_template.web.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.game_template.web.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.game_template.web.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.game_template.web.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
138
docs/versions/1.0-dev/api/evennia.game_template.world.html
Normal file
138
docs/versions/1.0-dev/api/evennia.game_template.world.html
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.game_template.world package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.game_template.world">
|
||||
<span id="evennia-game-template-world-package"></span><h1>evennia.game_template.world package<a class="headerlink" href="#module-evennia.game_template.world" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.game_template.world.prototypes">
|
||||
<span id="evennia-game-template-world-prototypes-module"></span><h2>evennia.game_template.world.prototypes module<a class="headerlink" href="#module-evennia.game_template.world.prototypes" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Prototypes</p>
|
||||
<p>A prototype is a simple way to create individualized instances of a
|
||||
given <cite>Typeclass</cite>. For example, you might have a Sword typeclass that
|
||||
implements everything a Sword would need to do. The only difference
|
||||
between different individual Swords would be their key, description
|
||||
and some Attributes. The Prototype system allows to create a range of
|
||||
such Swords with only minor variations. Prototypes can also inherit
|
||||
and combine together to form entire hierarchies (such as giving all
|
||||
Sabres and all Broadswords some common properties). Note that bigger
|
||||
variations, such as custom commands or functionality belong in a
|
||||
hierarchy of typeclasses instead.</p>
|
||||
<p>Example prototypes are read by the <cite>@spawn</cite> command but is also easily
|
||||
available to use from code via <cite>evennia.spawn</cite> or <cite>evennia.utils.spawner</cite>.
|
||||
Each prototype should be a dictionary. Use the same name as the
|
||||
variable to refer to other prototypes.</p>
|
||||
<dl>
|
||||
<dt>Possible keywords are:</dt><dd><p>prototype_parent - string pointing to parent prototype of this structure.
|
||||
key - string, the main object identifier.
|
||||
typeclass - string, if not set, will use <cite>settings.BASE_OBJECT_TYPECLASS</cite>.
|
||||
location - this should be a valid object or #dbref.
|
||||
home - valid object or #dbref.
|
||||
destination - only valid for exits (object or dbref).</p>
|
||||
<p>permissions - string or list of permission strings.
|
||||
locks - a lock-string.
|
||||
aliases - string or list of strings.</p>
|
||||
<p>ndb_<name> - value of a nattribute (the “<a href="#id1"><span class="problematic" id="id2">ndb_</span></a>” part is ignored).
|
||||
any other keywords are interpreted as Attributes and their values.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>See the <cite>@spawn</cite> command and <cite>evennia.utils.spawner</cite> for more info.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.game_template.world package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.game_template.world.prototypes">evennia.game_template.world.prototypes module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.game_template.world.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.game_template.world.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.game_template.world.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.game_template.world.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
745
docs/versions/1.0-dev/api/evennia.help.html
Normal file
745
docs/versions/1.0-dev/api/evennia.help.html
Normal file
|
|
@ -0,0 +1,745 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.help package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.help">
|
||||
<span id="evennia-help-package"></span><h1>evennia.help package<a class="headerlink" href="#module-evennia.help" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This sub-package defines the help system of Evennia. It is pretty
|
||||
simple, mainly consisting of a database model to hold help entries.
|
||||
The auto-cmd-help is rather handled by the default ‘help’ command
|
||||
itself.</p>
|
||||
<div class="section" id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.help.admin">
|
||||
<span id="evennia-help-admin-module"></span><h2>evennia.help.admin module<a class="headerlink" href="#module-evennia.help.admin" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This defines how to edit help entries in Admin.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.help.admin.</code><code class="sig-name descname">HelpEntryAdmin</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">admin_site</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpEntryAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.admin.options.ModelAdmin</span></code></p>
|
||||
<p>Sets up the admin manaager for help entries</p>
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_help_category'), 'db_entrytext', 'db_lock_storage'), 'description': 'Sets a Help entry. Set lock to <i>view:all()</I> unless you want to restrict it.'}),)</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.help.admin.HelpEntryForm" title="evennia.help.admin.HelpEntryForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">HelpEntryForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.help.admin.HelpTagInline'>]</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_help_category', 'db_lock_storage')</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['db_help_category', 'db_key']</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['^db_key', 'db_entrytext']</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.help.admin.HelpEntryForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.help.admin.</code><code class="sig-name descname">HelpEntryForm</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">files=None</em>, <em class="sig-param">auto_id='id_%s'</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">initial=None</em>, <em class="sig-param">error_class=<class 'django.forms.utils.ErrorList'></em>, <em class="sig-param">label_suffix=None</em>, <em class="sig-param">empty_permitted=False</em>, <em class="sig-param">instance=None</em>, <em class="sig-param">use_required_attribute=None</em>, <em class="sig-param">renderer=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpEntryForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpEntryForm" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.forms.models.ModelForm</span></code></p>
|
||||
<p>Defines how to display the help entry</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.help.admin.HelpEntryForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpEntryForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.Meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.help.models.HelpEntry" title="evennia.help.models.HelpEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.help.models.HelpEntry</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryForm._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <django.forms.models.ModelFormOptions object></em><a class="headerlink" href="#evennia.help.admin.HelpEntryForm._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_entrytext': <django.forms.fields.CharField object>, 'db_help_category': <django.forms.fields.CharField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_staff_only': <django.forms.fields.BooleanField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>}</em><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpEntryForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_help_category': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.admin.HelpEntryForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.help.admin.HelpTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.help.admin.</code><code class="sig-name descname">HelpTagInline</code><span class="sig-paren">(</span><em class="sig-param">parent_model</em>, <em class="sig-param">admin_site</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.html#evennia.typeclasses.admin.TagInline" title="evennia.typeclasses.admin.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.admin.TagInline</span></code></a></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.admin.HelpTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.help.admin.HelpTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.help.admin.HelpTagInline.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.help.models.HelpEntry_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.admin.HelpTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'helpentry'</em><a class="headerlink" href="#evennia.help.admin.HelpTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.help.manager">
|
||||
<span id="evennia-help-manager-module"></span><h2>evennia.help.manager module<a class="headerlink" href="#module-evennia.help.manager" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Custom manager for HelpEntry objects.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.help.manager.HelpEntryManager">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.help.manager.</code><code class="sig-name descname">HelpEntryManager</code><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.html#evennia.typeclasses.managers.TypedObjectManager" title="evennia.typeclasses.managers.TypedObjectManager"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.managers.TypedObjectManager</span></code></a></p>
|
||||
<p>This HelpEntryManager implements methods for searching
|
||||
and manipulating HelpEntries directly from the database.</p>
|
||||
<p>These methods will all return database objects
|
||||
(or QuerySets) directly.</p>
|
||||
<p>Evennia-specific:
|
||||
find_topicmatch
|
||||
find_apropos
|
||||
find_topicsuggestions
|
||||
find_topics_with_category
|
||||
all_to_category
|
||||
search_help (equivalent to evennia.search_helpentry)</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.manager.HelpEntryManager.all_to_category">
|
||||
<code class="sig-name descname">all_to_category</code><span class="sig-paren">(</span><em class="sig-param">default_category</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.all_to_category"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.all_to_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Shifts all help entries in database to default_category. This
|
||||
action cannot be reverted. It is used primarily by the engine
|
||||
when importing a default help database, making sure this ends
|
||||
up in one easily separated category.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>default_category</strong> (<em>str</em>) – Category to move entries to.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.manager.HelpEntryManager.find_apropos">
|
||||
<code class="sig-name descname">find_apropos</code><span class="sig-paren">(</span><em class="sig-param">topicstr</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.find_apropos"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.find_apropos" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do a very loose search, returning all help entries containing
|
||||
the search criterion in their titles.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>topicstr</strong> (<em>str</em>) – Search criterion.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Query results.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>matches (HelpEntries)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.manager.HelpEntryManager.find_topicmatch">
|
||||
<code class="sig-name descname">find_topicmatch</code><span class="sig-paren">(</span><em class="sig-param">topicstr</em>, <em class="sig-param">exact=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topicmatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.find_topicmatch" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Searches for matching topics or aliases based on player’s
|
||||
input.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>topcistr</strong> (<em>str</em>) – Help topic to search for.</p></li>
|
||||
<li><p><strong>exact</strong> (<em>bool</em><em>, </em><em>optional</em>) – Require exact match
|
||||
(non-case-sensitive). If <cite>False</cite> (default), match
|
||||
sub-parts of the string.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Query results.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>matches (HelpEntries)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.manager.HelpEntryManager.find_topics_with_category">
|
||||
<code class="sig-name descname">find_topics_with_category</code><span class="sig-paren">(</span><em class="sig-param">help_category</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topics_with_category"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.find_topics_with_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Search topics having a particular category.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>help_category</strong> (<em>str</em>) – Category query criterion.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Query results.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>matches (HelpEntries)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.manager.HelpEntryManager.find_topicsuggestions">
|
||||
<code class="sig-name descname">find_topicsuggestions</code><span class="sig-paren">(</span><em class="sig-param">topicstr</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topicsuggestions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.find_topicsuggestions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do a fuzzy match, preferably within the category of the
|
||||
current topic.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>topicstr</strong> (<em>str</em>) – Search criterion.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Query results.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>matches (Helpentries)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.manager.HelpEntryManager.get_all_categories">
|
||||
<code class="sig-name descname">get_all_categories</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.get_all_categories"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.get_all_categories" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all defined category names with at least one topic in
|
||||
them.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><dl class="simple">
|
||||
<dt>Unique list of category names across all</dt><dd><p>topics.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>matches (list)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.manager.HelpEntryManager.get_all_topics">
|
||||
<code class="sig-name descname">get_all_topics</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.get_all_topics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.get_all_topics" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all topics.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>All topics.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>all (HelpEntries)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.manager.HelpEntryManager.search_help">
|
||||
<code class="sig-name descname">search_help</code><span class="sig-paren">(</span><em class="sig-param">ostring</em>, <em class="sig-param">help_category=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.search_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.search_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve a search entry object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>ostring</strong> (<em>str</em>) – The help topic to look for.</p></li>
|
||||
<li><p><strong>category</strong> (<em>str</em>) – Limit the search to a particular help topic</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.help.models">
|
||||
<span id="evennia-help-models-module"></span><h2>evennia.help.models module<a class="headerlink" href="#module-evennia.help.models" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Models for the help system.</p>
|
||||
<p>The database-tied help system is only half of Evennia’s help
|
||||
functionality, the other one being the auto-generated command help
|
||||
that is created on the fly from each command’s <cite>__doc__</cite> string. The
|
||||
persistent database system defined here is intended for all other
|
||||
forms of help that do not concern commands, like information about the
|
||||
game world, policy info, rules and similar.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.help.models.HelpEntry">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.help.models.</code><code class="sig-name descname">HelpEntry</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.idmapper.html#evennia.utils.idmapper.models.SharedMemoryModel" title="evennia.utils.idmapper.models.SharedMemoryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.idmapper.models.SharedMemoryModel</span></code></a></p>
|
||||
<p>A generic help entry.</p>
|
||||
<dl class="simple">
|
||||
<dt>An HelpEntry object has the following properties defined:</dt><dd><p>key - main name of entry
|
||||
help_category - which category entry belongs to (defaults to General)
|
||||
entrytext - the actual help text
|
||||
permissions - perm strings</p>
|
||||
</dd>
|
||||
<dt>Method:</dt><dd><p>access</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="exception">
|
||||
<dt id="evennia.help.models.HelpEntry.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.help.models.HelpEntry.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.ObjectDoesNotExist</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="evennia.help.models.HelpEntry.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.help.models.HelpEntry.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.MultipleObjectsReturned</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry._is_deleted">
|
||||
<code class="sig-name descname">_is_deleted</code><em class="property"> = False</em><a class="headerlink" href="#evennia.help.models.HelpEntry._is_deleted" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for HelpEntry></em><a class="headerlink" href="#evennia.help.models.HelpEntry._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.access">
|
||||
<code class="sig-name descname">access</code><span class="sig-paren">(</span><em class="sig-param">accessing_obj</em>, <em class="sig-param">access_type='read'</em>, <em class="sig-param">default=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.access"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.access" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determines if another object has permission to access.
|
||||
accessing_obj - object trying to access this one
|
||||
access_type - type of access sought
|
||||
default - what to return if no lock of access_type was found</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.aliases">
|
||||
<code class="sig-name descname">aliases</code><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.aliases"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.db_entrytext">
|
||||
<code class="sig-name descname">db_entrytext</code><a class="headerlink" href="#evennia.help.models.HelpEntry.db_entrytext" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.db_help_category">
|
||||
<code class="sig-name descname">db_help_category</code><a class="headerlink" href="#evennia.help.models.HelpEntry.db_help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.db_key">
|
||||
<code class="sig-name descname">db_key</code><a class="headerlink" href="#evennia.help.models.HelpEntry.db_key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.db_lock_storage">
|
||||
<code class="sig-name descname">db_lock_storage</code><a class="headerlink" href="#evennia.help.models.HelpEntry.db_lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.db_staff_only">
|
||||
<code class="sig-name descname">db_staff_only</code><a class="headerlink" href="#evennia.help.models.HelpEntry.db_staff_only" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.db_tags">
|
||||
<code class="sig-name descname">db_tags</code><a class="headerlink" href="#evennia.help.models.HelpEntry.db_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
|
||||
a many-to-many relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'pizzas'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Pizza.toppings</span></code> and <code class="docutils literal notranslate"><span class="pre">Topping.pizzas</span></code> are <code class="docutils literal notranslate"><span class="pre">ManyToManyDescriptor</span></code>
|
||||
instances.</p>
|
||||
<p>Most of the implementation is delegated to a dynamically defined manager
|
||||
class built by <code class="docutils literal notranslate"><span class="pre">create_forward_many_to_many_manager()</span></code> defined below.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.entrytext">
|
||||
<em class="property">property </em><code class="sig-name descname">entrytext</code><a class="headerlink" href="#evennia.help.models.HelpEntry.entrytext" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <cite>db_entrytext</cite>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.get_absolute_url">
|
||||
<code class="sig-name descname">get_absolute_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.help.models.HelpEntry.get_absolute_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the URI path for a View that allows users to view details for
|
||||
this object.</p>
|
||||
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</p>
|
||||
<p>For this to work, the developer must have defined a named view somewhere
|
||||
in urls.py that follows the format ‘modelname-action’, so in this case
|
||||
a named view of ‘character-detail’ would be referenced by this method.</p>
|
||||
<p>ex.
|
||||
url(r’characters/(?P<slug>[wd-]+)/(?P<pk>[0-9]+)/$’,</p>
|
||||
<blockquote>
|
||||
<div><p>CharDetailView.as_view(), name=’character-detail’)</p>
|
||||
</div></blockquote>
|
||||
<p>If no View has been created and defined in urls.py, returns an
|
||||
HTML anchor.</p>
|
||||
<p>This method is naive and simply returns a path. Securing access to
|
||||
the actual view and limiting who can view this object is the developer’s
|
||||
responsibility.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>URI path to object detail page, if defined.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>path (str)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.help_category">
|
||||
<em class="property">property </em><code class="sig-name descname">help_category</code><a class="headerlink" href="#evennia.help.models.HelpEntry.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <cite>db_help_category</cite>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.id">
|
||||
<code class="sig-name descname">id</code><a class="headerlink" href="#evennia.help.models.HelpEntry.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.key">
|
||||
<em class="property">property </em><code class="sig-name descname">key</code><a class="headerlink" href="#evennia.help.models.HelpEntry.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <cite>db_key</cite>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.lock_storage">
|
||||
<em class="property">property </em><code class="sig-name descname">lock_storage</code><a class="headerlink" href="#evennia.help.models.HelpEntry.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <cite>db_lock_storage</cite>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.locks">
|
||||
<code class="sig-name descname">locks</code><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.locks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.objects">
|
||||
<code class="sig-name descname">objects</code><em class="property"> = <evennia.help.manager.HelpEntryManager object></em><a class="headerlink" href="#evennia.help.models.HelpEntry.objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.help.models.HelpEntry'</em><a class="headerlink" href="#evennia.help.models.HelpEntry.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.search_index_entry">
|
||||
<em class="property">property </em><code class="sig-name descname">search_index_entry</code><a class="headerlink" href="#evennia.help.models.HelpEntry.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Property for easily retaining a search index entry for this object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.staff_only">
|
||||
<em class="property">property </em><code class="sig-name descname">staff_only</code><a class="headerlink" href="#evennia.help.models.HelpEntry.staff_only" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <cite>db_staff_only</cite>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.tags">
|
||||
<code class="sig-name descname">tags</code><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.help.models.HelpEntry.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'SharedMemoryModelBase'</em><a class="headerlink" href="#evennia.help.models.HelpEntry.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.web_get_admin_url">
|
||||
<code class="sig-name descname">web_get_admin_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.web_get_admin_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.web_get_admin_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the URI path for the Django Admin page for this object.</p>
|
||||
<p>ex. Account#1 = ‘/admin/accounts/accountdb/1/change/’</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>URI path to Django Admin page for object.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>path (str)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.web_get_create_url">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">web_get_create_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.web_get_create_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.web_get_create_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the URI path for a View that allows users to create new
|
||||
instances of this object.</p>
|
||||
<p>ex. Chargen = ‘/characters/create/’</p>
|
||||
<p>For this to work, the developer must have defined a named view somewhere
|
||||
in urls.py that follows the format ‘modelname-action’, so in this case
|
||||
a named view of ‘character-create’ would be referenced by this method.</p>
|
||||
<p>ex.
|
||||
url(r’characters/create/’, ChargenView.as_view(), name=’character-create’)</p>
|
||||
<p>If no View has been created and defined in urls.py, returns an
|
||||
HTML anchor.</p>
|
||||
<p>This method is naive and simply returns a path. Securing access to
|
||||
the actual view and limiting who can create new objects is the
|
||||
developer’s responsibility.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>URI path to object creation page, if defined.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>path (str)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.web_get_delete_url">
|
||||
<code class="sig-name descname">web_get_delete_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.web_get_delete_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.web_get_delete_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the URI path for a View that allows users to delete this object.</p>
|
||||
<p>ex. Oscar (Character) = ‘/characters/oscar/1/delete/’</p>
|
||||
<p>For this to work, the developer must have defined a named view somewhere
|
||||
in urls.py that follows the format ‘modelname-action’, so in this case
|
||||
a named view of ‘character-detail’ would be referenced by this method.</p>
|
||||
<p>ex.
|
||||
url(r’characters/(?P<slug>[wd-]+)/(?P<pk>[0-9]+)/delete/$’,</p>
|
||||
<blockquote>
|
||||
<div><p>CharDeleteView.as_view(), name=’character-delete’)</p>
|
||||
</div></blockquote>
|
||||
<p>If no View has been created and defined in urls.py, returns an
|
||||
HTML anchor.</p>
|
||||
<p>This method is naive and simply returns a path. Securing access to
|
||||
the actual view and limiting who can delete this object is the developer’s
|
||||
responsibility.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>URI path to object deletion page, if defined.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>path (str)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.web_get_detail_url">
|
||||
<code class="sig-name descname">web_get_detail_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.web_get_detail_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.web_get_detail_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the URI path for a View that allows users to view details for
|
||||
this object.</p>
|
||||
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</p>
|
||||
<p>For this to work, the developer must have defined a named view somewhere
|
||||
in urls.py that follows the format ‘modelname-action’, so in this case
|
||||
a named view of ‘character-detail’ would be referenced by this method.</p>
|
||||
<p>ex.
|
||||
url(r’characters/(?P<slug>[wd-]+)/(?P<pk>[0-9]+)/$’,</p>
|
||||
<blockquote>
|
||||
<div><p>CharDetailView.as_view(), name=’character-detail’)</p>
|
||||
</div></blockquote>
|
||||
<p>If no View has been created and defined in urls.py, returns an
|
||||
HTML anchor.</p>
|
||||
<p>This method is naive and simply returns a path. Securing access to
|
||||
the actual view and limiting who can view this object is the developer’s
|
||||
responsibility.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>URI path to object detail page, if defined.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>path (str)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.help.models.HelpEntry.web_get_update_url">
|
||||
<code class="sig-name descname">web_get_update_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.web_get_update_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.web_get_update_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the URI path for a View that allows users to update this
|
||||
object.</p>
|
||||
<p>ex. Oscar (Character) = ‘/characters/oscar/1/change/’</p>
|
||||
<p>For this to work, the developer must have defined a named view somewhere
|
||||
in urls.py that follows the format ‘modelname-action’, so in this case
|
||||
a named view of ‘character-update’ would be referenced by this method.</p>
|
||||
<p>ex.
|
||||
url(r’characters/(?P<slug>[wd-]+)/(?P<pk>[0-9]+)/change/$’,</p>
|
||||
<blockquote>
|
||||
<div><p>CharUpdateView.as_view(), name=’character-update’)</p>
|
||||
</div></blockquote>
|
||||
<p>If no View has been created and defined in urls.py, returns an
|
||||
HTML anchor.</p>
|
||||
<p>This method is naive and simply returns a path. Securing access to
|
||||
the actual view and limiting who can modify objects is the developer’s
|
||||
responsibility.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>URI path to object update page, if defined.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>path (str)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.help package</a><ul>
|
||||
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.help.admin">evennia.help.admin module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.help.manager">evennia.help.manager module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.help.models">evennia.help.models module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.help.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.help.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.help.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.help.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
647
docs/versions/1.0-dev/api/evennia.html
Normal file
647
docs/versions/1.0-dev/api/evennia.html
Normal file
|
|
@ -0,0 +1,647 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia">
|
||||
<span id="evennia-package"></span><h1>evennia package<a class="headerlink" href="#module-evennia" title="Permalink to this headline">¶</a></h1>
|
||||
<dl>
|
||||
<dt>[1m[36mEvennia[0m ‘flat’ API (use [1m[37mevennia.<component>.__doc__[0m to read doc-strings</dt><dd><p>and [1m[37mdict(evennia.component)[0m or
|
||||
[1m[37mevennia.component.__dict__ to see contents)</p>
|
||||
</dd>
|
||||
<dt>[1m[36mTypeclass-bases:[0m [1m[36mDatabase models[0m:</dt><dd><dl class="simple">
|
||||
<dt>DefaultAccount DefaultObject AccountDB ObjectDB</dt><dd><dl class="simple">
|
||||
<dt>DefaultGuest DefaultCharacter ChannelDB</dt><dd><p>DefaultRoom ScriptDB</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>DefaultChannel DefaultExit Msg
|
||||
DefaultScript</p>
|
||||
</dd>
|
||||
<dt>[1m[36mSearch functions:[0m [1m[36mCommand parents and helpers:[0m</dt><dd><p>search_account search_object default_cmds
|
||||
search_script search_channel Command InterruptCommand
|
||||
search_help search_message CmdSet
|
||||
search_tag managers [1m[36mUtilities:[0m</p>
|
||||
</dd>
|
||||
<dt>[1m[36mCreate functions:[0m settings lockfuncs</dt><dd><p>create_account create_object logger gametime
|
||||
create_script create_channel ansi spawn
|
||||
create_help_entry create_message contrib managers</p>
|
||||
</dd>
|
||||
<dt>[1m[36mGlobal handlers:[0m set_trace</dt><dd><p>TICKER_HANDLER TASK_HANDLER EvMenu EvTable
|
||||
SESSION_HANDLER CHANNEL_HANDLER EvForm EvEditor</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt id="evennia._init">
|
||||
<code class="sig-prename descclassname">evennia.</code><code class="sig-name descname">_init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia.html#_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia._init" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This function is called automatically by the launcher only after
|
||||
Evennia has fully initialized all its models. It sets up the API
|
||||
in a safe environment where all models are available already.</p>
|
||||
</dd></dl>
|
||||
|
||||
<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
|
||||
<cite>pip install pudb</cite>.</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="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.html">evennia.accounts package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html#subpackages">Subpackages</a><ul class="simple">
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.accounts">evennia.accounts.accounts module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.admin">evennia.accounts.admin module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.bots">evennia.accounts.bots module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.manager">evennia.accounts.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.models">evennia.accounts.models module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html#module-evennia.accounts.tests">evennia.accounts.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.html">evennia.commands package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.html">evennia.commands.default package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.account">evennia.commands.default.account module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.admin">evennia.commands.default.admin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.batchprocess">evennia.commands.default.batchprocess module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.building">evennia.commands.default.building module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.cmdset_account">evennia.commands.default.cmdset_account module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.cmdset_character">evennia.commands.default.cmdset_character module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.cmdset_session">evennia.commands.default.cmdset_session module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.cmdset_unloggedin">evennia.commands.default.cmdset_unloggedin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.comms">evennia.commands.default.comms module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.general">evennia.commands.default.general module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.help">evennia.commands.default.help module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.muxcommand">evennia.commands.default.muxcommand module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.syscommands">evennia.commands.default.syscommands module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.system">evennia.commands.default.system module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#evennia-commands-default-tests-module">evennia.commands.default.tests module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.default.html#module-evennia.commands.default.unloggedin">evennia.commands.default.unloggedin module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.cmdhandler">evennia.commands.cmdhandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.cmdparser">evennia.commands.cmdparser module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.cmdset">evennia.commands.cmdset module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.cmdsethandler">evennia.commands.cmdsethandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.command">evennia.commands.command module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.html#module-evennia.commands.tests">evennia.commands.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.comms.html">evennia.comms package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html#subpackages">Subpackages</a><ul class="simple">
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.admin">evennia.comms.admin module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.channelhandler">evennia.comms.channelhandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.comms">evennia.comms.comms module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.managers">evennia.comms.managers module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.models">evennia.comms.models module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html#module-evennia.comms.tests">evennia.comms.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.html">evennia.contrib package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.html">evennia.contrib.ingame_python package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.html#module-evennia.contrib.ingame_python.callbackhandler">evennia.contrib.ingame_python.callbackhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.html#module-evennia.contrib.ingame_python.commands">evennia.contrib.ingame_python.commands module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.html#module-evennia.contrib.ingame_python.eventfuncs">evennia.contrib.ingame_python.eventfuncs module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.html#module-evennia.contrib.ingame_python.scripts">evennia.contrib.ingame_python.scripts module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.html#module-evennia.contrib.ingame_python.tests">evennia.contrib.ingame_python.tests module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.html#module-evennia.contrib.ingame_python.typeclasses">evennia.contrib.ingame_python.typeclasses module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.html#module-evennia.contrib.ingame_python.utils">evennia.contrib.ingame_python.utils module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.security.html">evennia.contrib.security package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.security.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.html">evennia.contrib.security.auditing package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.security.auditing.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.security.auditing.html#module-evennia.contrib.security.auditing.outputs">evennia.contrib.security.auditing.outputs module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.security.auditing.html#module-evennia.contrib.security.auditing.server">evennia.contrib.security.auditing.server module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.security.auditing.html#module-evennia.contrib.security.auditing.tests">evennia.contrib.security.auditing.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.html">evennia.contrib.turnbattle package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.html#module-evennia.contrib.turnbattle.tb_basic">evennia.contrib.turnbattle.tb_basic module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.html#module-evennia.contrib.turnbattle.tb_equip">evennia.contrib.turnbattle.tb_equip module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.html#module-evennia.contrib.turnbattle.tb_items">evennia.contrib.turnbattle.tb_items module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.html#module-evennia.contrib.turnbattle.tb_magic">evennia.contrib.turnbattle.tb_magic module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.html#module-evennia.contrib.turnbattle.tb_range">evennia.contrib.turnbattle.tb_range module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.html">evennia.contrib.tutorial_examples package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#module-evennia.contrib.tutorial_examples.bodyfunctions">evennia.contrib.tutorial_examples.bodyfunctions module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#module-evennia.contrib.tutorial_examples.cmdset_red_button">evennia.contrib.tutorial_examples.cmdset_red_button module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#evennia-contrib-tutorial-examples-example-batch-code-module">evennia.contrib.tutorial_examples.example_batch_code module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#module-evennia.contrib.tutorial_examples.red_button">evennia.contrib.tutorial_examples.red_button module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#module-evennia.contrib.tutorial_examples.red_button_scripts">evennia.contrib.tutorial_examples.red_button_scripts module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#module-evennia.contrib.tutorial_examples.tests">evennia.contrib.tutorial_examples.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.html">evennia.contrib.tutorial_world package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_world.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_world.html#module-evennia.contrib.tutorial_world.mob">evennia.contrib.tutorial_world.mob module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_world.html#module-evennia.contrib.tutorial_world.objects">evennia.contrib.tutorial_world.objects module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_world.html#module-evennia.contrib.tutorial_world.rooms">evennia.contrib.tutorial_world.rooms module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.barter">evennia.contrib.barter module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.building_menu">evennia.contrib.building_menu module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.chargen">evennia.contrib.chargen module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.clothing">evennia.contrib.clothing module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.color_markups">evennia.contrib.color_markups module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.custom_gametime">evennia.contrib.custom_gametime module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.dice">evennia.contrib.dice module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.email_login">evennia.contrib.email_login module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.extended_room">evennia.contrib.extended_room module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.html#id59">```</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.fieldfill">evennia.contrib.fieldfill module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.gendersub">evennia.contrib.gendersub module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.health_bar">evennia.contrib.health_bar module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.mail">evennia.contrib.mail module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.mapbuilder">evennia.contrib.mapbuilder module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.menu_login">evennia.contrib.menu_login module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.multidescer">evennia.contrib.multidescer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.puzzles">evennia.contrib.puzzles module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.random_string_generator">evennia.contrib.random_string_generator module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.rplanguage">evennia.contrib.rplanguage module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.rpsystem">evennia.contrib.rpsystem module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.simpledoor">evennia.contrib.simpledoor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.slow_exit">evennia.contrib.slow_exit module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.talking_npc">evennia.contrib.talking_npc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.test_traits">evennia.contrib.test_traits module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.tests">evennia.contrib.tests module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.traits">evennia.contrib.traits module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.tree_select">evennia.contrib.tree_select module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.unixcommand">evennia.contrib.unixcommand module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html#module-evennia.contrib.wilderness">evennia.contrib.wilderness module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.game_template.html">evennia.game_template package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.game_template.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.game_template.commands.html">evennia.game_template.commands package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.commands.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.commands.html#module-evennia.game_template.commands.command">evennia.game_template.commands.command module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.commands.html#module-evennia.game_template.commands.default_cmdsets">evennia.game_template.commands.default_cmdsets module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.game_template.server.html">evennia.game_template.server package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.server.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.game_template.server.conf.html">evennia.game_template.server.conf package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_initial_setup">evennia.game_template.server.conf.at_initial_setup module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_search">evennia.game_template.server.conf.at_search module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.at_server_startstop">evennia.game_template.server.conf.at_server_startstop module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.cmdparser">evennia.game_template.server.conf.cmdparser module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.connection_screens">evennia.game_template.server.conf.connection_screens module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.inlinefuncs">evennia.game_template.server.conf.inlinefuncs module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.inputfuncs">evennia.game_template.server.conf.inputfuncs module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.lockfuncs">evennia.game_template.server.conf.lockfuncs module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.mssp">evennia.game_template.server.conf.mssp module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.portal_services_plugins">evennia.game_template.server.conf.portal_services_plugins module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#evennia-game-template-server-conf-secret-settings-module">evennia.game_template.server.conf.secret_settings module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.server_services_plugins">evennia.game_template.server.conf.server_services_plugins module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.serversession">evennia.game_template.server.conf.serversession module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#evennia-game-template-server-conf-settings-module">evennia.game_template.server.conf.settings module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.game_template.server.conf.html#module-evennia.game_template.server.conf.web_plugins">evennia.game_template.server.conf.web_plugins module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.game_template.typeclasses.html">evennia.game_template.typeclasses package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.typeclasses.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-accounts-module">evennia.game_template.typeclasses.accounts module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-channels-module">evennia.game_template.typeclasses.channels module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-characters-module">evennia.game_template.typeclasses.characters module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-exits-module">evennia.game_template.typeclasses.exits module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-objects-module">evennia.game_template.typeclasses.objects module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-rooms-module">evennia.game_template.typeclasses.rooms module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.typeclasses.html#evennia-game-template-typeclasses-scripts-module">evennia.game_template.typeclasses.scripts module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.game_template.web.html">evennia.game_template.web package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.web.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.web.html#module-evennia.game_template.web.urls">evennia.game_template.web.urls module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.game_template.world.html">evennia.game_template.world package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.world.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.game_template.world.html#module-evennia.game_template.world.prototypes">evennia.game_template.world.prototypes module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.help.html">evennia.help package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.html#subpackages">Subpackages</a><ul class="simple">
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.html#module-evennia.help.admin">evennia.help.admin module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.html#module-evennia.help.manager">evennia.help.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.html#module-evennia.help.models">evennia.help.models module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.locks.html">evennia.locks package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.html#module-evennia.locks.lockfuncs">evennia.locks.lockfuncs module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.html#module-evennia.locks.lockhandler">evennia.locks.lockhandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.html#module-evennia.locks.tests">evennia.locks.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.objects.html">evennia.objects package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.html#subpackages">Subpackages</a><ul class="simple">
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.admin">evennia.objects.admin module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.manager">evennia.objects.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.models">evennia.objects.models module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.objects">evennia.objects.objects module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.html#module-evennia.objects.tests">evennia.objects.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.prototypes.html">evennia.prototypes package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.menus">evennia.prototypes.menus module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.protfuncs">evennia.prototypes.protfuncs module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.prototypes">evennia.prototypes.prototypes module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.spawner">evennia.prototypes.spawner module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.prototypes.html#id23">}</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.prototypes.html#id28">}</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.prototypes.html#module-evennia.prototypes.tests">evennia.prototypes.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.scripts.html">evennia.scripts package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#subpackages">Subpackages</a><ul class="simple">
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.admin">evennia.scripts.admin module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.manager">evennia.scripts.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.models">evennia.scripts.models module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.monitorhandler">evennia.scripts.monitorhandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.scripthandler">evennia.scripts.scripthandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.scripts">evennia.scripts.scripts module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.taskhandler">evennia.scripts.taskhandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.tests">evennia.scripts.tests module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html#module-evennia.scripts.tickerhandler">evennia.scripts.tickerhandler module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.server.html">evennia.server package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.game_index_client.html">evennia.server.game_index_client package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.game_index_client.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.game_index_client.html#module-evennia.server.game_index_client.client">evennia.server.game_index_client.client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.game_index_client.html#module-evennia.server.game_index_client.service">evennia.server.game_index_client.service module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.portal.html">evennia.server.portal package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.amp">evennia.server.portal.amp module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.amp_server">evennia.server.portal.amp_server module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.grapevine">evennia.server.portal.grapevine module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.irc">evennia.server.portal.irc module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.mccp">evennia.server.portal.mccp module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.mssp">evennia.server.portal.mssp module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.mxp">evennia.server.portal.mxp module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.naws">evennia.server.portal.naws module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.portal">evennia.server.portal.portal module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.portalsessionhandler">evennia.server.portal.portalsessionhandler module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.rss">evennia.server.portal.rss module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.ssh">evennia.server.portal.ssh module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.ssl">evennia.server.portal.ssl module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.suppress_ga">evennia.server.portal.suppress_ga module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.telnet">evennia.server.portal.telnet module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.telnet_oob">evennia.server.portal.telnet_oob module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.telnet_ssl">evennia.server.portal.telnet_ssl module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.tests">evennia.server.portal.tests module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.ttype">evennia.server.portal.ttype module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.webclient">evennia.server.portal.webclient module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.portal.html#module-evennia.server.portal.webclient_ajax">evennia.server.portal.webclient_ajax module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.profiling.html">evennia.server.profiling package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.profiling.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.profiling.html#module-evennia.server.profiling.dummyrunner">evennia.server.profiling.dummyrunner module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.profiling.html#module-evennia.server.profiling.dummyrunner_settings">evennia.server.profiling.dummyrunner_settings module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.profiling.html#module-evennia.server.profiling.memplot">evennia.server.profiling.memplot module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.profiling.html#module-evennia.server.profiling.settings_mixin">evennia.server.profiling.settings_mixin module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.profiling.html#module-evennia.server.profiling.test_queries">evennia.server.profiling.test_queries module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.profiling.html#module-evennia.server.profiling.tests">evennia.server.profiling.tests module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.profiling.html#module-evennia.server.profiling.timetrace">evennia.server.profiling.timetrace module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.tests.html">evennia.server.tests package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.tests.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.tests.html#module-evennia.server.tests.test_amp_connection">evennia.server.tests.test_amp_connection module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.tests.html#module-evennia.server.tests.test_initial_setup">evennia.server.tests.test_initial_setup module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.tests.html#module-evennia.server.tests.test_launcher">evennia.server.tests.test_launcher module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.tests.html#module-evennia.server.tests.test_misc">evennia.server.tests.test_misc module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.tests.html#module-evennia.server.tests.test_server">evennia.server.tests.test_server module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.server.tests.html#module-evennia.server.tests.testrunner">evennia.server.tests.testrunner module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.admin">evennia.server.admin module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.amp_client">evennia.server.amp_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.connection_wizard">evennia.server.connection_wizard module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.deprecations">evennia.server.deprecations module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.evennia_launcher">evennia.server.evennia_launcher module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.initial_setup">evennia.server.initial_setup module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.inputfuncs">evennia.server.inputfuncs module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.manager">evennia.server.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.models">evennia.server.models module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.server">evennia.server.server module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.serversession">evennia.server.serversession module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.session">evennia.server.session module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.sessionhandler">evennia.server.sessionhandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.signals">evennia.server.signals module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.throttle">evennia.server.throttle module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.validators">evennia.server.validators module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html#module-evennia.server.webserver">evennia.server.webserver module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.typeclasses.html">evennia.typeclasses package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html#subpackages">Subpackages</a><ul class="simple">
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.admin">evennia.typeclasses.admin module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.attributes">evennia.typeclasses.attributes module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.managers">evennia.typeclasses.managers module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.models">evennia.typeclasses.models module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.tags">evennia.typeclasses.tags module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html#module-evennia.typeclasses.tests">evennia.typeclasses.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.utils.html">evennia.utils package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.idmapper.html">evennia.utils.idmapper package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.idmapper.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.idmapper.html#module-evennia.utils.idmapper.manager">evennia.utils.idmapper.manager module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.idmapper.html#module-evennia.utils.idmapper.models">evennia.utils.idmapper.models module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.idmapper.html#module-evennia.utils.idmapper.tests">evennia.utils.idmapper.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.tests.html">evennia.utils.tests package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.utils.tests.data.html">evennia.utils.tests.data package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.utils.tests.data.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.utils.tests.data.html#module-evennia.utils.tests.data.evform_example">evennia.utils.tests.data.evform_example module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.utils.tests.data.html#module-evennia.utils.tests.data.prototypes_example">evennia.utils.tests.data.prototypes_example module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_ansi">evennia.utils.tests.test_ansi module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_batchprocessors">evennia.utils.tests.test_batchprocessors module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_create_functions">evennia.utils.tests.test_create_functions module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_eveditor">evennia.utils.tests.test_eveditor module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_evform">evennia.utils.tests.test_evform module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_evmenu">evennia.utils.tests.test_evmenu module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_gametime">evennia.utils.tests.test_gametime module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_tagparsing">evennia.utils.tests.test_tagparsing module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_text2html">evennia.utils.tests.test_text2html module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_utils">evennia.utils.tests.test_utils module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.tests.html#module-evennia.utils.tests.test_validatorfuncs">evennia.utils.tests.test_validatorfuncs module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.ansi">evennia.utils.ansi module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.batchprocessors">evennia.utils.batchprocessors module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.html#example-of-batch-ev-file">Example of batch.ev file:</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.html#example-batch-py-file">Example batch.py file</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.containers">evennia.utils.containers module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.create">evennia.utils.create module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.dbserialize">evennia.utils.dbserialize module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.eveditor">evennia.utils.eveditor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.evform">evennia.utils.evform module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.evmenu">evennia.utils.evmenu module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.evmore">evennia.utils.evmore module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.evtable">evennia.utils.evtable module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.gametime">evennia.utils.gametime module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.inlinefuncs">evennia.utils.inlinefuncs module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.logger">evennia.utils.logger module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.optionclasses">evennia.utils.optionclasses module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.optionhandler">evennia.utils.optionhandler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.picklefield">evennia.utils.picklefield module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.search">evennia.utils.search module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.test_resources">evennia.utils.test_resources module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.text2html">evennia.utils.text2html module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.utils">evennia.utils.utils module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.utils.html#module-evennia.utils.validatorfuncs">evennia.utils.validatorfuncs module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.html">evennia.web package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.backends">evennia.web.utils.backends module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.general_context">evennia.web.utils.general_context module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.middleware">evennia.web.utils.middleware module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.tests">evennia.web.utils.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.webclient.html">evennia.web.webclient package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.webclient.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.webclient.html#module-evennia.web.webclient.urls">evennia.web.webclient.urls module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.webclient.html#module-evennia.web.webclient.views">evennia.web.webclient.views module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.html">evennia.web.website package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.templatetags.html">evennia.web.website.templatetags package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.web.website.templatetags.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.web.website.templatetags.html#module-evennia.web.website.templatetags.addclass">evennia.web.website.templatetags.addclass module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.forms">evennia.web.website.forms module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.tests">evennia.web.website.tests module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.urls">evennia.web.website.urls module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.views">evennia.web.website.views module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.html#module-evennia.web.urls">evennia.web.urls module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.settings_default">
|
||||
<span id="evennia-settings-default-module"></span><h2>evennia.settings_default module<a class="headerlink" href="#module-evennia.settings_default" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Master configuration file for Evennia.</p>
|
||||
<p>NOTE: NO MODIFICATIONS SHOULD BE MADE TO THIS FILE!</p>
|
||||
<p>All settings changes should be done by copy-pasting the variable and
|
||||
its value to <gamedir>/server/conf/settings.py.</p>
|
||||
<p>Hint: Don’t copy&paste over more from this file than you actually want
|
||||
to change. Anything you don’t copy&paste will thus retain its default
|
||||
value - which may change as Evennia is developed. This way you can
|
||||
always be sure of what you have changed and what is default behaviour.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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 package</a><ul>
|
||||
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.settings_default">evennia.settings_default module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<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="../../../versions/0.9.1/api/evennia.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
1139
docs/versions/1.0-dev/api/evennia.locks.html
Normal file
1139
docs/versions/1.0-dev/api/evennia.locks.html
Normal file
File diff suppressed because it is too large
Load diff
3083
docs/versions/1.0-dev/api/evennia.objects.html
Normal file
3083
docs/versions/1.0-dev/api/evennia.objects.html
Normal file
File diff suppressed because it is too large
Load diff
2076
docs/versions/1.0-dev/api/evennia.prototypes.html
Normal file
2076
docs/versions/1.0-dev/api/evennia.prototypes.html
Normal file
File diff suppressed because it is too large
Load diff
1848
docs/versions/1.0-dev/api/evennia.scripts.html
Normal file
1848
docs/versions/1.0-dev/api/evennia.scripts.html
Normal file
File diff suppressed because it is too large
Load diff
267
docs/versions/1.0-dev/api/evennia.server.game_index_client.html
Normal file
267
docs/versions/1.0-dev/api/evennia.server.game_index_client.html
Normal file
|
|
@ -0,0 +1,267 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.server.game_index_client package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.server.game_index_client">
|
||||
<span id="evennia-server-game-index-client-package"></span><h1>evennia.server.game_index_client package<a class="headerlink" href="#module-evennia.server.game_index_client" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.game_index_client.client">
|
||||
<span id="evennia-server-game-index-client-client-module"></span><h2>evennia.server.game_index_client.client module<a class="headerlink" href="#module-evennia.server.game_index_client.client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The client for sending data to the Evennia Game Index</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.game_index_client.client.EvenniaGameIndexClient">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.game_index_client.client.</code><code class="sig-name descname">EvenniaGameIndexClient</code><span class="sig-paren">(</span><em class="sig-param">on_bad_request=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#EvenniaGameIndexClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.EvenniaGameIndexClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>This client class is used for gathering and sending game details to the
|
||||
Evennia Game Index. Since EGI is in the early goings, this isn’t
|
||||
incredibly configurable as far as to what is being sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.EvenniaGameIndexClient.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">on_bad_request=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#EvenniaGameIndexClient.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.EvenniaGameIndexClient.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>on_bad_request</strong> – Optional callable to trigger when a bad request
|
||||
was sent. This is almost always going to be due to bad config.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.EvenniaGameIndexClient._form_and_send_request">
|
||||
<code class="sig-name descname">_form_and_send_request</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#EvenniaGameIndexClient._form_and_send_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.EvenniaGameIndexClient._form_and_send_request" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Build the request to send to the index.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.EvenniaGameIndexClient.handle_egd_response">
|
||||
<code class="sig-name descname">handle_egd_response</code><span class="sig-paren">(</span><em class="sig-param">response</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#EvenniaGameIndexClient.handle_egd_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.EvenniaGameIndexClient.handle_egd_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.EvenniaGameIndexClient.send_game_details">
|
||||
<code class="sig-name descname">send_game_details</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#EvenniaGameIndexClient.send_game_details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.EvenniaGameIndexClient.send_game_details" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is where the magic happens. Send details about the game to the
|
||||
Evennia Game Index.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.game_index_client.client.QuietHTTP11ClientFactory">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.game_index_client.client.</code><code class="sig-name descname">QuietHTTP11ClientFactory</code><span class="sig-paren">(</span><em class="sig-param">quiescentCallback</em>, <em class="sig-param">metadata</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#QuietHTTP11ClientFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.QuietHTTP11ClientFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.web.client._HTTP11ClientFactory</span></code></p>
|
||||
<p>Silences the obnoxious factory start/stop messages in the default client.</p>
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.server.game_index_client.client.QuietHTTP11ClientFactory.noisy">
|
||||
<code class="sig-name descname">noisy</code><em class="property"> = False</em><a class="headerlink" href="#evennia.server.game_index_client.client.QuietHTTP11ClientFactory.noisy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.game_index_client.client.SimpleResponseReceiver">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.game_index_client.client.</code><code class="sig-name descname">SimpleResponseReceiver</code><span class="sig-paren">(</span><em class="sig-param">status_code</em>, <em class="sig-param">d</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#SimpleResponseReceiver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.SimpleResponseReceiver" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.internet.protocol.Protocol</span></code></p>
|
||||
<p>Used for pulling the response body out of an HTTP response.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.SimpleResponseReceiver.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">status_code</em>, <em class="sig-param">d</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#SimpleResponseReceiver.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.SimpleResponseReceiver.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.SimpleResponseReceiver.connectionLost">
|
||||
<code class="sig-name descname">connectionLost</code><span class="sig-paren">(</span><em class="sig-param">reason=<twisted.python.failure.Failure twisted.internet.error.ConnectionDone: Connection was closed cleanly.></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#SimpleResponseReceiver.connectionLost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.SimpleResponseReceiver.connectionLost" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the connection is shut down.</p>
|
||||
<p>Clear any circular references here, and any external references
|
||||
to this Protocol. The connection has been closed.</p>
|
||||
<p>@type reason: L{twisted.python.failure.Failure}</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.SimpleResponseReceiver.dataReceived">
|
||||
<code class="sig-name descname">dataReceived</code><span class="sig-paren">(</span><em class="sig-param">data</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#SimpleResponseReceiver.dataReceived"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.SimpleResponseReceiver.dataReceived" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called whenever data is received.</p>
|
||||
<p>Use this method to translate to a higher-level message. Usually, some
|
||||
callback will be made upon the receipt of each complete protocol
|
||||
message.</p>
|
||||
<dl class="simple">
|
||||
<dt>@param data: a string of indeterminate length. Please keep in mind</dt><dd><p>that you will probably need to buffer some data, as partial
|
||||
(or multiple) protocol messages may be received! I recommend
|
||||
that unit tests for protocols call through to this method with
|
||||
differing chunk sizes, down to one byte at a time.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.game_index_client.client.StringProducer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.game_index_client.client.</code><code class="sig-name descname">StringProducer</code><span class="sig-paren">(</span><em class="sig-param">body</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#StringProducer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.StringProducer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Used for feeding a request body to the tx HTTP client.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.StringProducer.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">body</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#StringProducer.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.StringProducer.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.StringProducer.pauseProducing">
|
||||
<code class="sig-name descname">pauseProducing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#StringProducer.pauseProducing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.StringProducer.pauseProducing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.StringProducer.startProducing">
|
||||
<code class="sig-name descname">startProducing</code><span class="sig-paren">(</span><em class="sig-param">consumer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#StringProducer.startProducing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.StringProducer.startProducing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.client.StringProducer.stopProducing">
|
||||
<code class="sig-name descname">stopProducing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/client.html#StringProducer.stopProducing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.client.StringProducer.stopProducing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.game_index_client.service">
|
||||
<span id="evennia-server-game-index-client-service-module"></span><h2>evennia.server.game_index_client.service module<a class="headerlink" href="#module-evennia.server.game_index_client.service" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Service for integrating the Evennia Game Index client into Evennia.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.game_index_client.service.EvenniaGameIndexService">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.game_index_client.service.</code><code class="sig-name descname">EvenniaGameIndexService</code><a class="reference internal" href="../_modules/evennia/server/game_index_client/service.html#EvenniaGameIndexService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.service.EvenniaGameIndexService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.application.service.Service</span></code></p>
|
||||
<p>Twisted Service that contains a LoopingCall for regularly sending game details
|
||||
to the Evennia Game Index.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.service.EvenniaGameIndexService.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/service.html#EvenniaGameIndexService.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.service.EvenniaGameIndexService.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.service.EvenniaGameIndexService._die_on_bad_request">
|
||||
<code class="sig-name descname">_die_on_bad_request</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/service.html#EvenniaGameIndexService._die_on_bad_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.service.EvenniaGameIndexService._die_on_bad_request" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If it becomes apparent that our configuration is generating improperly
|
||||
formed messages to EGI, we don’t want to keep sending bad messages.
|
||||
Stop the service so we’re not wasting resources.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.server.game_index_client.service.EvenniaGameIndexService.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'GameIndexClient'</em><a class="headerlink" href="#evennia.server.game_index_client.service.EvenniaGameIndexService.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.service.EvenniaGameIndexService.startService">
|
||||
<code class="sig-name descname">startService</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/service.html#EvenniaGameIndexService.startService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.service.EvenniaGameIndexService.startService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.game_index_client.service.EvenniaGameIndexService.stopService">
|
||||
<code class="sig-name descname">stopService</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/game_index_client/service.html#EvenniaGameIndexService.stopService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.game_index_client.service.EvenniaGameIndexService.stopService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.server.game_index_client package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.game_index_client.client">evennia.server.game_index_client.client module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.game_index_client.service">evennia.server.game_index_client.service module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.server.game_index_client.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.server.game_index_client.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.server.game_index_client.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.server.game_index_client.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
3358
docs/versions/1.0-dev/api/evennia.server.html
Normal file
3358
docs/versions/1.0-dev/api/evennia.server.html
Normal file
File diff suppressed because it is too large
Load diff
3872
docs/versions/1.0-dev/api/evennia.server.portal.html
Normal file
3872
docs/versions/1.0-dev/api/evennia.server.portal.html
Normal file
File diff suppressed because it is too large
Load diff
625
docs/versions/1.0-dev/api/evennia.server.profiling.html
Normal file
625
docs/versions/1.0-dev/api/evennia.server.profiling.html
Normal file
|
|
@ -0,0 +1,625 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.server.profiling package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.server.profiling">
|
||||
<span id="evennia-server-profiling-package"></span><h1>evennia.server.profiling package<a class="headerlink" href="#module-evennia.server.profiling" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.profiling.dummyrunner">
|
||||
<span id="evennia-server-profiling-dummyrunner-module"></span><h2>evennia.server.profiling.dummyrunner module<a class="headerlink" href="#module-evennia.server.profiling.dummyrunner" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Dummy client runner</p>
|
||||
<p>This module implements a stand-alone launcher for stress-testing
|
||||
an Evennia game. It will launch any number of fake clients. These
|
||||
clients will log into the server and start doing random operations.
|
||||
Customizing and weighing these operations differently depends on
|
||||
which type of game is tested. The module contains a testing module
|
||||
for plain Evennia.</p>
|
||||
<p>Please note that you shouldn’t run this on a production server!
|
||||
Launch the program without any arguments or options to see a
|
||||
full step-by-step setup help.</p>
|
||||
<p>Basically (for testing default Evennia):</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><p>Use an empty/testing database.</p></li>
|
||||
<li><p>set PERMISSION_ACCOUNT_DEFAULT = “Builder”</p></li>
|
||||
<li><p>start server, eventually with profiling active</p></li>
|
||||
<li><p>launch this client runner</p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>If you want to customize the runner’s client actions
|
||||
(because you changed the cmdset or needs to better
|
||||
match your use cases or add more actions), you can
|
||||
change which actions by adding a path to</p>
|
||||
<blockquote>
|
||||
<div><p>DUMMYRUNNER_ACTIONS_MODULE = <path.to.your.module></p>
|
||||
</div></blockquote>
|
||||
<p>in your settings. See utils.dummyrunner_actions.py
|
||||
for instructions on how to define this module.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyClient">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.profiling.dummyrunner.</code><code class="sig-name descname">DummyClient</code><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.conch.telnet.StatefulTelnetProtocol</span></code></p>
|
||||
<p>Handles connection to a running Evennia server,
|
||||
mimicking a real account by sending commands on
|
||||
a timer.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyClient.connectionLost">
|
||||
<code class="sig-name descname">connectionLost</code><span class="sig-paren">(</span><em class="sig-param">reason</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyClient.connectionLost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyClient.connectionLost" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when loosing the connection.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>reason</strong> (<em>str</em>) – Reason for loosing connection.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyClient.connectionMade">
|
||||
<code class="sig-name descname">connectionMade</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyClient.connectionMade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyClient.connectionMade" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when connection is first established.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyClient.counter">
|
||||
<code class="sig-name descname">counter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyClient.counter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyClient.counter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Produces a unique id, also between clients.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>A unique counter.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>counter (int)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyClient.dataReceived">
|
||||
<code class="sig-name descname">dataReceived</code><span class="sig-paren">(</span><em class="sig-param">data</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyClient.dataReceived"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyClient.dataReceived" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when data comes in over the protocol. We wait to start
|
||||
stepping until the server actually responds</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>data</strong> (<em>str</em>) – Incoming data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyClient.error">
|
||||
<code class="sig-name descname">error</code><span class="sig-paren">(</span><em class="sig-param">err</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyClient.error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyClient.error" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Error callback.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>err</strong> (<em>Failure</em>) – Error instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyClient.logout">
|
||||
<code class="sig-name descname">logout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyClient.logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyClient.logout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Causes the client to log out of the server. Triggered by ctrl-c signal.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyClient.step">
|
||||
<code class="sig-name descname">step</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyClient.step"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyClient.step" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Perform a step. This is called repeatedly by the runner and
|
||||
causes the client to issue commands to the server. This holds
|
||||
all “intelligence” of the dummy client.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyFactory">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.profiling.dummyrunner.</code><code class="sig-name descname">DummyFactory</code><span class="sig-paren">(</span><em class="sig-param">actions</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.internet.protocol.ClientFactory</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyFactory.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">actions</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#DummyFactory.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyFactory.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Setup the factory base (shared by all clients)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.server.profiling.dummyrunner.DummyFactory.protocol">
|
||||
<code class="sig-name descname">protocol</code><a class="headerlink" href="#evennia.server.profiling.dummyrunner.DummyFactory.protocol" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.server.profiling.dummyrunner.DummyClient" title="evennia.server.profiling.dummyrunner.DummyClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">DummyClient</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner.gidcounter">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner.</code><code class="sig-name descname">gidcounter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#gidcounter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.gidcounter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Makes globally unique ids.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>count (int); A globally unique counter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner.idcounter">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner.</code><code class="sig-name descname">idcounter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#idcounter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.idcounter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Makes unique ids.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>A globally unique counter.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>count (int)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner.makeiter">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner.</code><code class="sig-name descname">makeiter</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#makeiter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.makeiter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Makes everything iterable.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<em>any</em>) – Object to turn iterable.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>An iterable object.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>iterable (iterable)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner.start_all_dummy_clients">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner.</code><code class="sig-name descname">start_all_dummy_clients</code><span class="sig-paren">(</span><em class="sig-param">nclients</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner.html#start_all_dummy_clients"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner.start_all_dummy_clients" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize all clients, connect them and start to step them</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>nclients</strong> (<em>int</em>) – Number of dummy clients to connect.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.profiling.dummyrunner_settings">
|
||||
<span id="evennia-server-profiling-dummyrunner-settings-module"></span><h2>evennia.server.profiling.dummyrunner_settings module<a class="headerlink" href="#module-evennia.server.profiling.dummyrunner_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Settings and actions for the dummyrunner</p>
|
||||
<p>This module defines dummyrunner settings and sets up
|
||||
the actions available to dummy accounts.</p>
|
||||
<p>The settings are global variables:</p>
|
||||
<p>TIMESTEP - time in seconds between each ‘tick’
|
||||
CHANCE_OF_ACTION - chance 0-1 of action happening
|
||||
CHANCE_OF_LOGIN - chance 0-1 of login happening
|
||||
TELNET_PORT - port to use, defaults to settings.TELNET_PORT
|
||||
ACTIONS - see below</p>
|
||||
<p>ACTIONS is a tuple</p>
|
||||
<p>(login_func, logout_func, (0.3, func1), (0.1, func2) … )</p>
|
||||
<p>where the first entry is the function to call on first connect, with a
|
||||
chance of occurring given by CHANCE_OF_LOGIN. This function is usually
|
||||
responsible for logging in the account. The second entry is always
|
||||
called when the dummyrunner disconnects from the server and should
|
||||
thus issue a logout command. The other entries are tuples (chance,
|
||||
func). They are picked randomly, their commonality based on the
|
||||
cumulative chance given (the chance is normalized between all options
|
||||
so if will still work also if the given chances don’t add up to 1).
|
||||
Since each function can return a list of game-command strings, each
|
||||
function may result in multiple operations.</p>
|
||||
<p>An action-function is called with a “client” argument which is a
|
||||
reference to the dummy client currently performing the action. It
|
||||
returns a string or a list of command strings to execute. Use the
|
||||
client object for optionally saving data between actions.</p>
|
||||
<dl>
|
||||
<dt>The client object has the following relevant properties and methods:</dt><dd><dl class="simple">
|
||||
<dt>key - an optional client key. This is only used for dummyrunner output.</dt><dd><p>Default is “Dummy-<cid>”</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>cid - client id
|
||||
gid - globally unique id, hashed with time stamp
|
||||
istep - the current step
|
||||
exits - an empty list. Can be used to store exit names
|
||||
objs - an empty list. Can be used to store object names
|
||||
counter() - returns a unique increasing id, hashed with time stamp</p>
|
||||
<blockquote>
|
||||
<div><p>to make it unique also between dummyrunner instances.</p>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>The return should either be a single command string or a tuple of
|
||||
command strings. This list of commands will always be executed every
|
||||
TIMESTEP with a chance given by CHANCE_OF_ACTION by in the order given
|
||||
(no randomness) and allows for setting up a more complex chain of
|
||||
commands (such as creating an account and logging in).</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_creates_button">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_creates_button</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_creates_button"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_creates_button" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>creates example button, storing name on client</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_creates_obj">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_creates_obj</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_creates_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_creates_obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>creates normal objects, storing their name on client</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_digs">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_digs</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_digs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_digs" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>digs a new room, storing exit names on client</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_examines">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_examines</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_examines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_examines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>examines various objects</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_help">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_help</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>reads help files</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_idles">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_idles</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_idles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_idles" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>idles</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_login">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_login</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>logins to the game</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_login_nodig">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_login_nodig</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_login_nodig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_login_nodig" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>logins, don’t dig its own room</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_logout">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_logout</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_logout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>logouts of the game</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_looks">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_looks</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_looks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_looks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>looks at various objects</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_moves">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_moves</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_moves"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_moves" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>moves to a previously created room, using the stored exits</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_moves_n">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_moves_n</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_moves_n"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_moves_n" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>move through north exit if available</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_moves_s">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_moves_s</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_moves_s"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_moves_s" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>move through south exit if available</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.dummyrunner_settings.c_socialize">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_socialize</code><span class="sig-paren">(</span><em class="sig-param">client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_socialize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_socialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>socializechats on channel</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.profiling.memplot">
|
||||
<span id="evennia-server-profiling-memplot-module"></span><h2>evennia.server.profiling.memplot module<a class="headerlink" href="#module-evennia.server.profiling.memplot" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Script that saves memory and idmapper data over time.</p>
|
||||
<p>Data will be saved to game/logs/memoryusage.log. Note that
|
||||
the script will append to this file if it already exists.</p>
|
||||
<p>Call this module directly to plot the log (requires matplotlib and numpy).</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.profiling.memplot.Memplot">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.profiling.memplot.</code><code class="sig-name descname">Memplot</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/memplot.html#Memplot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.memplot.Memplot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>Describes a memory plotting action.</p>
|
||||
<dl class="exception">
|
||||
<dt id="evennia.server.profiling.memplot.Memplot.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.server.profiling.memplot.Memplot.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DoesNotExist</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="evennia.server.profiling.memplot.Memplot.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.server.profiling.memplot.Memplot.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.MultipleObjectsReturned</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.server.profiling.memplot.Memplot._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for Memplot></em><a class="headerlink" href="#evennia.server.profiling.memplot.Memplot._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.memplot.Memplot.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/memplot.html#Memplot.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.memplot.Memplot.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Regularly save memory statistics.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.memplot.Memplot.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/memplot.html#Memplot.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.memplot.Memplot.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called at script creation</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.server.profiling.memplot.Memplot.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.server.profiling.memplot.Memplot'</em><a class="headerlink" href="#evennia.server.profiling.memplot.Memplot.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.server.profiling.memplot.Memplot.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'Memplot'</em><a class="headerlink" href="#evennia.server.profiling.memplot.Memplot.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.profiling.settings_mixin">
|
||||
<span id="evennia-server-profiling-settings-mixin-module"></span><h2>evennia.server.profiling.settings_mixin module<a class="headerlink" href="#module-evennia.server.profiling.settings_mixin" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Dummyrunner mixin. Add this at the end of the settings file before
|
||||
running dummyrunner, like this:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.server.profiling.settings_mixin import *</p>
|
||||
</div></blockquote>
|
||||
<p>Note that these mixin-settings are not suitable for production
|
||||
servers!</p>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.profiling.test_queries">
|
||||
<span id="evennia-server-profiling-test-queries-module"></span><h2>evennia.server.profiling.test_queries module<a class="headerlink" href="#module-evennia.server.profiling.test_queries" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This is a little routine for viewing the sql queries that are executed by a given
|
||||
query as well as count them for optimization testing.</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.test_queries.count_queries">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.test_queries.</code><code class="sig-name descname">count_queries</code><span class="sig-paren">(</span><em class="sig-param">exec_string</em>, <em class="sig-param">setup_string</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/test_queries.html#count_queries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.test_queries.count_queries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display queries done by exec_string. Use setup_string
|
||||
to setup the environment to test.</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.profiling.tests">
|
||||
<span id="evennia-server-profiling-tests-module"></span><h2>evennia.server.profiling.tests module<a class="headerlink" href="#module-evennia.server.profiling.tests" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.profiling.tests.</code><code class="sig-name descname">TestDummyrunnerSettings</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.clear_client_lists">
|
||||
<code class="sig-name descname">clear_client_lists</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.clear_client_lists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.clear_client_lists" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.perception_method_tests">
|
||||
<code class="sig-name descname">perception_method_tests</code><span class="sig-paren">(</span><em class="sig-param">func</em>, <em class="sig-param">verb</em>, <em class="sig-param">alone_suffix=''</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.perception_method_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.perception_method_tests" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_creates_button">
|
||||
<code class="sig-name descname">test_c_creates_button</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_creates_button"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_creates_button" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_creates_obj">
|
||||
<code class="sig-name descname">test_c_creates_obj</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_creates_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_creates_obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_digs">
|
||||
<code class="sig-name descname">test_c_digs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_digs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_digs" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_examines">
|
||||
<code class="sig-name descname">test_c_examines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_examines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_examines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_help">
|
||||
<code class="sig-name descname">test_c_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_login">
|
||||
<code class="sig-name descname">test_c_login</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_login_no_dig">
|
||||
<code class="sig-name descname">test_c_login_no_dig</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_login_no_dig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_login_no_dig" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_logout">
|
||||
<code class="sig-name descname">test_c_logout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_logout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_looks">
|
||||
<code class="sig-name descname">test_c_looks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_looks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_looks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_move_n">
|
||||
<code class="sig-name descname">test_c_move_n</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_move_n"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_move_n" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_move_s">
|
||||
<code class="sig-name descname">test_c_move_s</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_move_s"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_move_s" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_moves">
|
||||
<code class="sig-name descname">test_c_moves</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_moves"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_moves" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_socialize">
|
||||
<code class="sig-name descname">test_c_socialize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_c_socialize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_c_socialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestDummyrunnerSettings.test_idles">
|
||||
<code class="sig-name descname">test_idles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestDummyrunnerSettings.test_idles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestDummyrunnerSettings.test_idles" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.profiling.tests.TestMemPlot">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.profiling.tests.</code><code class="sig-name descname">TestMemPlot</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestMemPlot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestMemPlot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.profiling.tests.TestMemPlot.test_memplot">
|
||||
<code class="sig-name descname">test_memplot</code><span class="sig-paren">(</span><em class="sig-param">mock_time</em>, <em class="sig-param">mocked_open</em>, <em class="sig-param">mocked_os</em>, <em class="sig-param">mocked_idmapper</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/tests.html#TestMemPlot.test_memplot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.tests.TestMemPlot.test_memplot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.profiling.timetrace">
|
||||
<span id="evennia-server-profiling-timetrace-module"></span><h2>evennia.server.profiling.timetrace module<a class="headerlink" href="#module-evennia.server.profiling.timetrace" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Trace a message through the messaging system</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.server.profiling.timetrace.timetrace">
|
||||
<code class="sig-prename descclassname">evennia.server.profiling.timetrace.</code><code class="sig-name descname">timetrace</code><span class="sig-paren">(</span><em class="sig-param">message</em>, <em class="sig-param">idstring</em>, <em class="sig-param">tracemessage='TEST_MESSAGE'</em>, <em class="sig-param">final=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/timetrace.html#timetrace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.timetrace.timetrace" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Trace a message with time stamps.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>message</strong> (<em>str</em>) – The actual message coming through</p></li>
|
||||
<li><p><strong>idstring</strong> (<em>str</em>) – An identifier string specifying where this trace is happening.</p></li>
|
||||
<li><p><strong>tracemessage</strong> (<em>str</em>) – The start of the message to tag.
|
||||
This message will get attached time stamp.</p></li>
|
||||
<li><p><strong>final</strong> (<em>bool</em>) – This is the final leg in the path - include total time in message</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.server.profiling package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.profiling.dummyrunner">evennia.server.profiling.dummyrunner module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.profiling.dummyrunner_settings">evennia.server.profiling.dummyrunner_settings module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.profiling.memplot">evennia.server.profiling.memplot module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.profiling.settings_mixin">evennia.server.profiling.settings_mixin module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.profiling.test_queries">evennia.server.profiling.test_queries module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.profiling.tests">evennia.server.profiling.tests module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.profiling.timetrace">evennia.server.profiling.timetrace module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.server.profiling.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.server.profiling.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.server.profiling.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.server.profiling.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
457
docs/versions/1.0-dev/api/evennia.server.tests.html
Normal file
457
docs/versions/1.0-dev/api/evennia.server.tests.html
Normal file
|
|
@ -0,0 +1,457 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.server.tests package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.server.tests">
|
||||
<span id="evennia-server-tests-package"></span><h1>evennia.server.tests package<a class="headerlink" href="#module-evennia.server.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.tests.test_amp_connection">
|
||||
<span id="evennia-server-tests-test-amp-connection-module"></span><h2>evennia.server.tests.test_amp_connection module<a class="headerlink" href="#module-evennia.server.tests.test_amp_connection" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Test AMP client</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_amp_connection.TestAMPClientRecv">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_amp_connection.</code><code class="sig-name descname">TestAMPClientRecv</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#TestAMPClientRecv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection.TestAMPClientRecv" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.server.tests.test_amp_connection._TestAMP" title="evennia.server.tests.test_amp_connection._TestAMP"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.server.tests.test_amp_connection._TestAMP</span></code></a></p>
|
||||
<p>Test amp client sending data</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection.TestAMPClientRecv.test_adminportal2server">
|
||||
<code class="sig-name descname">test_adminportal2server</code><span class="sig-paren">(</span><em class="sig-param">mocktransport</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#TestAMPClientRecv.test_adminportal2server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection.TestAMPClientRecv.test_adminportal2server" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection.TestAMPClientRecv.test_msgportal2server">
|
||||
<code class="sig-name descname">test_msgportal2server</code><span class="sig-paren">(</span><em class="sig-param">mocktransport</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#TestAMPClientRecv.test_msgportal2server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection.TestAMPClientRecv.test_msgportal2server" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_amp_connection.TestAMPClientSend">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_amp_connection.</code><code class="sig-name descname">TestAMPClientSend</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#TestAMPClientSend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection.TestAMPClientSend" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.server.tests.test_amp_connection._TestAMP" title="evennia.server.tests.test_amp_connection._TestAMP"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.server.tests.test_amp_connection._TestAMP</span></code></a></p>
|
||||
<p>Test amp client sending data</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection.TestAMPClientSend.test_adminserver2portal">
|
||||
<code class="sig-name descname">test_adminserver2portal</code><span class="sig-paren">(</span><em class="sig-param">mocktransport</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#TestAMPClientSend.test_adminserver2portal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection.TestAMPClientSend.test_adminserver2portal" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection.TestAMPClientSend.test_msgserver2portal">
|
||||
<code class="sig-name descname">test_msgserver2portal</code><span class="sig-paren">(</span><em class="sig-param">mocktransport</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#TestAMPClientSend.test_msgserver2portal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection.TestAMPClientSend.test_msgserver2portal" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_amp_connection._TestAMP">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_amp_connection.</code><code class="sig-name descname">_TestAMP</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#_TestAMP"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection._TestAMP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.trial._asynctest.TestCase</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection._TestAMP._catch_wire_read">
|
||||
<code class="sig-name descname">_catch_wire_read</code><span class="sig-paren">(</span><em class="sig-param">mocktransport</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#_TestAMP._catch_wire_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection._TestAMP._catch_wire_read" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Parse what was supposed to be sent over the wire</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection._TestAMP._connect_client">
|
||||
<code class="sig-name descname">_connect_client</code><span class="sig-paren">(</span><em class="sig-param">mocktransport</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#_TestAMP._connect_client"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection._TestAMP._connect_client" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Setup client to send data for testing</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection._TestAMP._connect_server">
|
||||
<code class="sig-name descname">_connect_server</code><span class="sig-paren">(</span><em class="sig-param">mocktransport</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#_TestAMP._connect_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection._TestAMP._connect_server" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Setup server to send data for testing</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection._TestAMP.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#_TestAMP.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection._TestAMP.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_amp_connection._TestAMP.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_amp_connection.html#_TestAMP.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_amp_connection._TestAMP.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.tests.test_initial_setup">
|
||||
<span id="evennia-server-tests-test-initial-setup-module"></span><h2>evennia.server.tests.test_initial_setup module<a class="headerlink" href="#module-evennia.server.tests.test_initial_setup" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Test initial startup procedure</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_initial_setup.TestInitialSetup">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_initial_setup.</code><code class="sig-name descname">TestInitialSetup</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_initial_setup.html#TestInitialSetup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_initial_setup.TestInitialSetup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_initial_setup.TestInitialSetup.test_get_god_account">
|
||||
<code class="sig-name descname">test_get_god_account</code><span class="sig-paren">(</span><em class="sig-param">mocked_accountdb</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_initial_setup.html#TestInitialSetup.test_get_god_account"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_initial_setup.TestInitialSetup.test_get_god_account" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.tests.test_launcher">
|
||||
<span id="evennia-server-tests-test-launcher-module"></span><h2>evennia.server.tests.test_launcher module<a class="headerlink" href="#module-evennia.server.tests.test_launcher" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Test the evennia launcher.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_launcher.</code><code class="sig-name descname">TestLauncher</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.trial._asynctest.TestCase</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher._catch_wire_read">
|
||||
<code class="sig-name descname">_catch_wire_read</code><span class="sig-paren">(</span><em class="sig-param">mocktransport</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher._catch_wire_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher._catch_wire_read" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Parse what was supposed to be sent over the wire</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher._msend_status_err">
|
||||
<code class="sig-name descname">_msend_status_err</code><span class="sig-paren">(</span><em class="sig-param">arguments</em>, <em class="sig-param">callback=None</em>, <em class="sig-param">errback=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher._msend_status_err"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher._msend_status_err" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher._msend_status_ok">
|
||||
<code class="sig-name descname">_msend_status_ok</code><span class="sig-paren">(</span><em class="sig-param">arguments</em>, <em class="sig-param">callback=None</em>, <em class="sig-param">errback=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher._msend_status_ok"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher._msend_status_ok" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_file_compact">
|
||||
<code class="sig-name descname">test_file_compact</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_file_compact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_file_compact" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_get_twisted_cmdline">
|
||||
<code class="sig-name descname">test_get_twisted_cmdline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_get_twisted_cmdline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_get_twisted_cmdline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_get_twisted_cmdline_nt">
|
||||
<code class="sig-name descname">test_get_twisted_cmdline_nt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_get_twisted_cmdline_nt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_get_twisted_cmdline_nt" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_is_windows">
|
||||
<code class="sig-name descname">test_is_windows</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_is_windows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_is_windows" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_parse_status">
|
||||
<code class="sig-name descname">test_parse_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_parse_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_parse_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_print_info">
|
||||
<code class="sig-name descname">test_print_info</code><span class="sig-paren">(</span><em class="sig-param">mockprint</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_print_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_print_info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_query_status_callback">
|
||||
<code class="sig-name descname">test_query_status_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_query_status_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_query_status_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_query_status_not_run">
|
||||
<code class="sig-name descname">test_query_status_not_run</code><span class="sig-paren">(</span><em class="sig-param">mprint</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_query_status_not_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_query_status_not_run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_query_status_run">
|
||||
<code class="sig-name descname">test_query_status_run</code><span class="sig-paren">(</span><em class="sig-param">mprint</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_query_status_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_query_status_run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_reactor_stop">
|
||||
<code class="sig-name descname">test_reactor_stop</code><span class="sig-paren">(</span><em class="sig-param">mockstop</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_reactor_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_reactor_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_wait_for_status">
|
||||
<code class="sig-name descname">test_wait_for_status</code><span class="sig-paren">(</span><em class="sig-param">mcalllater</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_wait_for_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_wait_for_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_wait_for_status_fail">
|
||||
<code class="sig-name descname">test_wait_for_status_fail</code><span class="sig-paren">(</span><em class="sig-param">mcalllater</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_wait_for_status_fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_wait_for_status_fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_wait_for_status_reply">
|
||||
<code class="sig-name descname">test_wait_for_status_reply</code><span class="sig-paren">(</span><em class="sig-param">mprint</em>, <em class="sig-param">aconn</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_wait_for_status_reply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_wait_for_status_reply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_launcher.TestLauncher.test_wait_for_status_reply_fail">
|
||||
<code class="sig-name descname">test_wait_for_status_reply_fail</code><span class="sig-paren">(</span><em class="sig-param">mprint</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_launcher.html#TestLauncher.test_wait_for_status_reply_fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_launcher.TestLauncher.test_wait_for_status_reply_fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.tests.test_misc">
|
||||
<span id="evennia-server-tests-test-misc-module"></span><h2>evennia.server.tests.test_misc module<a class="headerlink" href="#module-evennia.server.tests.test_misc" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Testing various individual functionalities in the server package.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_misc.MockSettings">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_misc.</code><code class="sig-name descname">MockSettings</code><span class="sig-paren">(</span><em class="sig-param">setting</em>, <em class="sig-param">value=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_misc.html#MockSettings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_misc.MockSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Class for simulating django.conf.settings. Created with a single value, and then sets the required
|
||||
WEBSERVER_ENABLED setting to True or False depending if we’re testing WEBSERVER_PORTS.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_misc.MockSettings.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">setting</em>, <em class="sig-param">value=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_misc.html#MockSettings.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_misc.MockSettings.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_misc.TestDeprecations">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_misc.</code><code class="sig-name descname">TestDeprecations</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_misc.html#TestDeprecations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_misc.TestDeprecations" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<p>Class for testing deprecations.check_errors.</p>
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.server.tests.test_misc.TestDeprecations.deprecated_settings">
|
||||
<code class="sig-name descname">deprecated_settings</code><em class="property"> = ('CMDSET_DEFAULT', 'CMDSET_OOC', 'BASE_COMM_TYPECLASS', 'COMM_TYPECLASS_PATHS', 'CHARACTER_DEFAULT_HOME', 'OBJECT_TYPECLASS_PATHS', 'SCRIPT_TYPECLASS_PATHS', 'ACCOUNT_TYPECLASS_PATHS', 'CHANNEL_TYPECLASS_PATHS', 'SEARCH_MULTIMATCH_SEPARATOR', 'TIME_SEC_PER_MIN', 'TIME_MIN_PER_HOUR', 'TIME_HOUR_PER_DAY', 'TIME_DAY_PER_WEEK', 'TIME_WEEK_PER_MONTH', 'TIME_MONTH_PER_YEAR', 'GAME_DIRECTORY_LISTING')</em><a class="headerlink" href="#evennia.server.tests.test_misc.TestDeprecations.deprecated_settings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_misc.TestDeprecations.test_check_errors">
|
||||
<code class="sig-name descname">test_check_errors</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_misc.html#TestDeprecations.test_check_errors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_misc.TestDeprecations.test_check_errors" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>All settings in deprecated_settings should raise a DeprecationWarning if they exist.
|
||||
WEBSERVER_PORTS raises an error if the iterable value passed does not have a tuple as its
|
||||
first element.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_misc.ThrottleTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_misc.</code><code class="sig-name descname">ThrottleTest</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_misc.html#ThrottleTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_misc.ThrottleTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||||
<p>Class for testing the connection/IP throttle.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_misc.ThrottleTest.test_throttle">
|
||||
<code class="sig-name descname">test_throttle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_misc.html#ThrottleTest.test_throttle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_misc.ThrottleTest.test_throttle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_misc.ValidatorTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_misc.</code><code class="sig-name descname">ValidatorTest</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_misc.html#ValidatorTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_misc.ValidatorTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_misc.ValidatorTest.test_validator">
|
||||
<code class="sig-name descname">test_validator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_misc.html#ValidatorTest.test_validator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_misc.ValidatorTest.test_validator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.tests.test_server">
|
||||
<span id="evennia-server-tests-test-server-module"></span><h2>evennia.server.tests.test_server module<a class="headerlink" href="#module-evennia.server.tests.test_server" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Test the main server component</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.test_server.TestServer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.test_server.</code><code class="sig-name descname">TestServer</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">unittest.case.TestCase</span></code></p>
|
||||
<p>Test server module.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test__server_maintenance_channel_handler_update">
|
||||
<code class="sig-name descname">test__server_maintenance_channel_handler_update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test__server_maintenance_channel_handler_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test__server_maintenance_channel_handler_update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test__server_maintenance_close_connection">
|
||||
<code class="sig-name descname">test__server_maintenance_close_connection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test__server_maintenance_close_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test__server_maintenance_close_connection" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test__server_maintenance_flush">
|
||||
<code class="sig-name descname">test__server_maintenance_flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test__server_maintenance_flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test__server_maintenance_flush" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test__server_maintenance_idle_time">
|
||||
<code class="sig-name descname">test__server_maintenance_idle_time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test__server_maintenance_idle_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test__server_maintenance_idle_time" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test__server_maintenance_reset">
|
||||
<code class="sig-name descname">test__server_maintenance_reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test__server_maintenance_reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test__server_maintenance_reset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test__server_maintenance_validate_scripts">
|
||||
<code class="sig-name descname">test__server_maintenance_validate_scripts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test__server_maintenance_validate_scripts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test__server_maintenance_validate_scripts" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test_evennia_start">
|
||||
<code class="sig-name descname">test_evennia_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test_evennia_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test_evennia_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test_get_info_dict">
|
||||
<code class="sig-name descname">test_get_info_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test_get_info_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test_get_info_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test_initial_setup">
|
||||
<code class="sig-name descname">test_initial_setup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test_initial_setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test_initial_setup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test_initial_setup_retry">
|
||||
<code class="sig-name descname">test_initial_setup_retry</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test_initial_setup_retry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test_initial_setup_retry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test_run_init_hooks">
|
||||
<code class="sig-name descname">test_run_init_hooks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test_run_init_hooks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test_run_init_hooks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.test_server.TestServer.test_update_defaults">
|
||||
<code class="sig-name descname">test_update_defaults</code><span class="sig-paren">(</span><em class="sig-param">mockchan</em>, <em class="sig-param">mockscript</em>, <em class="sig-param">mockacct</em>, <em class="sig-param">mockobj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/test_server.html#TestServer.test_update_defaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.test_server.TestServer.test_update_defaults" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.server.tests.testrunner">
|
||||
<span id="evennia-server-tests-testrunner-module"></span><h2>evennia.server.tests.testrunner module<a class="headerlink" href="#module-evennia.server.tests.testrunner" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Main test-suite runner of Evennia. The runner collates tests from
|
||||
all over the code base and runs them.</p>
|
||||
<p>Runs as part of the Evennia’s test suite with ‘evennia test evennia”</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.server.tests.testrunner.EvenniaTestSuiteRunner">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.tests.testrunner.</code><code class="sig-name descname">EvenniaTestSuiteRunner</code><span class="sig-paren">(</span><em class="sig-param">pattern=None</em>, <em class="sig-param">top_level=None</em>, <em class="sig-param">verbosity=1</em>, <em class="sig-param">interactive=True</em>, <em class="sig-param">failfast=False</em>, <em class="sig-param">keepdb=False</em>, <em class="sig-param">reverse=False</em>, <em class="sig-param">debug_mode=False</em>, <em class="sig-param">debug_sql=False</em>, <em class="sig-param">parallel=0</em>, <em class="sig-param">tags=None</em>, <em class="sig-param">exclude_tags=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/testrunner.html#EvenniaTestSuiteRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.testrunner.EvenniaTestSuiteRunner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.runner.DiscoverRunner</span></code></p>
|
||||
<p>Pointed to by the TEST_RUNNER setting.
|
||||
This test runner only runs tests on the apps specified in evennia/</p>
|
||||
<blockquote>
|
||||
<div><p>avoid running the large number of tests defined by Django</p>
|
||||
</div></blockquote>
|
||||
<dl class="method">
|
||||
<dt id="evennia.server.tests.testrunner.EvenniaTestSuiteRunner.build_suite">
|
||||
<code class="sig-name descname">build_suite</code><span class="sig-paren">(</span><em class="sig-param">test_labels</em>, <em class="sig-param">extra_tests=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/tests/testrunner.html#EvenniaTestSuiteRunner.build_suite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.tests.testrunner.EvenniaTestSuiteRunner.build_suite" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Build a test suite for Evennia. test_labels is a list of apps to test.
|
||||
If not given, a subset of settings.INSTALLED_APPS will be used.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.server.tests package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.tests.test_amp_connection">evennia.server.tests.test_amp_connection module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.tests.test_initial_setup">evennia.server.tests.test_initial_setup module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.tests.test_launcher">evennia.server.tests.test_launcher module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.tests.test_misc">evennia.server.tests.test_misc module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.tests.test_server">evennia.server.tests.test_server module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.server.tests.testrunner">evennia.server.tests.testrunner module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.server.tests.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.server.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.server.tests.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.server.tests.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
3893
docs/versions/1.0-dev/api/evennia.typeclasses.html
Normal file
3893
docs/versions/1.0-dev/api/evennia.typeclasses.html
Normal file
File diff suppressed because it is too large
Load diff
9597
docs/versions/1.0-dev/api/evennia.utils.html
Normal file
9597
docs/versions/1.0-dev/api/evennia.utils.html
Normal file
File diff suppressed because one or more lines are too long
786
docs/versions/1.0-dev/api/evennia.utils.idmapper.html
Normal file
786
docs/versions/1.0-dev/api/evennia.utils.idmapper.html
Normal file
|
|
@ -0,0 +1,786 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.utils.idmapper package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.utils.idmapper">
|
||||
<span id="evennia-utils-idmapper-package"></span><h1>evennia.utils.idmapper package<a class="headerlink" href="#module-evennia.utils.idmapper" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The idmapper holds the main database caching mechanism.</p>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.utils.idmapper.manager">
|
||||
<span id="evennia-utils-idmapper-manager-module"></span><h2>evennia.utils.idmapper.manager module<a class="headerlink" href="#module-evennia.utils.idmapper.manager" title="Permalink to this headline">¶</a></h2>
|
||||
<p>IDmapper extension to the default manager.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.manager.SharedMemoryManager">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.manager.</code><code class="sig-name descname">SharedMemoryManager</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/manager.html#SharedMemoryManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.manager.SharedMemoryManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.manager.Manager</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.manager.SharedMemoryManager.get">
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/manager.html#SharedMemoryManager.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.manager.SharedMemoryManager.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Data entity lookup.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.utils.idmapper.models">
|
||||
<span id="evennia-utils-idmapper-models-module"></span><h2>evennia.utils.idmapper.models module<a class="headerlink" href="#module-evennia.utils.idmapper.models" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Django ID mapper</p>
|
||||
<p>Modified for Evennia by making sure that no model references
|
||||
leave caching unexpectedly (no use of WeakRefs).</p>
|
||||
<p>Also adds <cite>cache_size()</cite> for monitoring the size of the cache.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">SharedMemoryModel</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.base.Model</span></code></p>
|
||||
<p>Base class for idmapped objects. Inherit from <cite>this</cite>.</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.Meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.Meta.abstract">
|
||||
<code class="sig-name descname">abstract</code><em class="property"> = False</em><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.Meta.abstract" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel._flush_cached_by_key">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">_flush_cached_by_key</code><span class="sig-paren">(</span><em class="sig-param">key</em>, <em class="sig-param">force=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel._flush_cached_by_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel._flush_cached_by_key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove the cached reference.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel._get_cache_key">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">_get_cache_key</code><span class="sig-paren">(</span><em class="sig-param">args</em>, <em class="sig-param">kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel._get_cache_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel._get_cache_key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method is used by the caching subsystem to infer the PK
|
||||
value from the constructor arguments. It is used to decide if
|
||||
an instance has to be built or is already in the cache.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel._is_deleted">
|
||||
<code class="sig-name descname">_is_deleted</code><em class="property"> = False</em><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel._is_deleted" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for SharedMemoryModel></em><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.at_idmapper_flush">
|
||||
<code class="sig-name descname">at_idmapper_flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.at_idmapper_flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.at_idmapper_flush" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called when the idmapper cache is flushed and
|
||||
allows customized actions when this happens.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><dl class="simple">
|
||||
<dt>If True, flush this object as normal. If</dt><dd><p>False, don’t flush and expect this object to handle
|
||||
the flushing on its own.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>do_flush (bool)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.cache_instance">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">cache_instance</code><span class="sig-paren">(</span><em class="sig-param">instance</em>, <em class="sig-param">new=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.cache_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.cache_instance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method to store an instance in the cache.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>instance</strong> (<em>Class instance</em>) – the instance to cache.</p></li>
|
||||
<li><p><strong>new</strong> (<em>bool</em><em>, </em><em>optional</em>) – this is the first time this instance is
|
||||
cached (i.e. this is not an update operation like after a
|
||||
db save).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.delete">
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete the object, clearing cache.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.flush_cached_instance">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">flush_cached_instance</code><span class="sig-paren">(</span><em class="sig-param">instance</em>, <em class="sig-param">force=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_cached_instance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method to flush an instance from the cache. The instance will
|
||||
always be flushed from the cache, since this is most likely
|
||||
called from delete(), and we want to make sure we don’t cache
|
||||
dead objects.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.flush_from_cache">
|
||||
<code class="sig-name descname">flush_from_cache</code><span class="sig-paren">(</span><em class="sig-param">force=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_from_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_from_cache" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Flush this instance from the instance cache. Use
|
||||
<cite>force</cite> to override the result of at_idmapper_flush() for the object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.flush_instance_cache">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">flush_instance_cache</code><span class="sig-paren">(</span><em class="sig-param">force=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.flush_instance_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.flush_instance_cache" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This will clean safe objects from the cache. Use <cite>force</cite>
|
||||
keyword to remove all objects, safe or not.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.get_all_cached_instances">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">get_all_cached_instances</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.get_all_cached_instances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.get_all_cached_instances" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the objects so far cached by idmapper for this class.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.get_cached_instance">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">get_cached_instance</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.get_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.get_cached_instance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method to retrieve a cached instance by pk value. Returns None
|
||||
when not found (which will always be the case when caching is
|
||||
disabled for this class). Please note that the lookup will be
|
||||
done even when instance caching is disabled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.objects">
|
||||
<code class="sig-name descname">objects</code><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.utils.idmapper.models.SharedMemoryModel'</em><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModel.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Central database save operation.</p>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>Arguments as per Django documentation.
|
||||
Calls <cite>self.at_<fieldname>_postsave(new)</cite>
|
||||
(this is a wrapper set by oobhandler:
|
||||
self._oob_at_<fieldname>_postsave())</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModel.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'SharedMemoryModelBase'</em><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModel.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModelBase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">SharedMemoryModelBase</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModelBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModelBase" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.base.ModelBase</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.SharedMemoryModelBase._prepare">
|
||||
<code class="sig-name descname">_prepare</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#SharedMemoryModelBase._prepare"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.SharedMemoryModelBase._prepare" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepare the cache, making sure that proxies of the same db base
|
||||
share the same cache.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">WeakSharedMemoryModel</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.utils.idmapper.models.SharedMemoryModel" title="evennia.utils.idmapper.models.SharedMemoryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.idmapper.models.SharedMemoryModel</span></code></a></p>
|
||||
<p>Uses a WeakValue dictionary for caching instead of a regular one</p>
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModel.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel.Meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel.Meta.abstract">
|
||||
<code class="sig-name descname">abstract</code><em class="property"> = False</em><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel.Meta.abstract" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel._is_deleted">
|
||||
<code class="sig-name descname">_is_deleted</code><em class="property"> = False</em><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel._is_deleted" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for WeakSharedMemoryModel></em><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.utils.idmapper.models.WeakSharedMemoryModel'</em><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModel.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'WeakSharedMemoryModelBase'</em><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModel.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModelBase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">WeakSharedMemoryModelBase</code><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModelBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModelBase" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.utils.idmapper.models.SharedMemoryModelBase" title="evennia.utils.idmapper.models.SharedMemoryModelBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.idmapper.models.SharedMemoryModelBase</span></code></a></p>
|
||||
<p>Uses a WeakValue dictionary for caching instead of a regular one.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.models.WeakSharedMemoryModelBase._prepare">
|
||||
<code class="sig-name descname">_prepare</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#WeakSharedMemoryModelBase._prepare"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.WeakSharedMemoryModelBase._prepare" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepare the cache, making sure that proxies of the same db base
|
||||
share the same cache.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.utils.idmapper.models._DA">
|
||||
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">_DA</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.utils.idmapper.models._DA" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implement delattr(self, name).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.utils.idmapper.models._GA">
|
||||
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">_GA</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.utils.idmapper.models._GA" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return getattr(self, name).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.utils.idmapper.models._SA">
|
||||
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">_SA</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.utils.idmapper.models._SA" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implement setattr(self, name, value).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.utils.idmapper.models.cache_size">
|
||||
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">cache_size</code><span class="sig-paren">(</span><em class="sig-param">mb=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#cache_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.cache_size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Calculate statistics about the cache.</p>
|
||||
<p>Note: we cannot get reliable memory statistics from the cache -
|
||||
whereas we could do <cite>getsizof</cite> each object in cache, the result is
|
||||
highly imprecise and for a large number of objects the result is
|
||||
many times larger than the actual memory usage of the entire server;
|
||||
Python is clearly reusing memory behind the scenes that we cannot
|
||||
catch in an easy way here. Ideas are appreciated. /Griatch</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>total_num, …}</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>total_num, {objclass</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.utils.idmapper.models.conditional_flush">
|
||||
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">conditional_flush</code><span class="sig-paren">(</span><em class="sig-param">max_rmem</em>, <em class="sig-param">force=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#conditional_flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.conditional_flush" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Flush the cache if the estimated memory usage exceeds <cite>max_rmem</cite>.</p>
|
||||
<p>The flusher has a timeout to avoid flushing over and over
|
||||
in particular situations (this means that for some setups
|
||||
the memory usage will exceed the requirement and a server with
|
||||
more memory is probably required for the given game).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>max_rmem</strong> (<em>int</em>) – memory-usage estimation-treshold after which
|
||||
cache is flushed.</p></li>
|
||||
<li><p><strong>force</strong> (<em>bool</em><em>, </em><em>optional</em>) – forces a flush, regardless of timeout.
|
||||
Defaults to <cite>False</cite>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.utils.idmapper.models.flush_cache">
|
||||
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">flush_cache</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#flush_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.flush_cache" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Flush idmapper cache. When doing so the cache will fire the
|
||||
at_idmapper_flush hook to allow the object to optionally handle
|
||||
its own flushing.</p>
|
||||
<p>Uses a signal so we make sure to catch cascades.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.utils.idmapper.models.flush_cached_instance">
|
||||
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">flush_cached_instance</code><span class="sig-paren">(</span><em class="sig-param">sender</em>, <em class="sig-param">instance</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#flush_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.flush_cached_instance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Flush the idmapper cache only for a given instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.utils.idmapper.models.update_cached_instance">
|
||||
<code class="sig-prename descclassname">evennia.utils.idmapper.models.</code><code class="sig-name descname">update_cached_instance</code><span class="sig-paren">(</span><em class="sig-param">sender</em>, <em class="sig-param">instance</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/models.html#update_cached_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.models.update_cached_instance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Re-cache the given instance in the idmapper cache.</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.utils.idmapper.tests">
|
||||
<span id="evennia-utils-idmapper-tests-module"></span><h2>evennia.utils.idmapper.tests module<a class="headerlink" href="#module-evennia.utils.idmapper.tests" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.tests.Article">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.tests.</code><code class="sig-name descname">Article</code><span class="sig-paren">(</span><em class="sig-param">id</em>, <em class="sig-param">name</em>, <em class="sig-param">category</em>, <em class="sig-param">category2</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#Article"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.Article" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.utils.idmapper.models.SharedMemoryModel" title="evennia.utils.idmapper.models.SharedMemoryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.idmapper.models.SharedMemoryModel</span></code></a></p>
|
||||
<dl class="exception">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.ObjectDoesNotExist</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.MultipleObjectsReturned</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article._is_deleted">
|
||||
<code class="sig-name descname">_is_deleted</code><em class="property"> = False</em><a class="headerlink" href="#evennia.utils.idmapper.tests.Article._is_deleted" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for Article></em><a class="headerlink" href="#evennia.utils.idmapper.tests.Article._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.category">
|
||||
<code class="sig-name descname">category</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related object on the forward side of a many-to-one or
|
||||
one-to-one (via ForwardOneToOneDescriptor subclass) relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'children'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Child.parent</span></code> is a <code class="docutils literal notranslate"><span class="pre">ForwardManyToOneDescriptor</span></code> instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.category2">
|
||||
<code class="sig-name descname">category2</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.category2" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related object on the forward side of a many-to-one or
|
||||
one-to-one (via ForwardOneToOneDescriptor subclass) relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'children'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Child.parent</span></code> is a <code class="docutils literal notranslate"><span class="pre">ForwardManyToOneDescriptor</span></code> instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.category2_id">
|
||||
<code class="sig-name descname">category2_id</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.category2_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.category_id">
|
||||
<code class="sig-name descname">category_id</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.category_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.id">
|
||||
<code class="sig-name descname">id</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.name">
|
||||
<code class="sig-name descname">name</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.utils.idmapper.tests.Article'</em><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Article.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'SharedMemoryModelBase'</em><a class="headerlink" href="#evennia.utils.idmapper.tests.Article.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.tests.Category">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.tests.</code><code class="sig-name descname">Category</code><span class="sig-paren">(</span><em class="sig-param">id</em>, <em class="sig-param">name</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#Category"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.Category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.utils.idmapper.models.SharedMemoryModel" title="evennia.utils.idmapper.models.SharedMemoryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.idmapper.models.SharedMemoryModel</span></code></a></p>
|
||||
<dl class="exception">
|
||||
<dt id="evennia.utils.idmapper.tests.Category.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Category.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.ObjectDoesNotExist</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="evennia.utils.idmapper.tests.Category.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Category.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.MultipleObjectsReturned</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Category._is_deleted">
|
||||
<code class="sig-name descname">_is_deleted</code><em class="property"> = False</em><a class="headerlink" href="#evennia.utils.idmapper.tests.Category._is_deleted" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Category._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for Category></em><a class="headerlink" href="#evennia.utils.idmapper.tests.Category._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Category.article_set">
|
||||
<code class="sig-name descname">article_set</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Category.article_set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related objects manager on the reverse side of a
|
||||
many-to-one relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'children'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Parent.children</span></code> is a <code class="docutils literal notranslate"><span class="pre">ReverseManyToOneDescriptor</span></code> instance.</p>
|
||||
<p>Most of the implementation is delegated to a dynamically defined manager
|
||||
class built by <code class="docutils literal notranslate"><span class="pre">create_forward_many_to_many_manager()</span></code> defined below.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Category.id">
|
||||
<code class="sig-name descname">id</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Category.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Category.name">
|
||||
<code class="sig-name descname">name</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Category.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Category.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.utils.idmapper.tests.Category'</em><a class="headerlink" href="#evennia.utils.idmapper.tests.Category.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Category.regulararticle_set">
|
||||
<code class="sig-name descname">regulararticle_set</code><a class="headerlink" href="#evennia.utils.idmapper.tests.Category.regulararticle_set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related objects manager on the reverse side of a
|
||||
many-to-one relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'children'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Parent.children</span></code> is a <code class="docutils literal notranslate"><span class="pre">ReverseManyToOneDescriptor</span></code> instance.</p>
|
||||
<p>Most of the implementation is delegated to a dynamically defined manager
|
||||
class built by <code class="docutils literal notranslate"><span class="pre">create_forward_many_to_many_manager()</span></code> defined below.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.Category.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'SharedMemoryModelBase'</em><a class="headerlink" href="#evennia.utils.idmapper.tests.Category.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.tests.</code><code class="sig-name descname">RegularArticle</code><span class="sig-paren">(</span><em class="sig-param">id</em>, <em class="sig-param">name</em>, <em class="sig-param">category</em>, <em class="sig-param">category2</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#RegularArticle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.base.Model</span></code></p>
|
||||
<dl class="exception">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.ObjectDoesNotExist</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.MultipleObjectsReturned</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for RegularArticle></em><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.category">
|
||||
<code class="sig-name descname">category</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related object on the forward side of a many-to-one or
|
||||
one-to-one (via ForwardOneToOneDescriptor subclass) relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'children'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Child.parent</span></code> is a <code class="docutils literal notranslate"><span class="pre">ForwardManyToOneDescriptor</span></code> instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.category2">
|
||||
<code class="sig-name descname">category2</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.category2" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related object on the forward side of a many-to-one or
|
||||
one-to-one (via ForwardOneToOneDescriptor subclass) relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'children'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Child.parent</span></code> is a <code class="docutils literal notranslate"><span class="pre">ForwardManyToOneDescriptor</span></code> instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.category2_id">
|
||||
<code class="sig-name descname">category2_id</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.category2_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.category_id">
|
||||
<code class="sig-name descname">category_id</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.category_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.id">
|
||||
<code class="sig-name descname">id</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.name">
|
||||
<code class="sig-name descname">name</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularArticle.objects">
|
||||
<code class="sig-name descname">objects</code><em class="property"> = <django.db.models.manager.Manager object></em><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularArticle.objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.tests.</code><code class="sig-name descname">RegularCategory</code><span class="sig-paren">(</span><em class="sig-param">id</em>, <em class="sig-param">name</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#RegularCategory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.base.Model</span></code></p>
|
||||
<dl class="exception">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.ObjectDoesNotExist</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.core.exceptions.MultipleObjectsReturned</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory._meta">
|
||||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for RegularCategory></em><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory._meta" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory.article_set">
|
||||
<code class="sig-name descname">article_set</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory.article_set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related objects manager on the reverse side of a
|
||||
many-to-one relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'children'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Parent.children</span></code> is a <code class="docutils literal notranslate"><span class="pre">ReverseManyToOneDescriptor</span></code> instance.</p>
|
||||
<p>Most of the implementation is delegated to a dynamically defined manager
|
||||
class built by <code class="docutils literal notranslate"><span class="pre">create_forward_many_to_many_manager()</span></code> defined below.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory.id">
|
||||
<code class="sig-name descname">id</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory.name">
|
||||
<code class="sig-name descname">name</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
|
||||
object the first time, the query is executed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory.objects">
|
||||
<code class="sig-name descname">objects</code><em class="property"> = <django.db.models.manager.Manager object></em><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory.objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.utils.idmapper.tests.RegularCategory.regulararticle_set">
|
||||
<code class="sig-name descname">regulararticle_set</code><a class="headerlink" href="#evennia.utils.idmapper.tests.RegularCategory.regulararticle_set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accessor to the related objects manager on the reverse side of a
|
||||
many-to-one relation.</p>
|
||||
<p>In the example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">'children'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">Parent.children</span></code> is a <code class="docutils literal notranslate"><span class="pre">ReverseManyToOneDescriptor</span></code> instance.</p>
|
||||
<p>Most of the implementation is delegated to a dynamically defined manager
|
||||
class built by <code class="docutils literal notranslate"><span class="pre">create_forward_many_to_many_manager()</span></code> defined below.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="evennia.utils.idmapper.tests.SharedMemorysTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.idmapper.tests.</code><code class="sig-name descname">SharedMemorysTest</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#SharedMemorysTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.SharedMemorysTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.tests.SharedMemorysTest.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#SharedMemorysTest.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.SharedMemorysTest.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.tests.SharedMemorysTest.testMixedReferences">
|
||||
<code class="sig-name descname">testMixedReferences</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#SharedMemorysTest.testMixedReferences"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.SharedMemorysTest.testMixedReferences" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.tests.SharedMemorysTest.testObjectDeletion">
|
||||
<code class="sig-name descname">testObjectDeletion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#SharedMemorysTest.testObjectDeletion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.SharedMemorysTest.testObjectDeletion" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.tests.SharedMemorysTest.testRegularReferences">
|
||||
<code class="sig-name descname">testRegularReferences</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#SharedMemorysTest.testRegularReferences"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.SharedMemorysTest.testRegularReferences" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.utils.idmapper.tests.SharedMemorysTest.testSharedMemoryReferences">
|
||||
<code class="sig-name descname">testSharedMemoryReferences</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/idmapper/tests.html#SharedMemorysTest.testSharedMemoryReferences"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.idmapper.tests.SharedMemorysTest.testSharedMemoryReferences" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.utils.idmapper package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.utils.idmapper.manager">evennia.utils.idmapper.manager module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.utils.idmapper.models">evennia.utils.idmapper.models module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.utils.idmapper.tests">evennia.utils.idmapper.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.utils.idmapper.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.utils.idmapper.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.utils.idmapper.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.utils.idmapper.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
118
docs/versions/1.0-dev/api/evennia.utils.tests.data.html
Normal file
118
docs/versions/1.0-dev/api/evennia.utils.tests.data.html
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.utils.tests.data package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.utils.tests.data">
|
||||
<span id="evennia-utils-tests-data-package"></span><h1>evennia.utils.tests.data package<a class="headerlink" href="#module-evennia.utils.tests.data" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.utils.tests.data.evform_example">
|
||||
<span id="evennia-utils-tests-data-evform-example-module"></span><h2>evennia.utils.tests.data.evform_example module<a class="headerlink" href="#module-evennia.utils.tests.data.evform_example" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Test form</p>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.utils.tests.data.prototypes_example">
|
||||
<span id="evennia-utils-tests-data-prototypes-example-module"></span><h2>evennia.utils.tests.data.prototypes_example module<a class="headerlink" href="#module-evennia.utils.tests.data.prototypes_example" title="Permalink to this headline">¶</a></h2>
|
||||
<p>test_prototypes</p>
|
||||
<p>This is meant to be used with Evennia unittest framework
|
||||
to provide some named prototypes for use with various tests
|
||||
(for example commands that accept named prototypes, not just
|
||||
prototype dictionaries)</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.utils.tests.data package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.utils.tests.data.evform_example">evennia.utils.tests.data.evform_example module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.utils.tests.data.prototypes_example">evennia.utils.tests.data.prototypes_example module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.utils.tests.data.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.utils.tests.data.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.utils.tests.data.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.utils.tests.data.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
1324
docs/versions/1.0-dev/api/evennia.utils.tests.html
Normal file
1324
docs/versions/1.0-dev/api/evennia.utils.tests.html
Normal file
File diff suppressed because it is too large
Load diff
150
docs/versions/1.0-dev/api/evennia.web.html
Normal file
150
docs/versions/1.0-dev/api/evennia.web.html
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.web package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.web">
|
||||
<span id="evennia-web-package"></span><h1>evennia.web package<a class="headerlink" href="#module-evennia.web" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This sub-package holds the web presence of Evennia, using normal
|
||||
Django to relate the database contents to web pages. Also the basic
|
||||
webclient and the website are defined in here (the webserver itself is
|
||||
found under the <cite>server</cite> package).</p>
|
||||
<div class="section" id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.backends">evennia.web.utils.backends module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.general_context">evennia.web.utils.general_context module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.middleware">evennia.web.utils.middleware module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.tests">evennia.web.utils.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.webclient.html">evennia.web.webclient package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.webclient.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.webclient.html#module-evennia.web.webclient.urls">evennia.web.webclient.urls module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.webclient.html#module-evennia.web.webclient.views">evennia.web.webclient.views module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.html">evennia.web.website package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.templatetags.html">evennia.web.website.templatetags package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.templatetags.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.templatetags.html#module-evennia.web.website.templatetags.addclass">evennia.web.website.templatetags.addclass module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.forms">evennia.web.website.forms module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.tests">evennia.web.website.tests module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.urls">evennia.web.website.urls module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.views">evennia.web.website.views module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.web.urls">
|
||||
<span id="evennia-web-urls-module"></span><h2>evennia.web.urls module<a class="headerlink" href="#module-evennia.web.urls" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.web package</a><ul>
|
||||
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.web.urls">evennia.web.urls module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.web.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.web.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
215
docs/versions/1.0-dev/api/evennia.web.utils.html
Normal file
215
docs/versions/1.0-dev/api/evennia.web.utils.html
Normal file
|
|
@ -0,0 +1,215 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.web.utils package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.web.utils">
|
||||
<span id="evennia-web-utils-package"></span><h1>evennia.web.utils package<a class="headerlink" href="#module-evennia.web.utils" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.web.utils.backends">
|
||||
<span id="evennia-web-utils-backends-module"></span><h2>evennia.web.utils.backends module<a class="headerlink" href="#module-evennia.web.utils.backends" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="evennia.web.utils.backends.CaseInsensitiveModelBackend">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.backends.</code><code class="sig-name descname">CaseInsensitiveModelBackend</code><a class="reference internal" href="../_modules/evennia/web/utils/backends.html#CaseInsensitiveModelBackend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.backends.CaseInsensitiveModelBackend" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.backends.ModelBackend</span></code></p>
|
||||
<p>By default ModelBackend does case _sensitive_ username
|
||||
authentication, which isn’t what is generally expected. This
|
||||
backend supports case insensitive username authentication.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.web.utils.backends.CaseInsensitiveModelBackend.authenticate">
|
||||
<code class="sig-name descname">authenticate</code><span class="sig-paren">(</span><em class="sig-param">request</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">autologin=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/backends.html#CaseInsensitiveModelBackend.authenticate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.backends.CaseInsensitiveModelBackend.authenticate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Custom authenticate with bypass for auto-logins</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>request</strong> (<em>Request</em>) – Request object.</p></li>
|
||||
<li><p><strong>username</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of user to authenticate.</p></li>
|
||||
<li><p><strong>password</strong> (<em>str</em><em>, </em><em>optional</em>) – Password of user</p></li>
|
||||
<li><p><strong>autologin</strong> (<em>Account</em><em>, </em><em>optional</em>) – If given, assume this is
|
||||
an already authenticated account and bypass authentication.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.web.utils.general_context">
|
||||
<span id="evennia-web-utils-general-context-module"></span><h2>evennia.web.utils.general_context module<a class="headerlink" href="#module-evennia.web.utils.general_context" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="function">
|
||||
<dt id="evennia.web.utils.general_context.general_context">
|
||||
<code class="sig-prename descclassname">evennia.web.utils.general_context.</code><code class="sig-name descname">general_context</code><span class="sig-paren">(</span><em class="sig-param">request</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/general_context.html#general_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.general_context.general_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns common Evennia-related context stuff, which
|
||||
is automatically added to context of all views.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.web.utils.general_context.set_game_name_and_slogan">
|
||||
<code class="sig-prename descclassname">evennia.web.utils.general_context.</code><code class="sig-name descname">set_game_name_and_slogan</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/general_context.html#set_game_name_and_slogan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.general_context.set_game_name_and_slogan" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets global variables GAME_NAME and GAME_SLOGAN which are used by
|
||||
general_context.</p>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This function is used for unit testing the values of the globals.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="evennia.web.utils.general_context.set_webclient_settings">
|
||||
<code class="sig-prename descclassname">evennia.web.utils.general_context.</code><code class="sig-name descname">set_webclient_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/general_context.html#set_webclient_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.general_context.set_webclient_settings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>As with set_game_name_and_slogan above, this sets global variables pertaining
|
||||
to webclient settings.</p>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>Used for unit testing.</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.web.utils.middleware">
|
||||
<span id="evennia-web-utils-middleware-module"></span><h2>evennia.web.utils.middleware module<a class="headerlink" href="#module-evennia.web.utils.middleware" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.middleware.</code><code class="sig-name descname">SharedLoginMiddleware</code><span class="sig-paren">(</span><em class="sig-param">get_response</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Handle the shared login between website and webclient.</p>
|
||||
<dl class="method">
|
||||
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">get_response</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware.make_shared_login">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">make_shared_login</code><span class="sig-paren">(</span><em class="sig-param">request</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware.make_shared_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware.make_shared_login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-evennia.web.utils.tests">
|
||||
<span id="evennia-web-utils-tests-module"></span><h2>evennia.web.utils.tests module<a class="headerlink" href="#module-evennia.web.utils.tests" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="evennia.web.utils.tests.TestGeneralContext">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.tests.</code><code class="sig-name descname">TestGeneralContext</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/tests.html#TestGeneralContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<dl class="attribute">
|
||||
<dt id="evennia.web.utils.tests.TestGeneralContext.maxDiff">
|
||||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.web.utils.tests.TestGeneralContext.test_general_context">
|
||||
<code class="sig-name descname">test_general_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/tests.html#TestGeneralContext.test_general_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext.test_general_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.web.utils.tests.TestGeneralContext.test_set_game_name_and_slogan">
|
||||
<code class="sig-name descname">test_set_game_name_and_slogan</code><span class="sig-paren">(</span><em class="sig-param">mock_get_version</em>, <em class="sig-param">mock_settings</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/tests.html#TestGeneralContext.test_set_game_name_and_slogan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext.test_set_game_name_and_slogan" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="evennia.web.utils.tests.TestGeneralContext.test_set_webclient_settings">
|
||||
<code class="sig-name descname">test_set_webclient_settings</code><span class="sig-paren">(</span><em class="sig-param">mock_settings</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/tests.html#TestGeneralContext.test_set_webclient_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext.test_set_webclient_settings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.web.utils package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.web.utils.backends">evennia.web.utils.backends module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.web.utils.general_context">evennia.web.utils.general_context module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.web.utils.middleware">evennia.web.utils.middleware module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.web.utils.tests">evennia.web.utils.tests module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.utils.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.utils.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.web.utils.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.web.utils.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
122
docs/versions/1.0-dev/api/evennia.web.webclient.html
Normal file
122
docs/versions/1.0-dev/api/evennia.web.webclient.html
Normal file
|
|
@ -0,0 +1,122 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.web.webclient package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.web.webclient">
|
||||
<span id="evennia-web-webclient-package"></span><h1>evennia.web.webclient package<a class="headerlink" href="#module-evennia.web.webclient" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.web.webclient.urls">
|
||||
<span id="evennia-web-webclient-urls-module"></span><h2>evennia.web.webclient.urls module<a class="headerlink" href="#module-evennia.web.webclient.urls" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This structures the (simple) structure of the
|
||||
webpage ‘application’.</p>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.web.webclient.views">
|
||||
<span id="evennia-web-webclient-views-module"></span><h2>evennia.web.webclient.views module<a class="headerlink" href="#module-evennia.web.webclient.views" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This contains a simple view for rendering the webclient
|
||||
page and serve it eventual static content.</p>
|
||||
<dl class="function">
|
||||
<dt id="evennia.web.webclient.views.webclient">
|
||||
<code class="sig-prename descclassname">evennia.web.webclient.views.</code><code class="sig-name descname">webclient</code><span class="sig-paren">(</span><em class="sig-param">request</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/webclient/views.html#webclient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.webclient.views.webclient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Webclient page template loading.</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.web.webclient package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.web.webclient.urls">evennia.web.webclient.urls module</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.web.webclient.views">evennia.web.webclient.views module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.webclient.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.webclient.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.web.webclient.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.web.webclient.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
1595
docs/versions/1.0-dev/api/evennia.web.website.html
Normal file
1595
docs/versions/1.0-dev/api/evennia.web.website.html
Normal file
File diff suppressed because it is too large
Load diff
113
docs/versions/1.0-dev/api/evennia.web.website.templatetags.html
Normal file
113
docs/versions/1.0-dev/api/evennia.web.website.templatetags.html
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>evennia.web.website.templatetags package — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-evennia.web.website.templatetags">
|
||||
<span id="evennia-web-website-templatetags-package"></span><h1>evennia.web.website.templatetags package<a class="headerlink" href="#module-evennia.web.website.templatetags" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-evennia.web.website.templatetags.addclass">
|
||||
<span id="evennia-web-website-templatetags-addclass-module"></span><h2>evennia.web.website.templatetags.addclass module<a class="headerlink" href="#module-evennia.web.website.templatetags.addclass" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="function">
|
||||
<dt id="evennia.web.website.templatetags.addclass.addclass">
|
||||
<code class="sig-prename descclassname">evennia.web.website.templatetags.addclass.</code><code class="sig-name descname">addclass</code><span class="sig-paren">(</span><em class="sig-param">field</em>, <em class="sig-param">given_class</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/templatetags/addclass.html#addclass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.templatetags.addclass.addclass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<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.web.website.templatetags package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-evennia.web.website.templatetags.addclass">evennia.web.website.templatetags.addclass module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.templatetags.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.templatetags.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../../versions/0.9.1/api/evennia.web.website.templatetags.html">0.9.1 (master branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The Evennia developer community.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/api/evennia.web.website.templatetags.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue