mirror of
https://github.com/evennia/evennia.git
synced 2026-03-30 12:37:16 +02:00
Updated HTML docs
This commit is contained in:
Griatch
parent
1bbc93507a
commit
8c5212d5ff
409 changed files with 17441 additions and 15857 deletions
|
|
@ -46,7 +46,6 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="evennia.settings_default.html">evennia.settings_default</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.html">evennia.accounts</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.accounts.accounts.html">evennia.accounts.accounts</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.accounts.admin.html">evennia.accounts.admin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.accounts.bots.html">evennia.accounts.bots</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.accounts.manager.html">evennia.accounts.manager</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.accounts.models.html">evennia.accounts.models</a></li>
|
||||
|
|
@ -80,7 +79,6 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.html">evennia.comms</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.comms.admin.html">evennia.comms.admin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.comms.comms.html">evennia.comms.comms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.comms.managers.html">evennia.comms.managers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.comms.models.html">evennia.comms.models</a></li>
|
||||
|
|
@ -211,7 +209,6 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.html">evennia.help</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.help.admin.html">evennia.help.admin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html">evennia.help.filehelp</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html">evennia.help.manager</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html">evennia.help.models</a></li>
|
||||
|
|
@ -219,15 +216,11 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.html">evennia.locks</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.locks.lockfuncs.html#mux-name-affects-effect">MUX Name: Affects: Effect:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html">evennia.locks.lockhandler</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.html">evennia.objects</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.objects.admin.html">evennia.objects.admin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.objects.manager.html">evennia.objects.manager</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.objects.models.html">evennia.objects.models</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.objects.objects.html">evennia.objects.objects</a></li>
|
||||
|
|
@ -241,7 +234,6 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.html">evennia.scripts</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.scripts.admin.html">evennia.scripts.admin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.scripts.manager.html">evennia.scripts.manager</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.scripts.models.html">evennia.scripts.models</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.scripts.monitorhandler.html">evennia.scripts.monitorhandler</a></li>
|
||||
|
|
@ -252,7 +244,6 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.html">evennia.server</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.admin.html">evennia.server.admin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.amp_client.html">evennia.server.amp_client</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.connection_wizard.html">evennia.server.connection_wizard</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.server.deprecations.html">evennia.server.deprecations</a></li>
|
||||
|
|
@ -311,7 +302,6 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.html">evennia.typeclasses</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.typeclasses.admin.html">evennia.typeclasses.admin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.typeclasses.attributes.html">evennia.typeclasses.attributes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.typeclasses.managers.html">evennia.typeclasses.managers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.typeclasses.models.html">evennia.typeclasses.models</a></li>
|
||||
|
|
@ -371,16 +361,36 @@
|
|||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.html">evennia.web</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.urls.html">evennia.web.urls</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.html">evennia.web.admin</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.accounts.html">evennia.web.admin.accounts</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.attributes.html">evennia.web.admin.attributes</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.comms.html">evennia.web.admin.comms</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.frontpage.html">evennia.web.admin.frontpage</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.help.html">evennia.web.admin.help</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.objects.html">evennia.web.admin.objects</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.scripts.html">evennia.web.admin.scripts</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.server.html">evennia.web.admin.server</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.tags.html">evennia.web.admin.tags</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.urls.html">evennia.web.admin.urls</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.admin.utils.html">evennia.web.admin.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.api.html">evennia.web.api</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.api.filters.html">evennia.web.api.filters</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.api.permissions.html">evennia.web.api.permissions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.api.root.html">evennia.web.api.root</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.api.serializers.html">evennia.web.api.serializers</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.api.tests.html">evennia.web.api.tests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.api.urls.html">evennia.web.api.urls</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.api.views.html">evennia.web.api.views</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.templatetags.html">evennia.web.templatetags</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.templatetags.addclass.html">evennia.web.templatetags.addclass</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.adminsite.html">evennia.web.utils.adminsite</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.backends.html">evennia.web.utils.backends</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.general_context.html">evennia.web.utils.general_context</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.utils.middleware.html">evennia.web.utils.middleware</a></li>
|
||||
|
|
@ -396,9 +406,15 @@
|
|||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.forms.html">evennia.web.website.forms</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.tests.html">evennia.web.website.tests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.urls.html">evennia.web.website.urls</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.templatetags.html">evennia.web.website.templatetags</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.templatetags.addclass.html">evennia.web.website.templatetags.addclass</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.views.accounts.html">evennia.web.website.views.accounts</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.views.channels.html">evennia.web.website.views.channels</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.views.characters.html">evennia.web.website.views.characters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.views.errors.html">evennia.web.website.views.errors</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.views.help.html">evennia.web.website.views.help</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.views.index.html">evennia.web.website.views.index</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.views.mixins.html">evennia.web.website.views.mixins</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.views.objects.html">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
|
||||
<section id="module-evennia.accounts.accounts">
|
||||
<span id="evennia-accounts-accounts"></span><h1>evennia.accounts.accounts<a class="headerlink" href="#module-evennia.accounts.accounts" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Typeclass for Account objects</p>
|
||||
<p>Typeclass for Account objects.</p>
|
||||
<p>Note that this object is primarily intended to
|
||||
store OOC information, not game info! This
|
||||
object represents the actual user (not their
|
||||
|
|
@ -455,8 +455,9 @@ error (ValidationError, None): Any validation error(s) raised. Multiple</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This is called by Django also when logging in; it should not be mixed up with validation, since that
|
||||
would mean old passwords in the database (pre validation checks) could get invalidated.</p>
|
||||
<p>This is called by Django also when logging in; it should not be mixed up with
|
||||
validation, since that would mean old passwords in the database (pre validation checks)
|
||||
could get invalidated.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
|
|||
|
|
@ -1,411 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.accounts.admin — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.accounts.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.accounts.admin">
|
||||
<span id="evennia-accounts-admin"></span><h1>evennia.accounts.admin<a class="headerlink" href="#module-evennia.accounts.admin" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountDBChangeForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.accounts.admin.</code><code class="sig-name descname">AccountDBChangeForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBChangeForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBChangeForm" 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.forms.UserChangeForm</span></code></p>
|
||||
<p>Modify the accountdb class.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountDBChangeForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBChangeForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBChangeForm.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="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBChangeForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.accounts.admin.AccountDBChangeForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBChangeForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBChangeForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountDBChangeForm.clean_username">
|
||||
<code class="sig-name descname">clean_username</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBChangeForm.clean_username"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBChangeForm.clean_username" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Clean the username and check its existence.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBChangeForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'date_joined': <django.forms.fields.DateTimeField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_is_bot': <django.forms.fields.BooleanField object>, 'db_is_connected': <django.forms.fields.BooleanField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.CharField object>, 'email': <django.forms.fields.EmailField object>, 'first_name': <django.forms.fields.CharField object>, 'groups': <django.forms.models.ModelMultipleChoiceField object>, 'is_active': <django.forms.fields.BooleanField object>, 'is_staff': <django.forms.fields.BooleanField object>, 'is_superuser': <django.forms.fields.BooleanField object>, 'last_login': <django.forms.fields.DateTimeField object>, 'last_name': <django.forms.fields.CharField object>, 'password': <django.contrib.auth.forms.ReadOnlyPasswordHashField object>, 'user_permissions': <django.forms.models.ModelMultipleChoiceField object>, 'username': <django.forms.fields.RegexField object>}</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBChangeForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBChangeForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'password': <django.contrib.auth.forms.ReadOnlyPasswordHashField object>, 'username': <django.forms.fields.RegexField object>}</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBChangeForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountDBChangeForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.accounts.admin.AccountDBChangeForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountDBCreationForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.accounts.admin.</code><code class="sig-name descname">AccountDBCreationForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBCreationForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBCreationForm" 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.forms.UserCreationForm</span></code></p>
|
||||
<p>Create a new AccountDB instance.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountDBCreationForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBCreationForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBCreationForm.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="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBCreationForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.accounts.admin.AccountDBCreationForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBCreationForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBCreationForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountDBCreationForm.clean_username">
|
||||
<code class="sig-name descname">clean_username</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBCreationForm.clean_username"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBCreationForm.clean_username" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cleanup username.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBCreationForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'date_joined': <django.forms.fields.DateTimeField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_is_bot': <django.forms.fields.BooleanField object>, 'db_is_connected': <django.forms.fields.BooleanField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.CharField object>, 'email': <django.forms.fields.EmailField object>, 'first_name': <django.forms.fields.CharField object>, 'groups': <django.forms.models.ModelMultipleChoiceField object>, 'is_active': <django.forms.fields.BooleanField object>, 'is_staff': <django.forms.fields.BooleanField object>, 'is_superuser': <django.forms.fields.BooleanField object>, 'last_login': <django.forms.fields.DateTimeField object>, 'last_name': <django.forms.fields.CharField object>, 'password': <django.forms.fields.CharField object>, 'password1': <django.forms.fields.CharField object>, 'password2': <django.forms.fields.CharField object>, 'user_permissions': <django.forms.models.ModelMultipleChoiceField object>, 'username': <django.forms.fields.RegexField object>}</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBCreationForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBCreationForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'password1': <django.forms.fields.CharField object>, 'password2': <django.forms.fields.CharField object>, 'username': <django.forms.fields.RegexField object>}</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBCreationForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountDBCreationForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.accounts.admin.AccountDBCreationForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.accounts.admin.</code><code class="sig-name descname">AccountForm</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/accounts/admin.html#AccountForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountForm" 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 Accounts</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountForm.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="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.accounts.admin.AccountForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.accounts.admin.AccountForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountForm.Meta.app_label">
|
||||
<code class="sig-name descname">app_label</code><em class="property"> = 'accounts'</em><a class="headerlink" href="#evennia.accounts.admin.AccountForm.Meta.app_label" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'date_joined': <django.forms.fields.DateTimeField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_is_bot': <django.forms.fields.BooleanField object>, 'db_is_connected': <django.forms.fields.BooleanField object>, 'db_key': <django.forms.fields.RegexField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_permissions': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.CharField object>, 'email': <django.forms.fields.EmailField object>, 'first_name': <django.forms.fields.CharField object>, 'groups': <django.forms.models.ModelMultipleChoiceField object>, 'is_active': <django.forms.fields.BooleanField object>, 'is_staff': <django.forms.fields.BooleanField object>, 'is_superuser': <django.forms.fields.BooleanField object>, 'last_login': <django.forms.fields.DateTimeField object>, 'last_name': <django.forms.fields.CharField object>, 'password': <django.forms.fields.CharField object>, 'user_permissions': <django.forms.models.ModelMultipleChoiceField object>, 'username': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.accounts.admin.AccountForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_key': <django.forms.fields.RegexField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_permissions': <django.forms.fields.CharField object>, 'db_typeclass_path': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.accounts.admin.AccountForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.accounts.admin.AccountForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.accounts.admin.</code><code class="sig-name descname">AccountInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountInline" 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.StackedInline</span></code></p>
|
||||
<p>Inline creation of Account</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.accounts.admin.AccountInline.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountInline.template">
|
||||
<code class="sig-name descname">template</code><em class="property"> = 'admin/accounts/stacked.html'</em><a class="headerlink" href="#evennia.accounts.admin.AccountInline.template" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountInline.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.accounts.admin.AccountInline.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.accounts.admin.AccountForm" title="evennia.accounts.admin.AccountForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountInline.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = (('In-game Permissions and Locks', {'fields': ('db_lock_storage',), 'description': '<i>These are permissions/locks for in-game use. They are unrelated to website access rights.</i>'}), ('In-game Account data', {'fields': ('db_typeclass_path', 'db_cmdset_storage'), 'description': '<i>These fields define in-game-specific properties for the Account object in-game.</i>'}))</em><a class="headerlink" href="#evennia.accounts.admin.AccountInline.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountInline.extra">
|
||||
<code class="sig-name descname">extra</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.accounts.admin.AccountInline.extra" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountInline.max_num">
|
||||
<code class="sig-name descname">max_num</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.accounts.admin.AccountInline.max_num" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.accounts.admin.AccountInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.accounts.admin.</code><code class="sig-name descname">AccountTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.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>
|
||||
<p>Inline Account Tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.accounts.admin.AccountTagInline.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.accounts.models.AccountDB_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'accountdb'</em><a class="headerlink" href="#evennia.accounts.admin.AccountTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.accounts.admin.AccountTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountAttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.accounts.admin.</code><code class="sig-name descname">AccountAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountAttributeInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.html#evennia.typeclasses.admin.AttributeInline" title="evennia.typeclasses.admin.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.admin.AttributeInline</span></code></a></p>
|
||||
<p>Inline Account Attributes.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountAttributeInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.accounts.admin.AccountAttributeInline.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.accounts.models.AccountDB_db_attributes</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountAttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'accountdb'</em><a class="headerlink" href="#evennia.accounts.admin.AccountAttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountAttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.accounts.admin.AccountAttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.accounts.admin.</code><code class="sig-name descname">AccountDBAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin" 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.admin.UserAdmin</span></code></p>
|
||||
<p>This is the main creation screen for Users/accounts</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('username', 'email', 'is_staff', 'is_superuser')</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.accounts.admin.AccountDBChangeForm" title="evennia.accounts.admin.AccountDBChangeForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountDBChangeForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.add_form">
|
||||
<code class="sig-name descname">add_form</code><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.add_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.accounts.admin.AccountDBCreationForm" title="evennia.accounts.admin.AccountDBCreationForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountDBCreationForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.accounts.admin.AccountTagInline'>, <class 'evennia.accounts.admin.AccountAttributeInline'>]</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': ('username', 'password', 'email')}), ('Website profile', {'fields': ('first_name', 'last_name'), 'description': '<i>These are not used in the default system.</i>'}), ('Website dates', {'fields': ('last_login', 'date_joined'), 'description': '<i>Relevant only to the website.</i>'}), ('Website Permissions', {'fields': ('is_active', 'is_staff', 'is_superuser', 'user_permissions', 'groups'), 'description': '<i>These are permissions/permission groups for accessing the admin site. They are unrelated to in-game access rights.</i>'}), ('Game Options', {'fields': ('db_typeclass_path', 'db_cmdset_storage', 'db_lock_storage'), 'description': '<i>These are attributes that are more relevant to gameplay.</i>'}))</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.add_fieldsets">
|
||||
<code class="sig-name descname">add_fieldsets</code><em class="property"> = ((None, {'fields': ('username', 'password1', 'password2', 'email'), 'description': '<i>These account details are shared by the admin system and the game.</i>'}),)</em><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.add_fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.user_change_password">
|
||||
<code class="sig-name descname">user_change_password</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">form_url</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBAdmin.user_change_password"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.user_change_password" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.save_model">
|
||||
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.save_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Custom save actions.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – Object to save.</p></li>
|
||||
<li><p><strong>form</strong> (<em>Form</em>) – Related form instance.</p></li>
|
||||
<li><p><strong>change</strong> (<em>bool</em>) – False if this is a new save and not an update.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.response_add">
|
||||
<code class="sig-name descname">response_add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">post_url_continue</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/admin.html#AccountDBAdmin.response_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.response_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determine the HttpResponse for the add_view stage. It mostly defers to
|
||||
its superclass implementation but is customized because the User model
|
||||
has a slightly different workflow.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.admin.AccountDBAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.accounts.admin.AccountDBAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.accounts.admin.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.accounts.admin.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.accounts.admin.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.accounts.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -46,7 +46,6 @@ more Objects depending on settings. An Account has no in-game existence.</p>
|
|||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.accounts.html">evennia.accounts.accounts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.admin.html">evennia.accounts.admin</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.bots.html">evennia.accounts.bots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.manager.html">evennia.accounts.manager</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.models.html">evennia.accounts.models</a></li>
|
||||
|
|
|
|||
|
|
@ -177,7 +177,7 @@ to the central <strong>cmdhandler.get_and_merge_cmdsets()</strong>!</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.cmdsethandler.CmdSetHandler.add">
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdset</span></em>, <em class="sig-param"><span class="n">emit_to_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">permanent</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">default_cmdset</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/cmdsethandler.html#CmdSetHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.cmdsethandler.CmdSetHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdset</span></em>, <em class="sig-param"><span class="n">emit_to_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">default_cmdset</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/cmdsethandler.html#CmdSetHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.cmdsethandler.CmdSetHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a cmdset to the handler, on top of the old ones, unless it
|
||||
is set as the default one (it will then end up at the bottom of the stack)</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -187,8 +187,6 @@ is set as the default one (it will then end up at the bottom of the stack)</p>
|
|||
to such an object.</p></li>
|
||||
<li><p><strong>emit_to_obj</strong> (<em>Object</em><em>, </em><em>optional</em>) – An object to receive error messages.</p></li>
|
||||
<li><p><strong>persistent</strong> (<em>bool</em><em>, </em><em>optional</em>) – Let cmdset remain across server reload.</p></li>
|
||||
<li><p><strong>permanent</strong> (<em>bool</em><em>, </em><em>optional</em>) – DEPRECATED. This has the same use as
|
||||
<strong>persistent</strong>.</p></li>
|
||||
<li><p><strong>default_cmdset</strong> (<em>Cmdset</em><em>, </em><em>optional</em>) – Insert this to replace the
|
||||
default cmdset position (there is only one such position,
|
||||
always at the bottom of the stack).</p></li>
|
||||
|
|
@ -209,14 +207,14 @@ it’s a ‘quirk’ that has to be documented.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.cmdsethandler.CmdSetHandler.add_default">
|
||||
<code class="sig-name descname">add_default</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdset</span></em>, <em class="sig-param"><span class="n">emit_to_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">permanent</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/cmdsethandler.html#CmdSetHandler.add_default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.cmdsethandler.CmdSetHandler.add_default" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add_default</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdset</span></em>, <em class="sig-param"><span class="n">emit_to_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/cmdsethandler.html#CmdSetHandler.add_default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.cmdsethandler.CmdSetHandler.add_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Shortcut for adding a default cmdset.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cmdset</strong> (<em>Cmdset</em>) – The Cmdset to add.</p></li>
|
||||
<li><p><strong>emit_to_obj</strong> (<em>Object</em><em>, </em><em>optional</em>) – Gets error messages</p></li>
|
||||
<li><p><strong>permanent</strong> (<em>bool</em><em>, </em><em>optional</em>) – The new Cmdset should survive a server reboot.</p></li>
|
||||
<li><p><strong>persistent</strong> (<em>bool</em><em>, </em><em>optional</em>) – The new Cmdset should survive a server reboot.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
|
|
|||
|
|
@ -567,7 +567,7 @@ also for those with all permissions.</p>
|
|||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>testing which colors your client support</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>color ansi||xterm256</p>
|
||||
<dt>Usage:</dt><dd><p>color ansi | xterm256</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Prints a color map along with in-mud color codes to use to produce
|
||||
|
|
@ -640,7 +640,7 @@ Takes a table of columns [[val,val,…],[val,val,…],…]</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.account.CmdColorTest.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'color', 'tags': '', 'text': '\n testing which colors your client support\n\n Usage:\n color ansi||xterm256\n\n Prints a color map along with in-mud color codes to use to produce\n them. It also tests what is supported in your client. Choices are\n 16-color ansi (supported in most muds) or the 256-color xterm256\n standard. No checking is done to determine your client supports\n color - if not you will see rubbish appear.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'color', 'tags': '', 'text': '\n testing which colors your client support\n\n Usage:\n color ansi | xterm256\n\n Prints a color map along with in-mud color codes to use to produce\n them. It also tests what is supported in your client. Choices are\n 16-color ansi (supported in most muds) or the 256-color xterm256\n standard. No checking is done to determine your client supports\n color - if not you will see rubbish appear.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ skipping, reloading etc.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.batchprocess.CmdBatchCommands.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['batchcommand', 'batchcmd']</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['batchcmd', 'batchcommand']</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -107,7 +107,7 @@ skipping, reloading etc.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'batchcommand batchcmd', 'category': 'building', 'key': 'batchcommands', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'batchcmd batchcommand', 'category': 'building', 'key': 'batchcommands', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -530,7 +530,7 @@ You can specify the /force switch to bypass this confirmation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdDestroy.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['del', 'delete']</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['delete', 'del']</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -571,7 +571,7 @@ You can specify the /force switch to bypass this confirmation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdDestroy.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'del delete', 'category': 'building', 'key': 'destroy', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delete del', 'category': 'building', 'key': 'destroy', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -1269,7 +1269,7 @@ server settings.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdTypeclass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['update', 'swap', 'parent', 'type']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['type', 'update', 'swap', 'parent']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -1300,7 +1300,7 @@ server settings.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdTypeclass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'update swap parent type', 'category': 'building', 'key': 'typeclass', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object.\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'type update swap parent', 'category': 'building', 'key': 'typeclass', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object.\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -1584,7 +1584,7 @@ one is given.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdFind.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['locate', 'search']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['search', 'locate']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -1615,7 +1615,7 @@ one is given.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdFind.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'locate search', 'category': 'building', 'key': 'find', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'search locate', 'category': 'building', 'key': 'find', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -261,7 +261,7 @@ inv</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdInventory.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'inv']</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['inv', 'i']</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -292,7 +292,7 @@ inv</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdInventory.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -642,7 +642,7 @@ automatically begin with your name.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdPose.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['emote', ':']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':', 'emote']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -678,7 +678,7 @@ space.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdPose.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'emote :', 'category': 'general', 'key': 'pose', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -386,7 +386,7 @@ given, <nr> defaults to 10.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.system.CmdObjects.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['stats', 'db', 'listobjects', 'listobjs']</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['listobjects', 'stats', 'listobjs', 'db']</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -412,7 +412,7 @@ given, <nr> defaults to 10.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.system.CmdObjects.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'stats db listobjects listobjs', 'category': 'system', 'key': 'objects', 'tags': '', 'text': '\n statistics on objects in the database\n\n Usage:\n objects [<nr>]\n\n Gives statictics on objects in database as well as\n a list of <nr> latest objects in database. If not\n given, <nr> defaults to 10.\n '}</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'listobjects stats listobjs db', 'category': 'system', 'key': 'objects', 'tags': '', 'text': '\n statistics on objects in the database\n\n Usage:\n objects [<nr>]\n\n Gives statictics on objects in database as well as\n a list of <nr> latest objects in database. If not\n given, <nr> defaults to 10.\n '}</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ connect “account name” “pass word”</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['conn', 'co', 'con']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -95,7 +95,7 @@ there is no object yet before the account has logged in)</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -174,7 +174,7 @@ version is a bit more complicated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -200,7 +200,7 @@ version is a bit more complicated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -224,7 +224,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -250,7 +250,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -273,7 +273,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['h', '?']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -299,7 +299,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -1,300 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.comms.admin — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.comms.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.comms.admin">
|
||||
<span id="evennia-comms-admin"></span><h1>evennia.comms.admin<a class="headerlink" href="#module-evennia.comms.admin" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This defines how Comm models are displayed in the web admin interface.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.comms.admin.ChannelAttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.comms.admin.</code><code class="sig-name descname">ChannelAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/admin.html#ChannelAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.admin.ChannelAttributeInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.html#evennia.typeclasses.admin.AttributeInline" title="evennia.typeclasses.admin.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.admin.AttributeInline</span></code></a></p>
|
||||
<p>Inline display of Channel Attribute - experimental</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAttributeInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.comms.admin.ChannelAttributeInline.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.comms.models.ChannelDB_db_attributes</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'channeldb'</em><a class="headerlink" href="#evennia.comms.admin.ChannelAttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.admin.ChannelAttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.comms.admin.ChannelAttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.comms.admin.ChannelTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.comms.admin.</code><code class="sig-name descname">ChannelTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/admin.html#ChannelTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.admin.ChannelTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.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>
|
||||
<p>Inline display of Channel Tags - experimental</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.comms.admin.ChannelTagInline.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.comms.models.ChannelDB_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'channeldb'</em><a class="headerlink" href="#evennia.comms.admin.ChannelTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.admin.ChannelTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.comms.admin.ChannelTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.comms.admin.MsgAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.comms.admin.</code><code class="sig-name descname">MsgAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/admin.html#MsgAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.admin.MsgAdmin" 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>Defines display for Msg objects</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.MsgAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_date_created', 'db_sender', 'db_receivers', 'db_channels', 'db_message', 'db_lock_storage')</em><a class="headerlink" href="#evennia.comms.admin.MsgAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.MsgAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id',)</em><a class="headerlink" href="#evennia.comms.admin.MsgAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.MsgAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['db_date_created', 'db_sender', 'db_receivers', 'db_channels']</em><a class="headerlink" href="#evennia.comms.admin.MsgAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.MsgAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['id', '^db_date_created', '^db_message']</em><a class="headerlink" href="#evennia.comms.admin.MsgAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.MsgAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.comms.admin.MsgAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.MsgAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.comms.admin.MsgAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.MsgAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.comms.admin.MsgAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.admin.MsgAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.comms.admin.MsgAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.comms.admin.</code><code class="sig-name descname">ChannelAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/admin.html#ChannelAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin" 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>Defines display for Channel objects</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.comms.admin.ChannelTagInline'>, <class 'evennia.comms.admin.ChannelAttributeInline'>]</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_lock_storage', 'subscriptions')</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['db_key']</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['id', 'db_key', 'db_tags__db_key']</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.raw_id_fields">
|
||||
<code class="sig-name descname">raw_id_fields</code><em class="property"> = ('db_object_subscriptions', 'db_account_subscriptions')</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.raw_id_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key',), 'db_lock_storage', 'db_account_subscriptions', 'db_object_subscriptions')}),)</em><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.subscriptions">
|
||||
<code class="sig-name descname">subscriptions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/admin.html#ChannelAdmin.subscriptions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.subscriptions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Helper method to get subs from a channel.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<em>Channel</em>) – The channel to get subs from.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.save_model">
|
||||
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/admin.html#ChannelAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.save_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Model-save hook.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – Database object.</p></li>
|
||||
<li><p><strong>form</strong> (<em>Form</em>) – Form instance.</p></li>
|
||||
<li><p><strong>change</strong> (<em>bool</em>) – If this is a change or a new object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.response_add">
|
||||
<code class="sig-name descname">response_add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">post_url_continue</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/admin.html#ChannelAdmin.response_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.response_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determine the HttpResponse for the add_view stage.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.admin.ChannelAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.comms.admin.ChannelAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.comms.admin.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.comms.admin.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.comms.admin.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.comms.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -649,11 +649,11 @@ this object.</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 ‘channel-detail’ would be referenced by this method.</p>
|
||||
<p>ex.
|
||||
url(r’channels/(?P<slug>[wd-]+)/$’,</p>
|
||||
<blockquote>
|
||||
<div><p>ChannelDetailView.as_view(), name=’channel-detail’)</p>
|
||||
</div></blockquote>
|
||||
<p>ex.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'channels/(?P<slug>[\w\d\-]+)/$'</span><span class="p">,</span>
|
||||
<span class="n">ChannelDetailView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'channel-detail'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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
|
||||
|
|
@ -675,11 +675,11 @@ object.</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 ‘channel-update’ would be referenced by this method.</p>
|
||||
<p>ex.
|
||||
url(r’channels/(?P<slug>[wd-]+)/(?P<pk>[0-9]+)/change/$’,</p>
|
||||
<blockquote>
|
||||
<div><p>ChannelUpdateView.as_view(), name=’channel-update’)</p>
|
||||
</div></blockquote>
|
||||
<p>ex.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'channels/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/change/$'</span><span class="p">,</span>
|
||||
<span class="n">ChannelUpdateView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'channel-update'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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
|
||||
|
|
@ -726,11 +726,11 @@ this object.</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 ‘channel-detail’ would be referenced by this method.</p>
|
||||
<p>ex.
|
||||
url(r’channels/(?P<slug>[wd-]+)/$’,</p>
|
||||
<blockquote>
|
||||
<div><p>ChannelDetailView.as_view(), name=’channel-detail’)</p>
|
||||
</div></blockquote>
|
||||
<p>ex.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'channels/(?P<slug>[\w\d\-]+)/$'</span><span class="p">,</span>
|
||||
<span class="n">ChannelDetailView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'channel-detail'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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
|
||||
|
|
|
|||
|
|
@ -45,7 +45,6 @@ handlers for in-game communication via channels and messages as well
|
|||
as code related to external communication like IRC or RSS.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.comms.admin.html">evennia.comms.admin</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.comms.comms.html">evennia.comms.comms</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.comms.managers.html">evennia.comms.managers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.comms.models.html">evennia.comms.models</a></li>
|
||||
|
|
|
|||
|
|
@ -424,9 +424,8 @@ object the first time, the query is executed.</p>
|
|||
<dt id="evennia.comms.models.TempMsg">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.comms.models.</code><code class="sig-name descname">TempMsg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">senders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">receivers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">header</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">lockstring</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">hide_from</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#TempMsg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.TempMsg" 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 is a non-persistent object for sending temporary messages
|
||||
that will not be stored. It mimics the “real” Msg object, but
|
||||
doesn’t require sender to be given.</p>
|
||||
<p>This is a non-persistent object for sending temporary messages that will not be stored. It
|
||||
mimics the “real” Msg object, but doesn’t require sender to be given.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.TempMsg.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">senders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">receivers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">header</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">lockstring</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">hide_from</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#TempMsg.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.TempMsg.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
|
|
@ -629,7 +629,7 @@ inv</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'inv']</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['inv', 'i']</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -660,7 +660,7 @@ inv</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -75,7 +75,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['conn', 'co', 'con']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -105,7 +105,7 @@ there is no object yet before the account has logged in)</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -182,7 +182,7 @@ version is a bit more complicated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -208,7 +208,7 @@ version is a bit more complicated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -227,7 +227,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -253,7 +253,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -271,7 +271,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['h', '?']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -297,7 +297,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -148,7 +148,7 @@ the operation will be general or on the room.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdGiveUp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['chicken out', 'quit', 'q', 'abort']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdGiveUp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['abort', 'q', 'quit', 'chicken out']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdGiveUp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -172,7 +172,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdGiveUp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chicken out quit q abort', 'category': 'evscaperoom', 'key': 'give up', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'abort q quit chicken out', 'category': 'evscaperoom', 'key': 'give up', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -308,7 +308,7 @@ shout</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdSpeak.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [';', 'whisper', 'shout']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdSpeak.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [';', 'shout', 'whisper']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdSpeak.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -337,7 +337,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdSpeak.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '; whisper shout', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdSpeak.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '; shout whisper', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdSpeak.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -427,7 +427,7 @@ looks and what actions is available.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdFocus.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ex', 'examine', 'unfocus', 'e']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdFocus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ex', 'examine', 'e', 'unfocus']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdFocus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -456,7 +456,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdFocus.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ex examine unfocus e', 'category': 'evscaperoom', 'key': 'focus', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdFocus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ex examine e unfocus', 'category': 'evscaperoom', 'key': 'focus', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdFocus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -518,7 +518,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdGet.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'inventory', 'give', 'inv']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdGet.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['inv', 'i', 'give', 'inventory']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdGet.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -542,7 +542,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdGet.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i inventory give inv', 'category': 'evscaperoom', 'key': 'get', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdGet.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'inv i give inventory', 'category': 'evscaperoom', 'key': 'get', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdGet.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -563,7 +563,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdRerouter.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@open', '@dig']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdRerouter.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@dig', '@open']</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdRerouter.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -586,7 +586,7 @@ to all the variables defined therein.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.commands.CmdRerouter.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@open @dig', 'category': 'general', 'key': 'open', 'tags': '', 'text': '\n Interact with an object in focus.\n\n Usage:\n <action> [arg]\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdRerouter.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@dig @open', 'category': 'general', 'key': 'open', 'tags': '', 'text': '\n Interact with an object in focus.\n\n Usage:\n <action> [arg]\n\n '}</em><a class="headerlink" href="#evennia.contrib.evscaperoom.commands.CmdRerouter.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ such as when closing the lid and un-blinding a character.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_examples.red_button.CmdPushLidClosed.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdPushLidClosed.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'push', 'press']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdPushLidClosed.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -109,7 +109,7 @@ check if the lid is open or closed.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_examples.red_button.CmdPushLidClosed.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdPushLidClosed.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button push press', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdPushLidClosed.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -179,7 +179,7 @@ check if the lid is open or closed.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_examples.red_button.CmdSmashGlass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['smash', 'smash lid', 'break lid']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdSmashGlass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['break lid', 'smash', 'smash lid']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdSmashGlass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -206,7 +206,7 @@ break.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_examples.red_button.CmdSmashGlass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'smash smash lid break lid', 'category': 'general', 'key': 'smash glass', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'break lid smash smash lid', 'category': 'general', 'key': 'smash glass', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -306,7 +306,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_examples.red_button.CmdPushLidOpen.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdPushLidOpen.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'push', 'press']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdPushLidOpen.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -335,7 +335,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_examples.red_button.CmdPushLidOpen.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdPushLidOpen.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button push press', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdPushLidOpen.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -433,7 +433,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_examples.red_button.CmdBlindLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ex', 'get', 'listen', 'l', 'feel', 'examine']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdBlindLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'feel', 'listen', 'examine', 'get', 'ex']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdBlindLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -459,7 +459,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_examples.red_button.CmdBlindLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ex get listen l feel examine', 'category': 'general', 'key': 'look', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l feel listen examine get ex', 'category': 'general', 'key': 'look', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -493,7 +493,7 @@ shift green root up/down</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['move', 'pull', 'push', 'shiftroot']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['move', 'push', 'pull', 'shiftroot']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -529,7 +529,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'move pull push shiftroot', 'category': 'tutorialworld', 'key': 'shift', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'move push pull shiftroot', 'category': 'tutorialworld', 'key': 'shift', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -546,7 +546,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['push button', 'button', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'push button', 'button']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -572,7 +572,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push button button press button', 'category': 'tutorialworld', 'key': 'press', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button push button button', 'category': 'tutorialworld', 'key': 'press', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -716,7 +716,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['thrust', 'parry', 'hit', 'pierce', 'fight', 'stab', 'kill', 'slash', 'bash', 'chop', 'defend']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['stab', 'pierce', 'thrust', 'parry', 'chop', 'defend', 'hit', 'slash', 'fight', 'bash', 'kill']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -742,7 +742,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'thrust parry hit pierce fight stab kill slash bash chop defend', 'category': 'tutorialworld', 'key': 'attack', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'stab pierce thrust parry chop defend hit slash fight bash kill', 'category': 'tutorialworld', 'key': 'attack', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -714,7 +714,7 @@ if they fall off the bridge.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['h', '?']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -740,7 +740,7 @@ if they fall off the bridge.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h ?', 'category': 'tutorial world', 'key': 'help', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -866,7 +866,7 @@ to find something.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['fiddle', 'search', 'l', 'feel', 'feel around']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'feel', 'fiddle', 'search', 'feel around']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -894,7 +894,7 @@ random chance of eventually finding a light source.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'fiddle search l feel feel around', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l feel fiddle search feel around', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@
|
|||
will be treated as non-command help entries and displayed in the same way as
|
||||
help entries created using the <strong>sethelp</strong> default command. After changing an
|
||||
entry on-disk you need to reload the server to have the change show in-game.</p>
|
||||
<p>An filehelp file is a regular python modules with dicts representing each help
|
||||
<p>An filehelp file is a regular python module with dicts representing each help
|
||||
entry. If a list <strong>HELP_ENTRY_DICTS</strong> is found in the module, this should be a list of
|
||||
dicts. Otherwise <em>all</em> top-level dicts in the module will be assumed to be a
|
||||
help-entry dict.</p>
|
||||
|
|
@ -52,20 +52,20 @@ help-entry dict.</p>
|
|||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'key'</span><span class="p">:</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span>
|
||||
<span class="s1">'category'</span><span class="p">:</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="c1"># optional, otherwise settings.DEFAULT_HELP_CATEGORY</span>
|
||||
<span class="s1">'aliases'</span><span class="p">:</span> <span class="o"><</span><span class="nb">list</span><span class="o">></span><span class="p">,</span> <span class="c1"># optional</span>
|
||||
<span class="s1">'text'</span><span class="p">:</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">}</span><span class="o">****</span>
|
||||
<span class="s1">'text'</span><span class="p">:</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>where the <strong>**category**</strong> is optional and the <strong>**text**</strong> should be formatted on the
|
||||
<p>where the <strong>category</strong> is optional and the <strong>text**</strong> should be formatted on the
|
||||
same form as other help entry-texts and contain <strong>**# subtopics**</strong> as normal.</p>
|
||||
<p>New help-entry modules are added to the system by providing the python-path to
|
||||
the module to <strong>settings.FILE_HELP_ENTRY_MODULES</strong>. Note that if same-key entries are
|
||||
added, entries in latter modules will override that of earlier ones. Use
|
||||
<strong>**settings.DEFAULT_HELP_CATEGORY**</strong> to customize what category is used if
|
||||
<strong>settings.DEFAULT_HELP_CATEGORY**</strong> to customize what category is used if
|
||||
not set explicitly.</p>
|
||||
<p>An example of the contents of a module:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">help_entry1</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s2">"key"</span><span class="p">:</span> <span class="s2">"The Gods"</span><span class="p">,</span> <span class="c1"># case-insensitive, can be searched by 'gods' as well</span>
|
||||
<span class="s2">"aliases"</span><span class="p">:</span> <span class="p">[</span><span class="s1">'pantheon'</span><span class="p">,</span> <span class="s1">'religion'</span><span class="p">]</span>
|
||||
<span class="s2">"key"</span><span class="p">:</span> <span class="s2">"The Gods"</span><span class="p">,</span> <span class="c1"># case-insensitive, also partial-matching ('gods') works</span>
|
||||
<span class="s2">"aliases"</span><span class="p">:</span> <span class="p">[</span><span class="s1">'pantheon'</span><span class="p">,</span> <span class="s1">'religion'</span><span class="p">],</span>
|
||||
<span class="s2">"category"</span><span class="p">:</span> <span class="s2">"Lore"</span><span class="p">,</span>
|
||||
<span class="s2">"text"</span><span class="p">:</span> <span class="s1">'''</span>
|
||||
<span class="s1"> The gods formed the world ...</span>
|
||||
|
|
|
|||
|
|
@ -46,7 +46,6 @@ The auto-cmd-help is rather handled by the default ‘help’ command
|
|||
itself.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.help.admin.html">evennia.help.admin</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.help.filehelp.html">evennia.help.filehelp</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.help.manager.html">evennia.help.manager</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.help.models.html">evennia.help.models</a></li>
|
||||
|
|
|
|||
|
|
@ -106,8 +106,8 @@ class built by <strong>**create_forward_many_to_many_manager()**</strong> define
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.help.models.HelpEntry.db_date_created">
|
||||
<code class="sig-name descname">db_date_created</code><a class="headerlink" href="#evennia.help.models.HelpEntry.db_date_created" 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>
|
||||
|
|
@ -168,8 +168,10 @@ instances of this object.</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>ex.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'characters/create/'</span><span class="p">,</span> <span class="n">ChargenView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-create'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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
|
||||
|
|
@ -191,11 +193,11 @@ this object.</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>ex.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/$'</span><span class="p">,</span>
|
||||
<span class="n">CharDetailView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-detail'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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
|
||||
|
|
@ -217,11 +219,11 @@ object.</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>ex.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/change/$'</span><span class="p">,</span>
|
||||
<span class="n">CharUpdateView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-update'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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
|
||||
|
|
@ -242,11 +244,11 @@ responsibility.</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>ex.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/delete/$'</span><span class="p">,</span>
|
||||
<span class="n">CharDeleteView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-delete'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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
|
||||
|
|
@ -268,11 +270,11 @@ this object.</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>ex.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/$'</span><span class="p">,</span>
|
||||
<span class="n">CharDetailView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-detail'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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
|
||||
|
|
@ -297,12 +299,28 @@ responsibility.</p>
|
|||
<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="py method">
|
||||
<dt id="evennia.help.models.HelpEntry.date_created">
|
||||
<em class="property">property </em><code class="sig-name descname">date_created</code><a class="headerlink" href="#evennia.help.models.HelpEntry.date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <strong>db_date_created</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py 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 <strong>db_entrytext</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.help.models.HelpEntry.get_next_by_db_date_created">
|
||||
<code class="sig-name descname">get_next_by_db_date_created</code><span class="sig-paren">(</span><em class="sig-param">*</em>, <em class="sig-param">field=<django.db.models.fields.DateTimeField: db_date_created></em>, <em class="sig-param">is_next=True</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.help.models.HelpEntry.get_next_by_db_date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.help.models.HelpEntry.get_previous_by_db_date_created">
|
||||
<code class="sig-name descname">get_previous_by_db_date_created</code><span class="sig-paren">(</span><em class="sig-param">*</em>, <em class="sig-param">field=<django.db.models.fields.DateTimeField: db_date_created></em>, <em class="sig-param">is_next=False</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.help.models.HelpEntry.get_previous_by_db_date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
|
|
@ -333,12 +351,6 @@ object the first time, the query is executed.</p>
|
|||
<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="py 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 <strong>db_staff_only</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
|
|
|
|||
|
|
@ -142,7 +142,6 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.html">evennia.accounts</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.accounts.html">evennia.accounts.accounts</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.admin.html">evennia.accounts.admin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.bots.html">evennia.accounts.bots</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.manager.html">evennia.accounts.manager</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.accounts.models.html">evennia.accounts.models</a></li>
|
||||
|
|
@ -176,7 +175,6 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.comms.html">evennia.comms</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.admin.html">evennia.comms.admin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.comms.html">evennia.comms.comms</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.managers.html">evennia.comms.managers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.comms.models.html">evennia.comms.models</a></li>
|
||||
|
|
@ -307,7 +305,6 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.help.html">evennia.help</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.admin.html">evennia.help.admin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.filehelp.html">evennia.help.filehelp</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.manager.html">evennia.help.manager</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html">evennia.help.models</a></li>
|
||||
|
|
@ -315,15 +312,11 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.locks.html">evennia.locks</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockfuncs.html#mux-name-affects-effect">MUX Name: Affects: Effect:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockhandler.html">evennia.locks.lockhandler</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.objects.html">evennia.objects</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.admin.html">evennia.objects.admin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.manager.html">evennia.objects.manager</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.models.html">evennia.objects.models</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.objects.objects.html">evennia.objects.objects</a></li>
|
||||
|
|
@ -337,7 +330,6 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.scripts.html">evennia.scripts</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.admin.html">evennia.scripts.admin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.manager.html">evennia.scripts.manager</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.models.html">evennia.scripts.models</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.scripts.monitorhandler.html">evennia.scripts.monitorhandler</a></li>
|
||||
|
|
@ -348,7 +340,6 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.server.html">evennia.server</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.admin.html">evennia.server.admin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.amp_client.html">evennia.server.amp_client</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.connection_wizard.html">evennia.server.connection_wizard</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.server.deprecations.html">evennia.server.deprecations</a></li>
|
||||
|
|
@ -407,7 +398,6 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.typeclasses.html">evennia.typeclasses</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.admin.html">evennia.typeclasses.admin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.attributes.html">evennia.typeclasses.attributes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.managers.html">evennia.typeclasses.managers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.typeclasses.models.html">evennia.typeclasses.models</a></li>
|
||||
|
|
@ -467,16 +457,36 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.html">evennia.web</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.urls.html">evennia.web.urls</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.html">evennia.web.admin</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.accounts.html">evennia.web.admin.accounts</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.attributes.html">evennia.web.admin.attributes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.comms.html">evennia.web.admin.comms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.frontpage.html">evennia.web.admin.frontpage</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.help.html">evennia.web.admin.help</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.objects.html">evennia.web.admin.objects</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.scripts.html">evennia.web.admin.scripts</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.server.html">evennia.web.admin.server</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.tags.html">evennia.web.admin.tags</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.urls.html">evennia.web.admin.urls</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.admin.utils.html">evennia.web.admin.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.html">evennia.web.api</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.api.filters.html">evennia.web.api.filters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.api.permissions.html">evennia.web.api.permissions</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.api.root.html">evennia.web.api.root</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.api.serializers.html">evennia.web.api.serializers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.api.tests.html">evennia.web.api.tests</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.api.urls.html">evennia.web.api.urls</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.api.views.html">evennia.web.api.views</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.templatetags.html">evennia.web.templatetags</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.templatetags.addclass.html">evennia.web.templatetags.addclass</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.adminsite.html">evennia.web.utils.adminsite</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.backends.html">evennia.web.utils.backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.general_context.html">evennia.web.utils.general_context</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.utils.middleware.html">evennia.web.utils.middleware</a></li>
|
||||
|
|
@ -492,9 +502,15 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.forms.html">evennia.web.website.forms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.tests.html">evennia.web.website.tests</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.urls.html">evennia.web.website.urls</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.templatetags.html">evennia.web.website.templatetags</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.templatetags.addclass.html">evennia.web.website.templatetags.addclass</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.accounts.html">evennia.web.website.views.accounts</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.channels.html">evennia.web.website.views.channels</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.characters.html">evennia.web.website.views.characters</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.errors.html">evennia.web.website.views.errors</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.help.html">evennia.web.website.views.help</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.index.html">evennia.web.website.views.index</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.mixins.html">evennia.web.website.views.mixins</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.views.objects.html">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -45,10 +45,7 @@ lock strings are processed through the lockhandler in this package. It
|
|||
also contains the default lock functions used in lock definitions.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#mux-name-affects-effect">MUX Name: Affects: Effect:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.locks.lockhandler.html">evennia.locks.lockhandler</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -49,106 +49,6 @@ Run the <strong>access()</strong> method of the handler to execute the lock chec
|
|||
<p>Note that <strong>accessing_obj</strong> and <strong>accessed_obj</strong> can be any object type
|
||||
with a lock variable/field, so be careful to not expect
|
||||
a certain object type.</p>
|
||||
<p><strong>Appendix: MUX locks</strong></p>
|
||||
<p>Below is a list nicked from the MUX help file on the locks available
|
||||
in standard MUX. Most of these are not relevant to core Evennia since
|
||||
locks in Evennia are considerably more flexible and can be implemented
|
||||
on an individual command/typeclass basis rather than as globally
|
||||
available like the MUX ones. So many of these are not available in
|
||||
basic Evennia, but could all be implemented easily if needed for the
|
||||
individual game.</p>
|
||||
<section id="mux-name-affects-effect">
|
||||
<h2>MUX Name: Affects: Effect:<a class="headerlink" href="#mux-name-affects-effect" title="Permalink to this headline">¶</a></h2>
|
||||
<dl>
|
||||
<dt>DefaultLock: Exits: controls who may traverse the exit to</dt><dd><blockquote>
|
||||
<div><blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>its destination.</dt><dd><p>Evennia: “traverse:<lockfunc()>”</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl>
|
||||
<dt>Rooms: controls whether the account sees the</dt><dd><p>SUCC or FAIL message for the room
|
||||
following the room description when
|
||||
looking at the room.</p>
|
||||
<blockquote>
|
||||
<div><p>Evennia: Custom typeclass</p>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
<dt>Accounts/Things: controls who may GET the object.</dt><dd><p>Evennia: “get:<lockfunc()”</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl>
|
||||
<dt>EnterLock: Accounts/Things: controls who may ENTER the object</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
<dt>GetFromLock: All but Exits: controls who may gets things from a</dt><dd><dl class="simple">
|
||||
<dt>given location.</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>GiveLock: Accounts/Things: controls who may give the object.</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
<dt>LeaveLock: Accounts/Things: controls who may LEAVE the object.</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
<dt>LinkLock: All but Exits: controls who may link to the location</dt><dd><p>if the location is LINK_OK (for linking
|
||||
exits or setting drop-tos) or ABODE (for
|
||||
setting homes)</p>
|
||||
<blockquote>
|
||||
<div><p>Evennia:</p>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
<dt>MailLock: Accounts: controls who may @mail the account.</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
<dt>OpenLock: All but Exits: controls who may open an exit.</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
<dt>PageLock: Accounts: controls who may page the account.</dt><dd><p>Evennia: “send:<lockfunc()>”</p>
|
||||
</dd>
|
||||
<dt>ParentLock: All: controls who may make @parent links to</dt><dd><dl class="simple">
|
||||
<dt>the object.</dt><dd><p>Evennia: Typeclasses and</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>“puppet:<lockstring()>”</p>
|
||||
</dd>
|
||||
<dt>ReceiveLock: Accounts/Things: controls who may give things to the</dt><dd><dl class="simple">
|
||||
<dt>object.</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>SpeechLock: All but Exits: controls who may speak in that location</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
<dt>TeloutLock: All but Exits: controls who may teleport out of the</dt><dd><dl class="simple">
|
||||
<dt>location.</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>TportLock: Rooms/Things: controls who may teleport there</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
<dt>UseLock: All but Exits: controls who may USE the object, GIVE</dt><dd><p>the object money and have the PAY
|
||||
attributes run, have their messages
|
||||
heard and possibly acted on by LISTEN
|
||||
and AxHEAR, and invoke $-commands
|
||||
stored on the object.</p>
|
||||
<blockquote>
|
||||
<div><p>Evennia: Commands and Cmdsets.</p>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
<dt>DropLock: All but rooms: controls who may drop that object.</dt><dd><p>Evennia:</p>
|
||||
</dd>
|
||||
<dt>VisibleLock: All: Controls object visibility when the</dt><dd><p>object is not dark and the looker
|
||||
passes the lock. In DARK locations, the
|
||||
object must also be set LIGHT and the
|
||||
viewer must pass the VisibleLock.</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>Evennia: Room typeclass with</dt><dd><p>Dark/light script</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.locks.lockfuncs.true">
|
||||
<code class="sig-prename descclassname">evennia.locks.lockfuncs.</code><code class="sig-name descname">true</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/locks/lockfuncs.html#true"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.locks.lockfuncs.true" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -171,6 +71,11 @@ viewer must pass the VisibleLock.</p>
|
|||
<code class="sig-prename descclassname">evennia.locks.lockfuncs.</code><code class="sig-name descname">none</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/locks/lockfuncs.html#none"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.locks.lockfuncs.none" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.locks.lockfuncs.superuser">
|
||||
<code class="sig-prename descclassname">evennia.locks.lockfuncs.</code><code class="sig-name descname">superuser</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/locks/lockfuncs.html#superuser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.locks.lockfuncs.superuser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.locks.lockfuncs.self">
|
||||
<code class="sig-prename descclassname">evennia.locks.lockfuncs.</code><code class="sig-name descname">self</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">accessing_obj</span></em>, <em class="sig-param"><span class="n">accessed_obj</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/locks/lockfuncs.html#self"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.locks.lockfuncs.self" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -462,15 +367,6 @@ accessed_obj.location == accessing_obj), or if accessing_obj itself holds
|
|||
an object matching the given key.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.locks.lockfuncs.superuser">
|
||||
<code class="sig-prename descclassname">evennia.locks.lockfuncs.</code><code class="sig-name descname">superuser</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/locks/lockfuncs.html#superuser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.locks.lockfuncs.superuser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Only accepts an accesing_obj that is superuser (e.g. user #1)</p>
|
||||
<p>Since a superuser would not ever reach this check (superusers
|
||||
bypass the lock entirely), any user who gets this far cannot be a
|
||||
superuser, hence we just return False. :)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.locks.lockfuncs.has_account">
|
||||
<code class="sig-prename descclassname">evennia.locks.lockfuncs.</code><code class="sig-name descname">has_account</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">accessing_obj</span></em>, <em class="sig-param"><span class="n">accessed_obj</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/locks/lockfuncs.html#has_account"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.locks.lockfuncs.has_account" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -495,7 +391,6 @@ everything will enter this function as strings, so they have to be
|
|||
unpacked to their real value. We only support basic properties.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -518,14 +413,6 @@ unpacked to their real value. We only support basic properties.</p>
|
|||
</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.locks.lockfuncs</a><ul>
|
||||
<li><a class="reference internal" href="#mux-name-affects-effect">MUX Name: Affects: Effect:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
|
|
|
|||
|
|
@ -1,370 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.objects.admin — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.objects.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.objects.admin">
|
||||
<span id="evennia-objects-admin"></span><h1>evennia.objects.admin<a class="headerlink" href="#module-evennia.objects.admin" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.objects.admin.ObjectAttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.objects.admin.</code><code class="sig-name descname">ObjectAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectAttributeInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.html#evennia.typeclasses.admin.AttributeInline" title="evennia.typeclasses.admin.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.admin.AttributeInline</span></code></a></p>
|
||||
<p>Defines inline descriptions of Attributes (experimental)</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectAttributeInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.objects.admin.ObjectAttributeInline.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.objects.models.ObjectDB_db_attributes</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectAttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'objectdb'</em><a class="headerlink" href="#evennia.objects.admin.ObjectAttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectAttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.objects.admin.ObjectAttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.objects.admin.ObjectTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.objects.admin.</code><code class="sig-name descname">ObjectTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.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>
|
||||
<p>Defines inline descriptions of Tags (experimental)</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.objects.admin.ObjectTagInline.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.objects.models.ObjectDB_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'objectdb'</em><a class="headerlink" href="#evennia.objects.admin.ObjectTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.objects.admin.ObjectTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.objects.admin.ObjectCreateForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.objects.admin.</code><code class="sig-name descname">ObjectCreateForm</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/objects/admin.html#ObjectCreateForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectCreateForm" 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>This form details the look of the fields.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.objects.admin.ObjectCreateForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectCreateForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectCreateForm.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="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectCreateForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.objects.admin.ObjectCreateForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.models.ObjectDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectCreateForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.objects.admin.ObjectCreateForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectCreateForm.raw_id_fields">
|
||||
<code class="sig-name descname">raw_id_fields</code><em class="property"> = ('db_destination', 'db_location', 'db_home')</em><a class="headerlink" href="#evennia.objects.admin.ObjectCreateForm.raw_id_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectCreateForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_account': <django.forms.models.ModelChoiceField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_destination': <django.forms.models.ModelChoiceField object>, 'db_home': <django.forms.models.ModelChoiceField object>, 'db_key': <django.forms.fields.CharField object>, 'db_location': <django.forms.models.ModelChoiceField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_sessid': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.objects.admin.ObjectCreateForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectCreateForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_key': <django.forms.fields.CharField object>, 'db_typeclass_path': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.objects.admin.ObjectCreateForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectCreateForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.objects.admin.ObjectCreateForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.objects.admin.ObjectEditForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.objects.admin.</code><code class="sig-name descname">ObjectEditForm</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/objects/admin.html#ObjectEditForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectEditForm" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.objects.admin.ObjectCreateForm" title="evennia.objects.admin.ObjectCreateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.admin.ObjectCreateForm</span></code></a></p>
|
||||
<p>Form used for editing. Extends the create one with more fields</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.objects.admin.ObjectEditForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectEditForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectEditForm.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="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectEditForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.objects.admin.ObjectEditForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectEditForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_typeclass_path': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.objects.admin.ObjectEditForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectEditForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_typeclass_path': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.objects.admin.ObjectEditForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectEditForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.objects.admin.ObjectEditForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.objects.admin.</code><code class="sig-name descname">ObjectDBAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectDBAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin" 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>Describes the admin page for Objects.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.objects.admin.ObjectTagInline'>, <class 'evennia.objects.admin.ObjectAttributeInline'>]</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_account', 'db_typeclass_path')</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['db_account', 'db_typeclass_path', 'id']</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['=id', '^db_key', 'db_typeclass_path', '^db_account__db_key']</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.raw_id_fields">
|
||||
<code class="sig-name descname">raw_id_fields</code><em class="property"> = ('db_destination', 'db_location', 'db_home')</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.raw_id_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.list_filter">
|
||||
<code class="sig-name descname">list_filter</code><em class="property"> = ('db_typeclass_path',)</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.list_filter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.objects.admin.ObjectEditForm" title="evennia.objects.admin.ObjectEditForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectEditForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_typeclass_path'), ('db_lock_storage',), ('db_location', 'db_home'), 'db_destination', 'db_cmdset_storage')}),)</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.add_form">
|
||||
<code class="sig-name descname">add_form</code><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.add_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.objects.admin.ObjectCreateForm" title="evennia.objects.admin.ObjectCreateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectCreateForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.add_fieldsets">
|
||||
<code class="sig-name descname">add_fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_typeclass_path'), ('db_location', 'db_home'), 'db_destination', 'db_cmdset_storage')}),)</em><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.add_fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.get_fieldsets">
|
||||
<code class="sig-name descname">get_fieldsets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectDBAdmin.get_fieldsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.get_fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return fieldsets.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><em>ObjectDB</em></a><em>, </em><em>optional</em>) – Database object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.get_form">
|
||||
<code class="sig-name descname">get_form</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectDBAdmin.get_form"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.get_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use special form during creation.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em><em>, </em><em>optional</em>) – Database object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.save_model">
|
||||
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectDBAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.save_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Model-save hook.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – Database object.</p></li>
|
||||
<li><p><strong>form</strong> (<em>Form</em>) – Form instance.</p></li>
|
||||
<li><p><strong>change</strong> (<em>bool</em>) – If this is a change or a new object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.response_add">
|
||||
<code class="sig-name descname">response_add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">post_url_continue</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/admin.html#ObjectDBAdmin.response_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.response_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determine the HttpResponse for the add_view stage.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.admin.ObjectDBAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.objects.admin.ObjectDBAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.objects.admin.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.objects.admin.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.objects.admin.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.objects.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -44,7 +44,6 @@
|
|||
objects inherit from classes in this package.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.objects.admin.html">evennia.objects.admin</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.objects.manager.html">evennia.objects.manager</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.objects.models.html">evennia.objects.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.objects.objects.html">evennia.objects.objects</a></li>
|
||||
|
|
|
|||
|
|
@ -49,8 +49,7 @@ entities.</p>
|
|||
<dt id="evennia.objects.objects.ObjectSessionHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.objects.objects.</code><code class="sig-name descname">ObjectSessionHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#ObjectSessionHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.ObjectSessionHandler" 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>Handles the get/setting of the sessid
|
||||
comma-separated integer field</p>
|
||||
<p>Handles the get/setting of the sessid comma-separated integer field</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.ObjectSessionHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#ObjectSessionHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.ObjectSessionHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -725,8 +724,8 @@ specified, the copy will be named <old_key>_copy by default.</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_object_post_copy">
|
||||
<code class="sig-name descname">at_object_post_copy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">new_obj</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultObject.at_object_post_copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_object_post_copy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called by DefaultObject.copy(). Meant to be overloaded. In case there’s extra data not covered by
|
||||
.copy(), this can be used to deal with it.</p>
|
||||
<dd><p>Called by DefaultObject.copy(). Meant to be overloaded. In case there’s extra data not
|
||||
covered by .copy(), this can be used to deal with it.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>new_obj</strong> (<em>Object</em>) – The new Copy of this object.</p>
|
||||
|
|
@ -1408,7 +1407,8 @@ text from the object. Returning <strong>None</strong> aborts the command.</p>
|
|||
a say. This is sent by the whisper command by default.
|
||||
Other verbal commands could use this hook in similar
|
||||
ways.</p></li>
|
||||
<li><p><strong>receivers</strong> (<em>Object</em><em> or </em><em>iterable</em>) – If set, this is the target or targets for the say/whisper.</p></li>
|
||||
<li><p><strong>receivers</strong> (<em>Object</em><em> or </em><em>iterable</em>) – If set, this is the target or targets for the
|
||||
say/whisper.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -1433,8 +1433,8 @@ re-writing it completely.</p>
|
|||
<li><p><strong>msg_self</strong> (<em>bool</em><em> or </em><em>str</em><em>, </em><em>optional</em>) – If boolean True, echo <strong>message</strong> to self. If a string,
|
||||
return that message. If False or unset, don’t echo to self.</p></li>
|
||||
<li><p><strong>msg_location</strong> (<em>str</em><em>, </em><em>optional</em>) – The message to echo to self’s location.</p></li>
|
||||
<li><p><strong>receivers</strong> (<em>Object</em><em> or </em><em>iterable</em><em>, </em><em>optional</em>) – An eventual receiver or receivers of the message
|
||||
(by default only used by whispers).</p></li>
|
||||
<li><p><strong>receivers</strong> (<em>Object</em><em> or </em><em>iterable</em><em>, </em><em>optional</em>) – An eventual receiver or receivers of the
|
||||
message (by default only used by whispers).</p></li>
|
||||
<li><p><strong>msg_receivers</strong> (<em>str</em>) – Specific message to pass to the receiver(s). This will parsed
|
||||
with the {receiver} placeholder replaced with the given receiver.</p></li>
|
||||
</ul>
|
||||
|
|
@ -1539,9 +1539,10 @@ errors (list): A list of errors in string form, if any.</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultCharacter.normalize_name">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">normalize_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultCharacter.normalize_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultCharacter.normalize_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Normalize the character name prior to creating. Note that this should be refactored
|
||||
to support i18n for non-latin scripts, but as we (currently) have no bug reports requesting better
|
||||
support of non-latin character sets, requiring character names to be latinified is an acceptable option.</p>
|
||||
<dd><p>Normalize the character name prior to creating. Note that this should be refactored to
|
||||
support i18n for non-latin scripts, but as we (currently) have no bug reports requesting
|
||||
better support of non-latin character sets, requiring character names to be latinified is an
|
||||
acceptable option.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the character</p>
|
||||
|
|
@ -1770,7 +1771,8 @@ overriding the call (unused by default).</p></li>
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>A string with identifying information to disambiguate the command, conventionally with a preceding space.</p>
|
||||
<dd class="field-even"><p>A string with identifying information to disambiguate the command, conventionally with a
|
||||
preceding space.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ prototype_locks (str, optional): locks for restricting access to this prototype.
|
|||
<dl class="simple">
|
||||
<dt>prototype_tags(list, optional): List of tags or tuples (tag, category) used to group prototype</dt><dd><p>in listings</p>
|
||||
</dd>
|
||||
<dt>prototype_parent (str, tuple or callable, optional): name (prototype_key) of eventual parent prototype, or</dt><dd><p>a list of parents, for multiple left-to-right inheritance.</p>
|
||||
<dt>prototype_parent (str, tuple or callable, optional): name (prototype_key) of eventual parent</dt><dd><p>prototype, or a list of parents, for multiple left-to-right inheritance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>prototype: Deprecated. Same meaning as ‘parent’.</p>
|
||||
|
|
@ -225,8 +225,8 @@ attr/tag (for example) are represented by a tuple.</p></li>
|
|||
This is most useful for displaying.</p></li>
|
||||
<li><p><strong>implicit_keep</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set, the resulting diff will assume KEEP unless the new
|
||||
prototype explicitly change them. That is, if a key exists in <strong>prototype1</strong> and
|
||||
not in <strong>prototype2</strong>, it will not be REMOVEd but set to KEEP instead. This is particularly
|
||||
useful for auto-generated prototypes when updating objects.</p></li>
|
||||
not in <strong>prototype2</strong>, it will not be REMOVEd but set to KEEP instead. This is
|
||||
particularly useful for auto-generated prototypes when updating objects.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
|
|
|
|||
|
|
@ -1,235 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.scripts.admin — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.scripts.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.scripts.admin">
|
||||
<span id="evennia-scripts-admin"></span><h1>evennia.scripts.admin<a class="headerlink" href="#module-evennia.scripts.admin" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.scripts.admin.ScriptTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.admin.</code><code class="sig-name descname">ScriptTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/admin.html#ScriptTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.admin.ScriptTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.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>
|
||||
<p>Inline script tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.scripts.admin.ScriptTagInline.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.scripts.models.ScriptDB_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'scriptdb'</em><a class="headerlink" href="#evennia.scripts.admin.ScriptTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.scripts.admin.ScriptTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.scripts.admin.ScriptTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.scripts.admin.ScriptAttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.admin.</code><code class="sig-name descname">ScriptAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/admin.html#ScriptAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.admin.ScriptAttributeInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.html#evennia.typeclasses.admin.AttributeInline" title="evennia.typeclasses.admin.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.admin.AttributeInline</span></code></a></p>
|
||||
<p>Inline attribute tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptAttributeInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.scripts.admin.ScriptAttributeInline.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.scripts.models.ScriptDB_db_attributes</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptAttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'scriptdb'</em><a class="headerlink" href="#evennia.scripts.admin.ScriptAttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.scripts.admin.ScriptAttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.scripts.admin.ScriptAttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.admin.</code><code class="sig-name descname">ScriptDBAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/admin.html#ScriptDBAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin" 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>Displaying the main Script page.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_typeclass_path', 'db_obj', 'db_interval', 'db_repeats', 'db_persistent')</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['db_obj', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['^db_key', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.raw_id_fields">
|
||||
<code class="sig-name descname">raw_id_fields</code><em class="property"> = ('db_obj',)</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.raw_id_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_typeclass_path'), 'db_interval', 'db_repeats', 'db_start_delay', 'db_persistent', 'db_obj')}),)</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.scripts.admin.ScriptTagInline'>, <class 'evennia.scripts.admin.ScriptAttributeInline'>]</em><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.save_model">
|
||||
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/admin.html#ScriptDBAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.save_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Model-save hook.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – Database object.</p></li>
|
||||
<li><p><strong>form</strong> (<em>Form</em>) – Form instance.</p></li>
|
||||
<li><p><strong>change</strong> (<em>bool</em>) – If this is a change or a new object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.scripts.admin.ScriptDBAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.scripts.admin.ScriptDBAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.scripts.admin.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.scripts.admin.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.scripts.admin.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.scripts.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -46,7 +46,6 @@ or globally. They may also have a timer-component to execute various
|
|||
timed effects.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.scripts.admin.html">evennia.scripts.admin</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.scripts.manager.html">evennia.scripts.manager</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.scripts.models.html">evennia.scripts.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.scripts.monitorhandler.html">evennia.scripts.monitorhandler</a></li>
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ called(self): A task attribute to check if the deferred instance of a task has b
|
|||
<dt id="id0">
|
||||
<code class="sig-name descname">pause</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.pause"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id0" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Pause the callback of a task.
|
||||
To resume use TaskHandlerTask.unpause</p>
|
||||
To resume use <strong>TaskHandlerTask.unpause</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -441,8 +441,7 @@ Deletes the instance of the task’s deferred.</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.scripts.taskhandler.TaskHandler.clear">
|
||||
<code class="sig-name descname">clear</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">save</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">cancel</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandler.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.taskhandler.TaskHandler.clear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>clear all tasks.
|
||||
By default tasks are canceled and removed from the database also.</p>
|
||||
<dd><p>Clear all tasks. By default tasks are canceled and removed from the database as well.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
|
|||
|
|
@ -46,7 +46,6 @@ connected users as well as defines all the connection protocols used
|
|||
to connect to the game.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.server.admin.html">evennia.server.admin</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.server.amp_client.html">evennia.server.amp_client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.server.connection_wizard.html">evennia.server.connection_wizard</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.server.deprecations.html">evennia.server.deprecations</a></li>
|
||||
|
|
|
|||
|
|
@ -437,13 +437,13 @@ that way.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.server.portal.amp.AMPMultiConnectionProtocol.errback">
|
||||
<code class="sig-name descname">errback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">e</span></em>, <em class="sig-param"><span class="n">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/amp.html#AMPMultiConnectionProtocol.errback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.amp.AMPMultiConnectionProtocol.errback" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">errback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">err</span></em>, <em class="sig-param"><span class="n">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/amp.html#AMPMultiConnectionProtocol.errback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.amp.AMPMultiConnectionProtocol.errback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Error callback.
|
||||
Handles errors to avoid dropping connections on server tracebacks.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>e</strong> (<em>Failure</em>) – Deferred error instance.</p></li>
|
||||
<li><p><strong>err</strong> (<em>Failure</em>) – Deferred error instance.</p></li>
|
||||
<li><p><strong>info</strong> (<em>str</em>) – Error string.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
|
||||
<section id="module-evennia.server.portal.portalsessionhandler">
|
||||
<span id="evennia-server-portal-portalsessionhandler"></span><h1>evennia.server.portal.portalsessionhandler<a class="headerlink" href="#module-evennia.server.portal.portalsessionhandler" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Sessionhandler for portal sessions</p>
|
||||
<p>Sessionhandler for portal sessions.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.server.portal.portalsessionhandler.PortalSessionHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.portal.portalsessionhandler.</code><code class="sig-name descname">PortalSessionHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/portalsessionhandler.html#PortalSessionHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.portalsessionhandler.PortalSessionHandler" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ sessions etc.</p>
|
|||
<dt id="evennia.server.portal.telnet.TelnetServerFactory">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.portal.telnet.</code><code class="sig-name descname">TelnetServerFactory</code><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetServerFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetServerFactory" 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.ServerFactory</span></code></p>
|
||||
<p>This is only to name this better in logs</p>
|
||||
<p>This exists only to name this better in logs.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.server.portal.telnet.TelnetServerFactory.noisy">
|
||||
<code class="sig-name descname">noisy</code><em class="property"> = False</em><a class="headerlink" href="#evennia.server.portal.telnet.TelnetServerFactory.noisy" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -94,7 +94,7 @@ of incoming data.</p>
|
|||
<dd><p>Allow to toggle the NOP keepalive for those sad clients that
|
||||
can’t even handle a NOP instruction. This is turned off by the
|
||||
protocol_flag NOPKEEPALIVE (settable e.g. by the default
|
||||
<strong>@option</strong> command).</p>
|
||||
<strong>option</strong> command).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -202,7 +202,7 @@ directly.</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.server.portal.telnet.TelnetProtocol.disconnect">
|
||||
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">reason</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.disconnect" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>generic hook for the engine to call in order to
|
||||
<dd><p>Generic hook for the engine to call in order to
|
||||
disconnect this protocol.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
|
|||
|
|
@ -172,6 +172,11 @@ mode operation (at startup)</p>
|
|||
<code class="sig-name descname">mode_keepalive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/webclient_ajax.html#AjaxWebClient.mode_keepalive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.webclient_ajax.AjaxWebClient.mode_keepalive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called by render_POST when the
|
||||
client is replying to the keepalive.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>request</strong> (<em>Request</em>) – Incoming request.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
|
|||
|
|
@ -151,7 +151,7 @@ of it is fore a reload, reset or shutdown.</p>
|
|||
after reconnecting.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>mode</strong> (<em>str</em>) – One of reload, reset or shutdown.</p>
|
||||
<dd class="field-odd"><p><strong>mode</strong> (<em>str</em>) – One of ‘reload’, ‘reset’ or ‘shutdown’.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -121,8 +121,7 @@ FuncParser using callables from <strong>settings.FUNCPARSER_OUTGOING_MESSAGES_MO
|
|||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>session</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a>) – The relevant session instance.</p></li>
|
||||
<li><p><strong>kwargs</strong> (<em>dict</em>) – of the instruction (like “text”). Suitable values for each
|
||||
keyword are:
|
||||
<li><p><strong>kwargs</strong> (<em>dict</em>) – the name of the instruction (like “text”). Suitable values for each keyword are:
|
||||
- arg -> [[arg], {}]
|
||||
- [args] -> [[args], {}]
|
||||
- {kwargs} -> [[], {kwargs}]
|
||||
|
|
@ -145,13 +144,10 @@ applied.</p>
|
|||
<dt id="evennia.server.sessionhandler.ServerSessionHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.sessionhandler.</code><code class="sig-name descname">ServerSessionHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/sessionhandler.html#ServerSessionHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.ServerSessionHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.server.sessionhandler.SessionHandler" title="evennia.server.sessionhandler.SessionHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.server.sessionhandler.SessionHandler</span></code></a></p>
|
||||
<p>This object holds the stack of sessions active in the game at
|
||||
any time.</p>
|
||||
<p>A session register with the handler in two steps, first by
|
||||
registering itself with the connect() method. This indicates an
|
||||
non-authenticated session. Whenever the session is authenticated
|
||||
the session together with the related account is sent to the login()
|
||||
method.</p>
|
||||
<p>This object holds the stack of sessions active in the game at any time.</p>
|
||||
<p>A session register with the handler in two steps, first by registering itself with the connect()
|
||||
method. This indicates an non-authenticated session. Whenever the session is authenticated the
|
||||
session together with the related account is sent to the login() method.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.server.sessionhandler.ServerSessionHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/sessionhandler.html#ServerSessionHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.ServerSessionHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -271,9 +267,8 @@ itself down)</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.server.sessionhandler.ServerSessionHandler.login">
|
||||
<code class="sig-name descname">login</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session</span></em>, <em class="sig-param"><span class="n">account</span></em>, <em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">testmode</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/sessionhandler.html#ServerSessionHandler.login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.ServerSessionHandler.login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Log in the previously unloggedin session and the account we by
|
||||
now should know is connected to it. After this point we assume
|
||||
the session to be logged in one way or another.</p>
|
||||
<dd><p>Log in the previously unloggedin session and the account we by now should know is connected
|
||||
to it. After this point we assume the session to be logged in one way or another.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
@ -455,7 +450,7 @@ object.</p>
|
|||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>Returns.</dt><dd><dl class="simple">
|
||||
<dt>sessions (Session or list): Can be more than one of Object is controlled by</dt><dd><p>more than one Session (MULTISESSION_MODE > 1).</p>
|
||||
<dt>sessions (Session or list): Can be more than one of Object is controlled by more than</dt><dd><p>one Session (MULTISESSION_MODE > 1).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
|
@ -473,7 +468,7 @@ object.</p>
|
|||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>Returns.</dt><dd><dl class="simple">
|
||||
<dt>sessions (Session or list): Can be more than one of Object is controlled by</dt><dd><p>more than one Session (MULTISESSION_MODE > 1).</p>
|
||||
<dt>sessions (Session or list): Can be more than one of Object is controlled by more than</dt><dd><p>one Session (MULTISESSION_MODE > 1).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
|
|
|||
|
|
@ -1,402 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.typeclasses.admin — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.typeclasses.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.typeclasses.admin">
|
||||
<span id="evennia-typeclasses-admin"></span><h1>evennia.typeclasses.admin<a class="headerlink" href="#module-evennia.typeclasses.admin" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.TagAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.typeclasses.admin.</code><code class="sig-name descname">TagAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagAdmin" 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>A django Admin wrapper for Tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ('db_key', 'db_category', 'db_tagtype')</em><a class="headerlink" href="#evennia.typeclasses.admin.TagAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('db_key', 'db_category', 'db_tagtype', 'db_data')</em><a class="headerlink" href="#evennia.typeclasses.admin.TagAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagAdmin.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ('db_key', 'db_category', 'db_tagtype', 'db_data')</em><a class="headerlink" href="#evennia.typeclasses.admin.TagAdmin.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagAdmin.list_filter">
|
||||
<code class="sig-name descname">list_filter</code><em class="property"> = ('db_tagtype',)</em><a class="headerlink" href="#evennia.typeclasses.admin.TagAdmin.list_filter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.TagAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.typeclasses.admin.TagAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.TagForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.typeclasses.admin.</code><code class="sig-name descname">TagForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagForm" 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>This form overrides the base behavior of the ModelForm that would be used for a
|
||||
Tag-through-model. Since the through-models only have access to the foreignkeys of the Tag and
|
||||
the Object that they’re attached to, we need to spoof the behavior of it being a form that would
|
||||
correspond to its tag, or the creation of a tag. Instead of being saved, we’ll call to the
|
||||
Object’s handler, which will handle the creation, change, or deletion of a tag for us, as well
|
||||
as updating the handler’s cache so that all changes are instantly updated in-game.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.TagForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagForm.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="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ('tag_key', 'tag_category', 'tag_data', 'tag_type')</em><a class="headerlink" href="#evennia.typeclasses.admin.TagForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.TagForm.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagForm.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagForm.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If we have a tag, then we’ll prepopulate our instance with the fields we’d expect it
|
||||
to have based on the tag. tag_key, tag_category, tag_type, and tag_data all refer to
|
||||
the corresponding tag fields. The initial data of the form fields will similarly be
|
||||
populated.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.TagForm.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagForm.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagForm.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>One thing we want to do here is the or None checks, because forms are saved with an empty
|
||||
string rather than null from forms, usually, and the Handlers may handle empty strings
|
||||
differently than None objects. So for consistency with how things are handled in game,
|
||||
we’ll try to make sure that empty form fields will be None, rather than ‘’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'tag_category': <django.forms.fields.CharField object>, 'tag_data': <django.forms.fields.CharField object>, 'tag_key': <django.forms.fields.CharField object>, 'tag_type': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.typeclasses.admin.TagForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'tag_category': <django.forms.fields.CharField object>, 'tag_data': <django.forms.fields.CharField object>, 'tag_key': <django.forms.fields.CharField object>, 'tag_type': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.typeclasses.admin.TagForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.TagForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.typeclasses.admin.TagForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.TagFormSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.typeclasses.admin.</code><code class="sig-name descname">TagFormSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">files</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">instance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">save_as_new</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">prefix</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagFormSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagFormSet" 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.BaseInlineFormSet</span></code></p>
|
||||
<p>The Formset handles all the inline forms that are grouped together on the change page of the
|
||||
corresponding object. All the tags will appear here, and we’ll save them by overriding the
|
||||
formset’s save method. The forms will similarly spoof their save methods to return an instance
|
||||
which hasn’t been saved to the database, but have the relevant fields filled out based on the
|
||||
contents of the cleaned form. We’ll then use that to call to the handler of the corresponding
|
||||
Object, where the handler is an AliasHandler, PermissionsHandler, or TagHandler, based on the
|
||||
type of tag.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.TagFormSet.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagFormSet.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagFormSet.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Save model instances for every form, adding and changing instances
|
||||
as necessary, and return the list of instances.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.TagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.typeclasses.admin.</code><code class="sig-name descname">TagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagInline" 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.TabularInline</span></code></p>
|
||||
<p>A handler for inline Tags. This class should be subclassed in the admin of your models,
|
||||
and the ‘model’ and ‘related_field’ class attributes must be set. model should be the
|
||||
through model (ObjectDB_db_tag’, for example), while related field should be the name
|
||||
of the field on that through model which points to the model being used: ‘objectdb’,
|
||||
‘msg’, ‘accountdb’, etc.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagInline.model">
|
||||
<code class="sig-name descname">model</code><em class="property"> = None</em><a class="headerlink" href="#evennia.typeclasses.admin.TagInline.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagInline.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.typeclasses.admin.TagInline.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.typeclasses.admin.TagForm" title="evennia.typeclasses.admin.TagForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagInline.formset">
|
||||
<code class="sig-name descname">formset</code><a class="headerlink" href="#evennia.typeclasses.admin.TagInline.formset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.typeclasses.admin.TagFormSet" title="evennia.typeclasses.admin.TagFormSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagFormSet</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = None</em><a class="headerlink" href="#evennia.typeclasses.admin.TagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.TagInline.extra">
|
||||
<code class="sig-name descname">extra</code><em class="property"> = 0</em><a class="headerlink" href="#evennia.typeclasses.admin.TagInline.extra" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.TagInline.get_formset">
|
||||
<code class="sig-name descname">get_formset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#TagInline.get_formset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.TagInline.get_formset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>get_formset has to return a class, but we need to make the class that we return
|
||||
know about the related_field that we’ll use. Returning the class itself rather than
|
||||
a proxy isn’t threadsafe, since it’d be the base class and would change if multiple
|
||||
people used the admin at the same time</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.TagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.typeclasses.admin.TagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.typeclasses.admin.</code><code class="sig-name descname">AttributeForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm" 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>This form overrides the base behavior of the ModelForm that would be used for a Attribute-through-model.
|
||||
Since the through-models only have access to the foreignkeys of the Attribute and the Object that they’re
|
||||
attached to, we need to spoof the behavior of it being a form that would correspond to its Attribute,
|
||||
or the creation of an Attribute. Instead of being saved, we’ll call to the Object’s handler, which will handle
|
||||
the creation, change, or deletion of an Attribute for us, as well as updating the handler’s cache so that all
|
||||
changes are instantly updated in-game.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm.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="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ('attr_key', 'attr_value', 'attr_category', 'attr_lockstring', 'attr_type')</em><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeForm.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If we have an Attribute, then we’ll prepopulate our instance with the fields we’d expect it
|
||||
to have based on the Attribute. attr_key, attr_category, attr_value, attr_type,
|
||||
and attr_lockstring all refer to the corresponding Attribute fields. The initial data of the form fields will
|
||||
similarly be populated.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeForm.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>One thing we want to do here is the or None checks, because forms are saved with an empty
|
||||
string rather than null from forms, usually, and the Handlers may handle empty strings
|
||||
differently than None objects. So for consistency with how things are handled in game,
|
||||
we’ll try to make sure that empty form fields will be None, rather than ‘’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm.clean_attr_value">
|
||||
<code class="sig-name descname">clean_attr_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeForm.clean_attr_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm.clean_attr_value" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prevent certain data-types from being cleaned due to literal_eval
|
||||
failing on them. Otherwise they will be turned into str.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'attr_category': <django.forms.fields.CharField object>, 'attr_key': <django.forms.fields.CharField object>, 'attr_lockstring': <django.forms.fields.CharField object>, 'attr_type': <django.forms.fields.CharField object>, 'attr_value': <evennia.utils.picklefield.PickledFormField object>}</em><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'attr_category': <django.forms.fields.CharField object>, 'attr_key': <django.forms.fields.CharField object>, 'attr_lockstring': <django.forms.fields.CharField object>, 'attr_type': <django.forms.fields.CharField object>, 'attr_value': <evennia.utils.picklefield.PickledFormField object>}</em><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.AttributeForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.typeclasses.admin.AttributeForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.AttributeFormSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.typeclasses.admin.</code><code class="sig-name descname">AttributeFormSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">files</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">instance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">save_as_new</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">prefix</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeFormSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeFormSet" 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.BaseInlineFormSet</span></code></p>
|
||||
<p>Attribute version of TagFormSet, as above.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.AttributeFormSet.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeFormSet.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeFormSet.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Save model instances for every form, adding and changing instances
|
||||
as necessary, and return the list of instances.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.typeclasses.admin.AttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.typeclasses.admin.</code><code class="sig-name descname">AttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeInline" 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.TabularInline</span></code></p>
|
||||
<p>A handler for inline Attributes. This class should be subclassed in the admin of your models,
|
||||
and the ‘model’ and ‘related_field’ class attributes must be set. model should be the
|
||||
through model (ObjectDB_db_tag’, for example), while related field should be the name
|
||||
of the field on that through model which points to the model being used: ‘objectdb’,
|
||||
‘msg’, ‘accountdb’, etc.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.AttributeInline.model">
|
||||
<code class="sig-name descname">model</code><em class="property"> = None</em><a class="headerlink" href="#evennia.typeclasses.admin.AttributeInline.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.AttributeInline.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.typeclasses.admin.AttributeInline.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.typeclasses.admin.AttributeForm" title="evennia.typeclasses.admin.AttributeForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.AttributeInline.formset">
|
||||
<code class="sig-name descname">formset</code><a class="headerlink" href="#evennia.typeclasses.admin.AttributeInline.formset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.typeclasses.admin.AttributeFormSet" title="evennia.typeclasses.admin.AttributeFormSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeFormSet</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.AttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = None</em><a class="headerlink" href="#evennia.typeclasses.admin.AttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.admin.AttributeInline.extra">
|
||||
<code class="sig-name descname">extra</code><em class="property"> = 0</em><a class="headerlink" href="#evennia.typeclasses.admin.AttributeInline.extra" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.AttributeInline.get_formset">
|
||||
<code class="sig-name descname">get_formset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/admin.html#AttributeInline.get_formset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.admin.AttributeInline.get_formset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>get_formset has to return a class, but we need to make the class that we return
|
||||
know about the related_field that we’ll use. Returning the class itself rather than
|
||||
a proxy isn’t threadsafe, since it’d be the base class and would change if multiple
|
||||
people used the admin at the same time</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.admin.AttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.typeclasses.admin.AttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.typeclasses.admin.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.typeclasses.admin.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.typeclasses.admin.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.typeclasses.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -161,10 +161,10 @@ other access calls.</p></li>
|
|||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>pk</strong> (<em>int</em>) – This is a fake ‘primary key’ / id-field. It doesn’t actually have to be unique, but is fed an
|
||||
incrementing number from the InMemoryBackend by default. This is needed only so Attributes can be
|
||||
sorted. Some parts of the API also see the lack of a .pk field as a sign that the Attribute was
|
||||
deleted.</p></li>
|
||||
<li><p><strong>pk</strong> (<em>int</em>) – This is a fake ‘primary key’ / id-field. It doesn’t actually have to be
|
||||
unique, but is fed an incrementing number from the InMemoryBackend by default. This
|
||||
is needed only so Attributes can be sorted. Some parts of the API also see the lack
|
||||
of a .pk field as a sign that the Attribute was deleted.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Other keyword arguments are used to construct the actual Attribute.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -500,7 +500,8 @@ this will lead to Trouble. Ignored for InMemory attributes.</p></li>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.attributes.IAttributeBackend.create_attribute">
|
||||
<code class="sig-name descname">create_attribute</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span></em>, <em class="sig-param"><span class="n">category</span></em>, <em class="sig-param"><span class="n">lockstring</span></em>, <em class="sig-param"><span class="n">value</span></em>, <em class="sig-param"><span class="n">strvalue</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">cache</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/attributes.html#IAttributeBackend.create_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.attributes.IAttributeBackend.create_attribute" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates Attribute (using the class specified for the backend), (optionally) caches it, and returns it.</p>
|
||||
<dd><p>Creates Attribute (using the class specified for the backend), (optionally) caches it, and
|
||||
returns it.</p>
|
||||
<p>This MUST actively save the Attribute to whatever database backend is used, AND
|
||||
call self.set_cache(key, category, new_attrobj)</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -680,10 +681,10 @@ type <strong>attredit</strong> on the Attribute in question.</p></li>
|
|||
<dt id="evennia.typeclasses.attributes.InMemoryAttributeBackend">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.typeclasses.attributes.</code><code class="sig-name descname">InMemoryAttributeBackend</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">attrtype</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/attributes.html#InMemoryAttributeBackend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.attributes.InMemoryAttributeBackend" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.typeclasses.attributes.IAttributeBackend" title="evennia.typeclasses.attributes.IAttributeBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.attributes.IAttributeBackend</span></code></a></p>
|
||||
<p>This Backend for Attributes stores NOTHING in the database. Everything is kept in memory, and normally lost
|
||||
on a crash, reload, shared memory flush, etc. It generates IDs for the Attributes it manages, but these are
|
||||
of little importance beyond sorting and satisfying the caching logic to know an Attribute hasn’t been
|
||||
deleted out from under the cache’s nose.</p>
|
||||
<p>This Backend for Attributes stores NOTHING in the database. Everything is kept in memory, and
|
||||
normally lost on a crash, reload, shared memory flush, etc. It generates IDs for the Attributes
|
||||
it manages, but these are of little importance beyond sorting and satisfying the caching logic
|
||||
to know an Attribute hasn’t been deleted out from under the cache’s nose.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.attributes.InMemoryAttributeBackend.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">attrtype</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/attributes.html#InMemoryAttributeBackend.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.attributes.InMemoryAttributeBackend.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -773,7 +774,8 @@ deleted out from under the cache’s nose.</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.attributes.InMemoryAttributeBackend.do_delete_attribute">
|
||||
<code class="sig-name descname">do_delete_attribute</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attr</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/typeclasses/attributes.html#InMemoryAttributeBackend.do_delete_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.attributes.InMemoryAttributeBackend.do_delete_attribute" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Removes the Attribute from local storage. Once it’s out of the cache, garbage collection will handle the rest.</p>
|
||||
<dd><p>Removes the Attribute from local storage. Once it’s out of the cache, garbage collection
|
||||
will handle the rest.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>attr</strong> (<a class="reference internal" href="#evennia.typeclasses.attributes.IAttribute" title="evennia.typeclasses.attributes.IAttribute"><em>IAttribute</em></a>) – The attribute to delete.</p>
|
||||
|
|
@ -926,10 +928,9 @@ and/or caching complications.</p>
|
|||
<dd><p>Setup the AttributeHandler.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>obj</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – An Account, Object, Channel, ServerSession (not technically a typed object), etc.</p></li>
|
||||
<li><p><strong>backend_class</strong> (<em>IAttributeBackend class</em>) – The class of the backend to use.</p></li>
|
||||
</ul>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – An Account, Object, Channel, ServerSession (not technically a typed
|
||||
object), etc. backend_class (IAttributeBackend class): The class of the backend to
|
||||
use.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -1263,10 +1264,9 @@ They also always use the <strong>strvalue</strong> fields for their data.</p>
|
|||
<dd><p>Setup the AttributeHandler.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>obj</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – An Account, Object, Channel, ServerSession (not technically a typed object), etc.</p></li>
|
||||
<li><p><strong>backend_class</strong> (<em>IAttributeBackend class</em>) – The class of the backend to use.</p></li>
|
||||
</ul>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – An Account, Object, Channel, ServerSession (not technically a typed
|
||||
object), etc. backend_class (IAttributeBackend class): The class of the backend to
|
||||
use.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -48,7 +48,6 @@ inherit from the models in this package. Here is also were the
|
|||
Attribute and Tag models are defined along with their handlers.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.typeclasses.admin.html">evennia.typeclasses.admin</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.typeclasses.attributes.html">evennia.typeclasses.attributes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.typeclasses.managers.html">evennia.typeclasses.managers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.typeclasses.models.html">evennia.typeclasses.models</a></li>
|
||||
|
|
|
|||
|
|
@ -68,18 +68,18 @@ these to create custom managers.</p>
|
|||
<p>Abstract Django model.</p>
|
||||
<p>This is the basis for a typed object. It also contains all the
|
||||
mechanics for managing connected attributes.</p>
|
||||
<dl class="simple">
|
||||
<dt>The TypedObject has the following properties:</dt><dd><p>key - main name
|
||||
name - alias for key
|
||||
typeclass_path - the path to the decorating typeclass
|
||||
typeclass - auto-linked typeclass
|
||||
date_created - time stamp of object creation
|
||||
permissions - perm strings
|
||||
dbref - #id of object
|
||||
db - persistent attribute storage
|
||||
ndb - non-persistent attribute storage</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>The TypedObject has the following properties:</p>
|
||||
<ul class="simple">
|
||||
<li><p>key - main name</p></li>
|
||||
<li><p>name - alias for key</p></li>
|
||||
<li><p>typeclass_path - the path to the decorating typeclass</p></li>
|
||||
<li><p>typeclass - auto-linked typeclass</p></li>
|
||||
<li><p>date_created - time stamp of object creation</p></li>
|
||||
<li><p>permissions - perm strings</p></li>
|
||||
<li><p>dbref - #id of object</p></li>
|
||||
<li><p>db - persistent attribute storage</p></li>
|
||||
<li><p>ndb - non-persistent attribute storage</p></li>
|
||||
</ul>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.db_key">
|
||||
<code class="sig-name descname">db_key</code><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.db_key" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -529,6 +529,44 @@ developer’s responsibility.</p>
|
|||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.date_created">
|
||||
<em class="property">property </em><code class="sig-name descname">date_created</code><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <strong>db_date_created</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.get_next_by_db_date_created">
|
||||
<code class="sig-name descname">get_next_by_db_date_created</code><span class="sig-paren">(</span><em class="sig-param">*</em>, <em class="sig-param">field=<django.db.models.fields.DateTimeField: db_date_created></em>, <em class="sig-param">is_next=True</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.get_next_by_db_date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.get_previous_by_db_date_created">
|
||||
<code class="sig-name descname">get_previous_by_db_date_created</code><span class="sig-paren">(</span><em class="sig-param">*</em>, <em class="sig-param">field=<django.db.models.fields.DateTimeField: db_date_created></em>, <em class="sig-param">is_next=False</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.get_previous_by_db_date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.lock_storage">
|
||||
<em class="property">property </em><code class="sig-name descname">lock_storage</code><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <strong>db_lock_storage</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.typeclasses.models.TypedObject'</em><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.typeclass_path">
|
||||
<em class="property">property </em><code class="sig-name descname">typeclass_path</code><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.typeclass_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <strong>db_typeclass_path</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'SharedMemoryModelBase'</em><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.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/typeclasses/models.html#TypedObject.web_get_detail_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.web_get_detail_url" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -603,7 +641,7 @@ object.</p>
|
|||
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>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/change/$'</span><span class="p">,</span>
|
||||
<span class="n">CharUpdateView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-update'</span><span class="p">)</span>
|
||||
<span class="n">CharUpdateView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-update'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If no View has been created and defined in urls.py, returns an
|
||||
|
|
@ -631,7 +669,7 @@ 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>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/delete/$'</span><span class="p">,</span>
|
||||
<span class="n">CharDeleteView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-delete'</span><span class="p">)</span>
|
||||
<span class="n">CharDeleteView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">'character-delete'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If no View has been created and defined in urls.py, returns an HTML
|
||||
|
|
@ -641,12 +679,6 @@ the actual view and limiting who can delete this object is the
|
|||
developer’s responsibility.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.date_created">
|
||||
<em class="property">property </em><code class="sig-name descname">date_created</code><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <strong>db_date_created</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.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.typeclasses.models.TypedObject.get_absolute_url" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -675,38 +707,6 @@ the actual view and limiting who can view this object is the
|
|||
developer’s responsibility.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.get_next_by_db_date_created">
|
||||
<code class="sig-name descname">get_next_by_db_date_created</code><span class="sig-paren">(</span><em class="sig-param">*</em>, <em class="sig-param">field=<django.db.models.fields.DateTimeField: db_date_created></em>, <em class="sig-param">is_next=True</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.get_next_by_db_date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.get_previous_by_db_date_created">
|
||||
<code class="sig-name descname">get_previous_by_db_date_created</code><span class="sig-paren">(</span><em class="sig-param">*</em>, <em class="sig-param">field=<django.db.models.fields.DateTimeField: db_date_created></em>, <em class="sig-param">is_next=False</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.get_previous_by_db_date_created" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.lock_storage">
|
||||
<em class="property">property </em><code class="sig-name descname">lock_storage</code><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <strong>db_lock_storage</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.typeclasses.models.TypedObject'</em><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.typeclass_path">
|
||||
<em class="property">property </em><code class="sig-name descname">typeclass_path</code><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.typeclass_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper for getting database field <strong>db_typeclass_path</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.typeclasses.models.TypedObject.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'SharedMemoryModelBase'</em><a class="headerlink" href="#evennia.typeclasses.models.TypedObject.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -392,8 +392,9 @@ tuples <strong>[(key, category), …]</strong>.</p></li>
|
|||
<dd><p>Batch-add tags from a list of tuples.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>*args</strong> (<em>tuple</em><em> or </em><em>str</em>) – Each argument should be a <strong>tagstr</strong> keys or tuple <strong>(keystr, category)</strong> or
|
||||
<strong>(keystr, category, data)</strong>. It’s possible to mix input types.</p>
|
||||
<dd class="field-odd"><p><strong>*args</strong> (<em>tuple</em><em> or </em><em>str</em>) – Each argument should be a <strong>tagstr</strong> keys or tuple
|
||||
<strong>(keystr, category)</strong> or <strong>(keystr, category, data)</strong>. It’s possible to mix input
|
||||
types.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
|
|
|
|||
|
|
@ -57,8 +57,8 @@ markup schemes).</p>
|
|||
</ul>
|
||||
<section id="markup">
|
||||
<h2>Markup<a class="headerlink" href="#markup" title="Permalink to this headline">¶</a></h2>
|
||||
<p>ANSI colors: <strong>r</strong> ed, <strong>g</strong> reen, <strong>y</strong> ellow, <strong>b</strong> lue, <strong>m</strong> agenta, <strong>c</strong> yan, <strong>n</strong> ormal (no color). Capital
|
||||
letters indicate the ‘dark’ variant.</p>
|
||||
<p>ANSI colors: <strong>r</strong> ed, <strong>g</strong> reen, <strong>y</strong> ellow, <strong>b</strong> lue, <strong>m</strong> agenta, <strong>c</strong> yan, <strong>n</strong> ormal (no color).
|
||||
Capital letters indicate the ‘dark’ variant.</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>|r</strong> fg bright red</p></li>
|
||||
<li><p><strong>|R</strong> fg dark red</p></li>
|
||||
|
|
|
|||
|
|
@ -258,7 +258,7 @@ indentation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.eveditor.CmdLineInput.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '__noinput_command', 'category': 'general', 'key': '__nomatch_command', 'tags': '', 'text': '\n No command match - Inputs line of text into buffer.\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdLineInput.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '__noinput_command', 'category': 'general', 'key': '__nomatch_command', 'tags': '', 'text': '\n No command match - Inputs line of text into buffer.\n\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdLineInput.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -275,7 +275,7 @@ indentation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.eveditor.CmdEditorGroup.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':=', ':I', ':dd', ':', ':y', ':fi', ':u', ':!', '::', ':S', ':i', ':UU', ':uu', ':<', ':>', ':DD', ':dw', ':p', ':wq', ':r', ':q!', ':::', ':w', ':h', ':A', ':x', ':echo', ':f', ':q', ':s', ':fd', ':j']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':h', ':A', ':dw', ':q', ':r', ':s', ':UU', ':S', ':q!', ':uu', '::', ':!', ':wq', ':<', ':u', ':dd', ':i', ':I', ':fd', ':>', ':y', ':w', ':=', ':', ':::', ':DD', ':f', ':fi', ':p', ':x', ':j', ':echo']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -303,7 +303,7 @@ efficient presentation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.eveditor.CmdEditorGroup.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ':= :I :dd : :y :fi :u :! :: :S :i :UU :uu :< :> :DD :dw :p :wq :r :q! ::: :w :h :A :x :echo :f :q :s :fd :j', 'category': 'general', 'key': ':editor_command_group', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ':h :A :dw :q :r :s :UU :S :q! :uu :: :! :wq :< :u :dd :i :I :fd :> :y :w := : ::: :DD :f :fi :p :x :j :echo', 'category': 'general', 'key': ':editor_command_group', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -760,10 +760,30 @@ given, the decorated node must itself provide a way to continue from the node!</
|
|||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">list_node</span><span class="p">([</span><span class="s1">'foo'</span><span class="p">,</span> <span class="s1">'bar'</span><span class="p">],</span> <span class="n">select</span><span class="p">)</span>
|
||||
<span class="k">def</span> <span class="nf">node_index</span><span class="p">(</span><span class="n">caller</span><span class="p">):</span>
|
||||
<span class="n">text</span> <span class="o">=</span> <span class="s2">"describing the list"</span>
|
||||
<span class="k">return</span> <span class="n">text</span><span class="p">,</span> <span class="p">[]</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">select</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">selection</span><span class="p">,</span> <span class="n">available_choices</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="s1">'''</span>
|
||||
<span class="s1"> Args:</span>
|
||||
<span class="s1"> caller (Object or Account): User of the menu.</span>
|
||||
<span class="s1"> selection (str): What caller chose in the menu</span>
|
||||
<span class="s1"> available_choices (list): The keys of elements available on the *current listing</span>
|
||||
<span class="s1"> page*.</span>
|
||||
<span class="s1"> **kwargs: Kwargs passed on from the node.</span>
|
||||
<span class="s1"> Returns:</span>
|
||||
<span class="s1"> tuple, str or None: A tuple (nextnodename, **kwargs) or just nextnodename. Return</span>
|
||||
<span class="s1"> **None** to go back to the listnode.</span>
|
||||
|
||||
<span class="s1"> # (do something with **selection** here)</span>
|
||||
|
||||
<span class="s1"> return "nextnode", **kwargs</span>
|
||||
|
||||
<span class="s1">@list_node(['foo', 'bar'], select)</span>
|
||||
<span class="s1">def node_index(caller):</span>
|
||||
<span class="s1"> text = "describing the list"</span>
|
||||
|
||||
<span class="s1"> # optional extra options in addition to the list-options</span>
|
||||
<span class="s1"> extra_options = []</span>
|
||||
|
||||
<span class="s1"> return text, extra_options</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p class="rubric">Notes</p>
|
||||
|
|
@ -921,7 +941,7 @@ single question.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmenu.CmdYesNoQuestion.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['__nomatch_command', 'yes', 'no', 'abort', 'a', 'y', 'n']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['__nomatch_command', 'a', 'abort', 'n', 'yes', 'no', 'y']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -947,7 +967,7 @@ single question.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '__nomatch_command yes no abort a y n', 'category': 'general', 'key': '__noinput_command', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '__nomatch_command a abort n yes no y', 'category': 'general', 'key': '__noinput_command', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmore.CmdMore.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['end', 'q', 'b', 'next', 't', 'quit', 'abort', 'a', 'back', 'top', 'n', 'e']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['a', 'b', 'end', 'e', 'back', 't', 'top', 'n', 'abort', 'next', 'q', 'quit']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -102,7 +102,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmore.CmdMore.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'end q b next t quit abort a back top n e', 'category': 'general', 'key': '__noinput_command', 'tags': '', 'text': '\n Manipulate the text paging\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'a b end e back t top n abort next q quit', 'category': 'general', 'key': '__noinput_command', 'tags': '', 'text': '\n Manipulate the text paging\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -374,14 +374,15 @@ strings, querysets, django.Paginator, EvTables and any iterables with strings.</
|
|||
<p class="rubric">Notes</p>
|
||||
<p>If overridden, this method must perform the following actions:</p>
|
||||
<ul class="simple">
|
||||
<li><p>read and re-store <strong>self._data</strong> (the incoming data set) if needed for pagination to work.</p></li>
|
||||
<li><p>read and re-store <strong>self._data</strong> (the incoming data set) if needed for pagination to
|
||||
work.</p></li>
|
||||
<li><p>set <strong>self._npages</strong> to the total number of pages. Default is 1.</p></li>
|
||||
<li><p>set <strong>self._paginator</strong> to a callable that will take a page number 1…N and return
|
||||
the data to display on that page (not any decorations or next/prev buttons). If only
|
||||
wanting to change the paginator, override <strong>self.paginator</strong> instead.</p></li>
|
||||
<li><p>set <strong>self._page_formatter</strong> to a callable that will receive the page from <strong>self._paginator</strong>
|
||||
and format it with one element per line. Default is <strong>str</strong>. Or override <strong>self.page_formatter</strong>
|
||||
directly instead.</p></li>
|
||||
<li><p>set <strong>self._page_formatter</strong> to a callable that will receive the page from
|
||||
<strong>self._paginator</strong> and format it with one element per line. Default is <strong>str</strong>. Or
|
||||
override <strong>self.page_formatter</strong> directly instead.</p></li>
|
||||
</ul>
|
||||
<p>By default, helper methods are called that perform these actions
|
||||
depending on supported inputs.</p>
|
||||
|
|
|
|||
|
|
@ -479,8 +479,9 @@ resize individual columns in the vertical direction to fit.</p></li>
|
|||
<li><p><strong>height</strong> (<em>int</em><em>, </em><em>optional</em>) – Fixed height of table. Defaults to being unset. Width is
|
||||
still given precedence. If given, table cells will crop text rather
|
||||
than expand vertically.</p></li>
|
||||
<li><p><strong>evenwidth</strong> (<em>bool</em><em>, </em><em>optional</em>) – Used with the <strong>width</strong> keyword. Adjusts columns to have as even width as
|
||||
possible. This often looks best also for mixed-length tables. Default is <strong>False</strong>.</p></li>
|
||||
<li><p><strong>evenwidth</strong> (<em>bool</em><em>, </em><em>optional</em>) – Used with the <strong>width</strong> keyword. Adjusts columns to have as
|
||||
even width as possible. This often looks best also for mixed-length tables. Default
|
||||
is <strong>False</strong>.</p></li>
|
||||
<li><p><strong>maxwidth</strong> (<em>int</em><em>, </em><em>optional</em>) – This will set a maximum width
|
||||
of the table while allowing it to be smaller. Only if it grows wider than this
|
||||
size will it be resized by expanding horizontally (or crop <strong>height</strong> is given).
|
||||
|
|
|
|||
|
|
@ -329,21 +329,31 @@ the previous log to the start of the new one.</p>
|
|||
<dt id="evennia.utils.logger.EvenniaLogFile.seek">
|
||||
<code class="sig-name descname">seek</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/logger.html#EvenniaLogFile.seek"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.logger.EvenniaLogFile.seek" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Convenience method for accessing our _file attribute’s seek method,
|
||||
which is used in tail_log_function.
|
||||
:param *args: Same args as file.seek
|
||||
:param **kwargs: Same kwargs as file.seek</p>
|
||||
which is used in tail_log_function.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>*args</strong> – Same args as file.seek</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Same kwargs as file.seek</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.utils.logger.EvenniaLogFile.readlines">
|
||||
<code class="sig-name descname">readlines</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/logger.html#EvenniaLogFile.readlines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.logger.EvenniaLogFile.readlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Convenience method for accessing our _file attribute’s readlines method,
|
||||
which is used in tail_log_function.
|
||||
:param *args: same args as file.readlines
|
||||
:param **kwargs: same kwargs as file.readlines</p>
|
||||
which is used in tail_log_function.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>lines (list)</em> – lines from our _file attribute.</p>
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>*args</strong> – same args as file.readlines</p></li>
|
||||
<li><p><strong>**kwargs</strong> – same kwargs as file.readlines</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>lines (list)</em> – lines from our _file attribute.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -1510,16 +1510,35 @@ of the game directory.</p>
|
|||
<dd><p>List available typeclasses from all available modules.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>parent</strong> (<em>str</em><em>, </em><em>optional</em>) – If given, only return typeclasses inheriting (at any distance)
|
||||
from this parent.</p>
|
||||
<dd class="field-odd"><p><strong>parent</strong> (<em>str</em><em>, </em><em>optional</em>) – If given, only return typeclasses inheriting
|
||||
(at any distance) from this parent.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>dict</em> – On the form <strong>{“typeclass.path”: typeclass, …}</strong></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This will dynamically retrieve all abstract django models inheriting at any distance
|
||||
from the TypedObject base (aka a Typeclass) so it will work fine with any custom
|
||||
<p>This will dynamically retrieve all abstract django models inheriting at
|
||||
any distance from the TypedObject base (aka a Typeclass) so it will
|
||||
work fine with any custom classes being added.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.utils.utils.get_all_cmdsets">
|
||||
<code class="sig-prename descclassname">evennia.utils.utils.</code><code class="sig-name descname">get_all_cmdsets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/utils.html#get_all_cmdsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.utils.get_all_cmdsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List available cmdsets from all available modules.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>parent</strong> (<em>str</em><em>, </em><em>optional</em>) – If given, only return cmdsets inheriting (at
|
||||
any distance) from this parent.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>dict</em> – On the form {“cmdset.path”: cmdset, …}</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This will dynamically retrieve all abstract django models inheriting at
|
||||
any distance from the CmdSet base so it will work fine with any custom
|
||||
classes being added.</p>
|
||||
</dd></dl>
|
||||
|
||||
|
|
|
|||
|
|
@ -87,8 +87,9 @@ If neither one is provided, defaults to UTC.</p></li>
|
|||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>entry</strong> (<em>string</em>) – This is a string from user-input. The intended format is, for example: “5d 2w 90s” for
|
||||
‘five days, two weeks, and ninety seconds.’ Invalid sections are ignored.</p></li>
|
||||
<li><p><strong>entry</strong> (<em>string</em>) – This is a string from user-input. The intended format is, for example:
|
||||
“5d 2w 90s” for ‘five days, two weeks, and ninety seconds.’ Invalid sections are
|
||||
ignored.</p></li>
|
||||
<li><p><strong>option_key</strong> (<em>str</em>) – Name to display this query as.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -121,14 +122,16 @@ If neither one is provided, defaults to UTC.</p></li>
|
|||
<dl class="py function">
|
||||
<dt id="evennia.utils.validatorfuncs.boolean">
|
||||
<code class="sig-prename descclassname">evennia.utils.validatorfuncs.</code><code class="sig-name descname">boolean</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">entry</span></em>, <em class="sig-param"><span class="n">option_key</span><span class="o">=</span><span class="default_value">'True/False'</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/validatorfuncs.html#boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.validatorfuncs.boolean" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Simplest check in computer logic, right? This will take user input to flick the switch on or off
|
||||
:param entry: A value such as True, On, Enabled, Disabled, False, 0, or 1.
|
||||
:type entry: str
|
||||
:param option_key: What kind of Boolean we are setting. What Option is this for?
|
||||
:type option_key: str</p>
|
||||
<dd><p>Simplest check in computer logic, right? This will take user input to flick the switch on or off</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Boolean</p>
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>entry</strong> (<em>str</em>) – A value such as True, On, Enabled, Disabled, False, 0, or 1.</p></li>
|
||||
<li><p><strong>option_key</strong> (<em>str</em>) – What kind of Boolean we are setting. What Option is this for?</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Boolean</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
|
|||
495
docs/1.0-dev/api/evennia.web.admin.accounts.html
Normal file
495
docs/1.0-dev/api/evennia.web.admin.accounts.html
Normal file
|
|
@ -0,0 +1,495 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.accounts — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.accounts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.accounts">
|
||||
<span id="evennia-web-admin-accounts"></span><h1>evennia.web.admin.accounts<a class="headerlink" href="#module-evennia.web.admin.accounts" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountChangeForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm" 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.forms.UserChangeForm</span></code></p>
|
||||
<p>Modify the accountdb class.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm.clean_username">
|
||||
<code class="sig-name descname">clean_username</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm.clean_username"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.clean_username" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Clean the username and check its existence.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tweak some fields dynamically.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'date_joined': <django.forms.fields.DateTimeField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_is_bot': <django.forms.fields.BooleanField object>, 'db_is_connected': <django.forms.fields.BooleanField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>, 'email': <django.forms.fields.EmailField object>, 'first_name': <django.forms.fields.CharField object>, 'groups': <django.forms.models.ModelMultipleChoiceField object>, 'is_active': <django.forms.fields.BooleanField object>, 'is_staff': <django.forms.fields.BooleanField object>, 'is_superuser': <django.forms.fields.BooleanField object>, 'last_login': <django.forms.fields.DateTimeField object>, 'last_name': <django.forms.fields.CharField object>, 'password': <django.contrib.auth.forms.ReadOnlyPasswordHashField object>, 'user_permissions': <django.forms.models.ModelMultipleChoiceField object>, 'username': <django.forms.fields.RegexField object>}</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>, 'is_superuser': <django.forms.fields.BooleanField object>, 'password': <django.contrib.auth.forms.ReadOnlyPasswordHashField object>, 'username': <django.forms.fields.RegexField object>}</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountChangeForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.AccountCreationForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountCreationForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountCreationForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm" 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.forms.UserCreationForm</span></code></p>
|
||||
<p>Create a new AccountDB instance.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.AccountCreationForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountCreationForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountCreationForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountCreationForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountCreationForm.clean_username">
|
||||
<code class="sig-name descname">clean_username</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountCreationForm.clean_username"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.clean_username" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cleanup username.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountCreationForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'date_joined': <django.forms.fields.DateTimeField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_is_bot': <django.forms.fields.BooleanField object>, 'db_is_connected': <django.forms.fields.BooleanField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.CharField object>, 'email': <django.forms.fields.EmailField object>, 'first_name': <django.forms.fields.CharField object>, 'groups': <django.forms.models.ModelMultipleChoiceField object>, 'is_active': <django.forms.fields.BooleanField object>, 'is_staff': <django.forms.fields.BooleanField object>, 'is_superuser': <django.forms.fields.BooleanField object>, 'last_login': <django.forms.fields.DateTimeField object>, 'last_name': <django.forms.fields.CharField object>, 'password': <django.forms.fields.CharField object>, 'password1': <django.forms.fields.CharField object>, 'password2': <django.forms.fields.CharField object>, 'user_permissions': <django.forms.models.ModelMultipleChoiceField object>, 'username': <django.forms.fields.RegexField object>}</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountCreationForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'password1': <django.forms.fields.CharField object>, 'password2': <django.forms.fields.CharField object>, 'username': <django.forms.fields.RegexField object>}</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountCreationForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.AccountTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.tags.html#evennia.web.admin.tags.TagInline" title="evennia.web.admin.tags.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.tags.TagInline</span></code></a></p>
|
||||
<p>Inline Account Tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountTagInline.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.accounts.models.AccountDB_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'accountdb'</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.AccountAttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAttributeInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.attributes.html#evennia.web.admin.attributes.AttributeInline" title="evennia.web.admin.attributes.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.attributes.AttributeInline</span></code></a></p>
|
||||
<p>Inline Account Attributes.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAttributeInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAttributeInline.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.accounts.models.AccountDB_db_attributes</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'accountdb'</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountAttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">ObjectPuppetInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline" 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.StackedInline</span></code></p>
|
||||
<p>Inline creation of puppet-Object in Account.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm">
|
||||
<em class="property">class </em><code class="sig-name descname">ObjectCreateForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm" 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>This form details the look of the fields.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.models.ObjectDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tweak some fields dynamically.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_account': <django.forms.models.ModelChoiceField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_destination': <django.forms.models.ModelChoiceField object>, 'db_home': <django.forms.models.ModelChoiceField object>, 'db_key': <django.forms.fields.CharField object>, 'db_location': <django.forms.models.ModelChoiceField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_sessid': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_destination': <django.forms.models.ModelChoiceField object>, 'db_home': <django.forms.models.ModelChoiceField object>, 'db_key': <django.forms.fields.CharField object>, 'db_location': <django.forms.models.ModelChoiceField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.verbose_name">
|
||||
<code class="sig-name descname">verbose_name</code><em class="property"> = 'Puppeted Object'</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.verbose_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.models.ObjectDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.view_on_site">
|
||||
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.view_on_site" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.show_change_link">
|
||||
<code class="sig-name descname">show_change_link</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.show_change_link" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.admin.objects.html#evennia.web.admin.objects.ObjectCreateForm" title="evennia.web.admin.objects.ObjectCreateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.objects.ObjectCreateForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_typeclass_path'), ('db_location', 'db_home', 'db_destination'), 'db_cmdset_storage', 'db_lock_storage'), 'description': 'Object currently puppeted by the account (note that this will go away if account logs out or unpuppets)'}),)</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.extra">
|
||||
<code class="sig-name descname">extra</code><em class="property"> = 0</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.extra" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.readonly_fields">
|
||||
<code class="sig-name descname">readonly_fields</code><em class="property"> = ('db_key', 'db_typeclass_path', 'db_destination', 'db_location', 'db_home', 'db_account', 'db_cmdset_storage', 'db_lock_storage')</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.readonly_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.has_add_permission">
|
||||
<code class="sig-name descname">has_add_permission</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline.has_add_permission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.has_add_permission" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return True if the given request has permission to add an object.
|
||||
Can be overridden by the user in subclasses.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.has_delete_permission">
|
||||
<code class="sig-name descname">has_delete_permission</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline.has_delete_permission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.has_delete_permission" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return True if the given request has permission to change the given
|
||||
Django model instance, the default implementation doesn’t examine the
|
||||
<strong>obj</strong> parameter.</p>
|
||||
<p>Can be overridden by the user in subclasses. In such case it should
|
||||
return True if the given request has permission to delete the <strong>obj</strong>
|
||||
model instance. If <strong>obj</strong> is None, this should return True if the given
|
||||
request has permission to delete <em>any</em> object of the given type.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin" 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.admin.UserAdmin</span></code></p>
|
||||
<p>This is the main creation screen for Users/accounts</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'username', 'is_staff', 'is_superuser', 'db_typeclass_path', 'db_date_created')</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'username')</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.accounts.AccountChangeForm" title="evennia.web.admin.accounts.AccountChangeForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountChangeForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.add_form">
|
||||
<code class="sig-name descname">add_form</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.add_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.accounts.AccountCreationForm" title="evennia.web.admin.accounts.AccountCreationForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountCreationForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['=id', '^username', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['-db_date_created', 'id']</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.list_filter">
|
||||
<code class="sig-name descname">list_filter</code><em class="property"> = ['is_superuser', 'is_staff', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.list_filter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.web.admin.accounts.AccountTagInline'>, <class 'evennia.web.admin.accounts.AccountAttributeInline'>]</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.readonly_fields">
|
||||
<code class="sig-name descname">readonly_fields</code><em class="property"> = ['db_date_created', 'serialized_string', 'puppeted_objects']</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.readonly_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.view_on_site">
|
||||
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.view_on_site" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('username', 'db_typeclass_path'), 'password', 'email', 'db_date_created', 'db_lock_storage', 'db_cmdset_storage', 'puppeted_objects', 'serialized_string')}), ('Admin/Website properties', {'fields': (('first_name', 'last_name'), 'last_login', 'date_joined', 'is_active', 'is_staff', 'is_superuser', 'user_permissions', 'groups'), 'description': '<i>Used by the website/Django admin. Except for `superuser status`, the permissions are not used in-game.</i>'}))</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.add_fieldsets">
|
||||
<code class="sig-name descname">add_fieldsets</code><em class="property"> = ((None, {'fields': ('username', 'password1', 'password2', 'email'), 'description': '<i>These account details are shared by the admin system and the game.</i>'}),)</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.add_fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.serialized_string">
|
||||
<code class="sig-name descname">serialized_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.serialized_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.serialized_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the serialized version of the object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.puppeted_objects">
|
||||
<code class="sig-name descname">puppeted_objects</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.puppeted_objects"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.puppeted_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get any currently puppeted objects (read only list)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.get_form">
|
||||
<code class="sig-name descname">get_form</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.get_form"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.get_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides help texts.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.user_change_password">
|
||||
<code class="sig-name descname">user_change_password</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">form_url</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.user_change_password"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.user_change_password" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.save_model">
|
||||
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.save_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Custom save actions.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – Object to save.</p></li>
|
||||
<li><p><strong>form</strong> (<em>Form</em>) – Related form instance.</p></li>
|
||||
<li><p><strong>change</strong> (<em>bool</em>) – False if this is a new save and not an update.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.response_add">
|
||||
<code class="sig-name descname">response_add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">post_url_continue</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.response_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.response_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determine the HttpResponse for the add_view stage. It mostly defers to
|
||||
its superclass implementation but is customized because the User model
|
||||
has a slightly different workflow.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.accounts.AccountAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.accounts.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.accounts.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.accounts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
254
docs/1.0-dev/api/evennia.web.admin.attributes.html
Normal file
254
docs/1.0-dev/api/evennia.web.admin.attributes.html
Normal file
|
|
@ -0,0 +1,254 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.attributes — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.attributes</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.attributes">
|
||||
<span id="evennia-web-admin-attributes"></span><h1>evennia.web.admin.attributes<a class="headerlink" href="#module-evennia.web.admin.attributes" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Attribute admin.</p>
|
||||
<p>Note that we don’t present a separate admin for these, since they are only
|
||||
relevant together with a specific object.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.attributes.</code><code class="sig-name descname">AttributeForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm" 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>This form overrides the base behavior of the ModelForm that would be used for a Attribute-through-model.
|
||||
Since the through-models only have access to the foreignkeys of the Attribute and the Object that they’re
|
||||
attached to, we need to spoof the behavior of it being a form that would correspond to its Attribute,
|
||||
or the creation of an Attribute. Instead of being saved, we’ll call to the Object’s handler, which will handle
|
||||
the creation, change, or deletion of an Attribute for us, as well as updating the handler’s cache so that all
|
||||
changes are instantly updated in-game.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ('attr_key', 'attr_value', 'attr_category', 'attr_lockstring', 'attr_type')</em><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeForm.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If we have an Attribute, then we’ll prepopulate our instance with the fields we’d expect it
|
||||
to have based on the Attribute. attr_key, attr_category, attr_value, attr_type,
|
||||
and attr_lockstring all refer to the corresponding Attribute fields. The initial data of the form fields will
|
||||
similarly be populated.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeForm.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>One thing we want to do here is the or None checks, because forms are saved with an empty
|
||||
string rather than null from forms, usually, and the Handlers may handle empty strings
|
||||
differently than None objects. So for consistency with how things are handled in game,
|
||||
we’ll try to make sure that empty form fields will be None, rather than ‘’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm.clean_attr_value">
|
||||
<code class="sig-name descname">clean_attr_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeForm.clean_attr_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm.clean_attr_value" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prevent certain data-types from being cleaned due to literal_eval
|
||||
failing on them. Otherwise they will be turned into str.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'attr_category': <django.forms.fields.CharField object>, 'attr_key': <django.forms.fields.CharField object>, 'attr_lockstring': <django.forms.fields.CharField object>, 'attr_type': <django.forms.fields.ChoiceField object>, 'attr_value': <evennia.utils.picklefield.PickledFormField object>}</em><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'attr_category': <django.forms.fields.CharField object>, 'attr_key': <django.forms.fields.CharField object>, 'attr_lockstring': <django.forms.fields.CharField object>, 'attr_type': <django.forms.fields.ChoiceField object>, 'attr_value': <evennia.utils.picklefield.PickledFormField object>}</em><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.attributes.AttributeForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.attributes.AttributeForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.attributes.AttributeFormSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.attributes.</code><code class="sig-name descname">AttributeFormSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">files</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">instance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">save_as_new</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">prefix</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeFormSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeFormSet" 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.BaseInlineFormSet</span></code></p>
|
||||
<p>Attribute version of TagFormSet, as above.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.attributes.AttributeFormSet.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeFormSet.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeFormSet.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Save model instances for every form, adding and changing instances
|
||||
as necessary, and return the list of instances.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.attributes.</code><code class="sig-name descname">AttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline" 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.TabularInline</span></code></p>
|
||||
<p>A handler for inline Attributes. This class should be subclassed in the admin of your models,
|
||||
and the ‘model’ and ‘related_field’ class attributes must be set. model should be the
|
||||
through model (ObjectDB_db_tag’, for example), while related field should be the name
|
||||
of the field on that through model which points to the model being used: ‘objectdb’,
|
||||
‘msg’, ‘accountdb’, etc.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.model">
|
||||
<code class="sig-name descname">model</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.verbose_name">
|
||||
<code class="sig-name descname">verbose_name</code><em class="property"> = 'Attribute'</em><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.verbose_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.verbose_name_plural">
|
||||
<code class="sig-name descname">verbose_name_plural</code><em class="property"> = 'Attributes'</em><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.verbose_name_plural" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.attributes.AttributeForm" title="evennia.web.admin.attributes.AttributeForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.formset">
|
||||
<code class="sig-name descname">formset</code><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.formset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.attributes.AttributeFormSet" title="evennia.web.admin.attributes.AttributeFormSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeFormSet</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.extra">
|
||||
<code class="sig-name descname">extra</code><em class="property"> = 0</em><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.extra" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.get_formset">
|
||||
<code class="sig-name descname">get_formset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/attributes.html#AttributeInline.get_formset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.get_formset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>get_formset has to return a class, but we need to make the class that we return
|
||||
know about the related_field that we’ll use. Returning the class itself rather than
|
||||
a proxy isn’t threadsafe, since it’d be the base class and would change if multiple
|
||||
people used the admin at the same time</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.attributes.AttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.attributes.AttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.attributes.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.attributes.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.attributes</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
495
docs/1.0-dev/api/evennia.web.admin.comms.html
Normal file
495
docs/1.0-dev/api/evennia.web.admin.comms.html
Normal file
|
|
@ -0,0 +1,495 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.comms — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.comms</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.comms">
|
||||
<span id="evennia-web-admin-comms"></span><h1>evennia.web.admin.comms<a class="headerlink" href="#module-evennia.web.admin.comms" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This defines how Comm models are displayed in the web admin interface.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.MsgTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.comms.</code><code class="sig-name descname">MsgTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#MsgTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.tags.html#evennia.web.admin.tags.TagInline" title="evennia.web.admin.tags.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.tags.TagInline</span></code></a></p>
|
||||
<p>Inline display for Msg-tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.comms.MsgTagInline.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.comms.models.Msg_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'msg'</em><a class="headerlink" href="#evennia.web.admin.comms.MsgTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.MsgTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.comms.MsgTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.MsgForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.comms.</code><code class="sig-name descname">MsgForm</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/web/admin/comms.html#MsgForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgForm" 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>Custom Msg form.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.MsgForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#MsgForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgForm.Meta.models">
|
||||
<code class="sig-name descname">models</code><a class="headerlink" href="#evennia.web.admin.comms.MsgForm.Meta.models" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.comms.models.html#evennia.comms.models.Msg" title="evennia.comms.models.Msg"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.comms.models.Msg</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.comms.MsgForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_header': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.web.admin.comms.MsgForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_header': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.web.admin.comms.MsgForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.MsgForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.comms.MsgForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.comms.</code><code class="sig-name descname">MsgAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#MsgAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin" 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>Defines display for Msg objects</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.web.admin.comms.MsgTagInline'>]</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.comms.MsgForm" title="evennia.web.admin.comms.MsgForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">MsgForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_date_created', 'sender', 'receiver', 'start_of_message')</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_date_created', 'start_of_message')</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['-db_date_created', '-id']</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['=id', '^db_date_created', '^db_message', '^db_sender_accounts__db_key', '^db_sender_objects__db_key', '^db_sender_scripts__db_key', '^db_sender_external', '^db_receivers_accounts__db_key', '^db_receivers_objects__db_key', '^db_receivers_scripts__db_key', '^db_receiver_external']</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.readonly_fields">
|
||||
<code class="sig-name descname">readonly_fields</code><em class="property"> = ['db_date_created', 'serialized_string']</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.readonly_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.view_on_site">
|
||||
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.view_on_site" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.raw_id_fields">
|
||||
<code class="sig-name descname">raw_id_fields</code><em class="property"> = ('db_sender_accounts', 'db_sender_objects', 'db_sender_scripts', 'db_receivers_accounts', 'db_receivers_objects', 'db_receivers_scripts', 'db_hide_from_accounts', 'db_hide_from_objects')</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.raw_id_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_sender_accounts', 'db_sender_objects', 'db_sender_scripts', 'db_sender_external'), ('db_receivers_accounts', 'db_receivers_objects', 'db_receivers_scripts', 'db_receiver_external'), ('db_hide_from_accounts', 'db_hide_from_objects'), 'db_header', 'db_message', 'serialized_string')}),)</em><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.sender">
|
||||
<code class="sig-name descname">sender</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#MsgAdmin.sender"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.sender" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.receiver">
|
||||
<code class="sig-name descname">receiver</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#MsgAdmin.receiver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.receiver" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.start_of_message">
|
||||
<code class="sig-name descname">start_of_message</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#MsgAdmin.start_of_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.start_of_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.serialized_string">
|
||||
<code class="sig-name descname">serialized_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#MsgAdmin.serialized_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.serialized_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the serialized version of the object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.get_form">
|
||||
<code class="sig-name descname">get_form</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#MsgAdmin.get_form"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.get_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides help texts.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.MsgAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.comms.MsgAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.ChannelAttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.comms.</code><code class="sig-name descname">ChannelAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelAttributeInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.attributes.html#evennia.web.admin.attributes.AttributeInline" title="evennia.web.admin.attributes.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.attributes.AttributeInline</span></code></a></p>
|
||||
<p>Inline display of Channel Attribute - experimental</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAttributeInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.comms.ChannelAttributeInline.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.comms.models.ChannelDB_db_attributes</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'channeldb'</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelAttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.comms.ChannelAttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.ChannelTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.comms.</code><code class="sig-name descname">ChannelTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.tags.html#evennia.web.admin.tags.TagInline" title="evennia.web.admin.tags.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.tags.TagInline</span></code></a></p>
|
||||
<p>Inline display of Channel Tags - experimental</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.comms.ChannelTagInline.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.comms.models.ChannelDB_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'channeldb'</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.comms.ChannelTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.ChannelForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.comms.</code><code class="sig-name descname">ChannelForm</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/web/admin/comms.html#ChannelForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelForm" 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>Form for accessing channels.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.ChannelForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.comms.ChannelForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.comms.models.html#evennia.comms.models.ChannelDB" title="evennia.comms.models.ChannelDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.comms.models.ChannelDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_account_subscriptions': <django.forms.models.ModelMultipleChoiceField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_object_subscriptions': <django.forms.models.ModelMultipleChoiceField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_lock_storage': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.comms.ChannelForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.comms.</code><code class="sig-name descname">ChannelAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin" 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>Defines display for Channel objects</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.web.admin.comms.ChannelTagInline'>, <class 'evennia.web.admin.comms.ChannelAttributeInline'>]</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.comms.ChannelForm" title="evennia.web.admin.comms.ChannelForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChannelForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'no_of_subscribers', 'db_lock_storage', 'db_typeclass_path', 'db_date_created')</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['-db_date_created', '-id', '-db_key']</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['id', 'db_key', 'db_tags__db_key']</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.readonly_fields">
|
||||
<code class="sig-name descname">readonly_fields</code><em class="property"> = ['serialized_string']</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.readonly_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.raw_id_fields">
|
||||
<code class="sig-name descname">raw_id_fields</code><em class="property"> = ('db_object_subscriptions', 'db_account_subscriptions')</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.raw_id_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key',), 'db_lock_storage', 'db_account_subscriptions', 'db_object_subscriptions', 'serialized_string')}),)</em><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.subscriptions">
|
||||
<code class="sig-name descname">subscriptions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelAdmin.subscriptions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.subscriptions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Helper method to get subs from a channel.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<em>Channel</em>) – The channel to get subs from.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.no_of_subscribers">
|
||||
<code class="sig-name descname">no_of_subscribers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelAdmin.no_of_subscribers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.no_of_subscribers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get number of subs for a a channel .</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<em>Channel</em>) – The channel to get subs from.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.serialized_string">
|
||||
<code class="sig-name descname">serialized_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelAdmin.serialized_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.serialized_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the serialized version of the object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.get_form">
|
||||
<code class="sig-name descname">get_form</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelAdmin.get_form"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.get_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides help texts.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.save_model">
|
||||
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.save_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Model-save hook.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – Database object.</p></li>
|
||||
<li><p><strong>form</strong> (<em>Form</em>) – Form instance.</p></li>
|
||||
<li><p><strong>change</strong> (<em>bool</em>) – If this is a change or a new object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.response_add">
|
||||
<code class="sig-name descname">response_add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">post_url_continue</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/comms.html#ChannelAdmin.response_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.response_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determine the HttpResponse for the add_view stage.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.comms.ChannelAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.comms.ChannelAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.comms.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.comms.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.comms</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
124
docs/1.0-dev/api/evennia.web.admin.frontpage.html
Normal file
124
docs/1.0-dev/api/evennia.web.admin.frontpage.html
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.frontpage — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.frontpage</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.frontpage">
|
||||
<span id="evennia-web-admin-frontpage"></span><h1>evennia.web.admin.frontpage<a class="headerlink" href="#module-evennia.web.admin.frontpage" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Admin views.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.web.admin.frontpage.evennia_admin">
|
||||
<code class="sig-prename descclassname">evennia.web.admin.frontpage.</code><code class="sig-name descname">evennia_admin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/frontpage.html#evennia_admin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.frontpage.evennia_admin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Helpful Evennia-specific admin page.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.web.admin.frontpage.admin_wrapper">
|
||||
<code class="sig-prename descclassname">evennia.web.admin.frontpage.</code><code class="sig-name descname">admin_wrapper</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/frontpage.html#admin_wrapper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.frontpage.admin_wrapper" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Wrapper that allows us to properly use the base Django admin site, if needed.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.frontpage.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.frontpage.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.frontpage</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.help.admin — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.web.admin.help — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.help.admin</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.help</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -38,130 +38,140 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.help.admin">
|
||||
<span id="evennia-help-admin"></span><h1>evennia.help.admin<a class="headerlink" href="#module-evennia.help.admin" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.web.admin.help">
|
||||
<span id="evennia-web-admin-help"></span><h1>evennia.web.admin.help<a class="headerlink" href="#module-evennia.web.admin.help" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This defines how to edit help entries in Admin.</p>
|
||||
<dl class="py 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"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></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.admin.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>
|
||||
<dt id="evennia.web.admin.help.HelpTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.help.</code><code class="sig-name descname">HelpTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/help.html#HelpTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.help.HelpTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.tags.html#evennia.web.admin.tags.TagInline" title="evennia.web.admin.tags.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.tags.TagInline</span></code></a></p>
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.help.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="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'helpentry'</em><a class="headerlink" href="#evennia.web.admin.help.HelpTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.help.HelpTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.help.</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/web/admin/help.html#HelpEntryForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.help.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="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/help.html#HelpEntryForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.help.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="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.help.models.html#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>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.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_tags': <django.forms.models.ModelMultipleChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.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.web.admin.help.HelpEntryForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py 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"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.help.</code><code class="sig-name descname">HelpEntryAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/help.html#HelpEntryAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.help.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="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.web.admin.help.HelpTagInline'>]</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_help_category', 'db_lock_storage', 'db_date_created')</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.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.web.admin.help.HelpEntryAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['^db_key', 'db_entrytext']</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['db_help_category', 'db_key']</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.list_filter">
|
||||
<code class="sig-name descname">list_filter</code><em class="property"> = ['db_help_category']</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.list_filter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.view_on_site">
|
||||
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.view_on_site" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.help.HelpEntryForm" title="evennia.web.admin.help.HelpEntryForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">HelpEntryForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_help_category'), 'db_entrytext', 'db_lock_storage')}),)</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py 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>
|
||||
<dt id="evennia.web.admin.help.HelpEntryAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -191,7 +201,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.help.admin.rst.txt"
|
||||
<li><a href="../_sources/api/evennia.web.admin.help.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -207,8 +217,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.help.admin.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.help.admin.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.web.admin.help.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -225,7 +235,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.help.admin</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.help</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
127
docs/1.0-dev/api/evennia.web.admin.html
Normal file
127
docs/1.0-dev/api/evennia.web.admin.html
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin">
|
||||
<span id="evennia-web-admin"></span><h1>evennia.web.admin<a class="headerlink" href="#module-evennia.web.admin" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Django-admin code for customizing the web admin for Evennia.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.accounts.html">evennia.web.admin.accounts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.attributes.html">evennia.web.admin.attributes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.comms.html">evennia.web.admin.comms</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.frontpage.html">evennia.web.admin.frontpage</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.help.html">evennia.web.admin.help</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.objects.html">evennia.web.admin.objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.scripts.html">evennia.web.admin.scripts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.server.html">evennia.web.admin.server</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.tags.html">evennia.web.admin.tags</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.urls.html">evennia.web.admin.urls</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.utils.html">evennia.web.admin.utils</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
415
docs/1.0-dev/api/evennia.web.admin.objects.html
Normal file
415
docs/1.0-dev/api/evennia.web.admin.objects.html
Normal file
|
|
@ -0,0 +1,415 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.objects — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.objects</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.objects">
|
||||
<span id="evennia-web-admin-objects"></span><h1>evennia.web.admin.objects<a class="headerlink" href="#module-evennia.web.admin.objects" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.objects.ObjectAttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.objects.</code><code class="sig-name descname">ObjectAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAttributeInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.attributes.html#evennia.web.admin.attributes.AttributeInline" title="evennia.web.admin.attributes.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.attributes.AttributeInline</span></code></a></p>
|
||||
<p>Defines inline descriptions of Attributes (experimental)</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAttributeInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectAttributeInline.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.objects.models.ObjectDB_db_attributes</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'objectdb'</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectAttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.objects.ObjectTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.objects.</code><code class="sig-name descname">ObjectTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.tags.html#evennia.web.admin.tags.TagInline" title="evennia.web.admin.tags.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.tags.TagInline</span></code></a></p>
|
||||
<p>Defines inline descriptions of Tags (experimental)</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectTagInline.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.objects.models.ObjectDB_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'objectdb'</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.objects.ObjectCreateForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.objects.</code><code class="sig-name descname">ObjectCreateForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectCreateForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectCreateForm" 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>This form details the look of the fields.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.objects.ObjectCreateForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectCreateForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectCreateForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectCreateForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectCreateForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.models.ObjectDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectCreateForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectCreateForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectCreateForm.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectCreateForm.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectCreateForm.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tweak some fields dynamically.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectCreateForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_account': <django.forms.models.ModelChoiceField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_destination': <django.forms.models.ModelChoiceField object>, 'db_home': <django.forms.models.ModelChoiceField object>, 'db_key': <django.forms.fields.CharField object>, 'db_location': <django.forms.models.ModelChoiceField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_sessid': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectCreateForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectCreateForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_destination': <django.forms.models.ModelChoiceField object>, 'db_home': <django.forms.models.ModelChoiceField object>, 'db_key': <django.forms.fields.CharField object>, 'db_location': <django.forms.models.ModelChoiceField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectCreateForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectCreateForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectCreateForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.objects.ObjectEditForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.objects.</code><code class="sig-name descname">ObjectEditForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectEditForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectEditForm" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.admin.objects.ObjectCreateForm" title="evennia.web.admin.objects.ObjectCreateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.objects.ObjectCreateForm</span></code></a></p>
|
||||
<p>Form used for editing. Extends the create one with more fields</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.objects.ObjectEditForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectEditForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectEditForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectEditForm.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectEditForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.models.ObjectDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectEditForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectEditForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectEditForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_account': <django.forms.models.ModelChoiceField object>, 'db_attributes': <django.forms.models.ModelMultipleChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_destination': <django.forms.models.ModelChoiceField object>, 'db_home': <django.forms.models.ModelChoiceField object>, 'db_key': <django.forms.fields.CharField object>, 'db_location': <django.forms.models.ModelChoiceField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_sessid': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectEditForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectEditForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_account': <django.forms.models.ModelChoiceField object>, 'db_cmdset_storage': <django.forms.fields.CharField object>, 'db_destination': <django.forms.models.ModelChoiceField object>, 'db_home': <django.forms.models.ModelChoiceField object>, 'db_key': <django.forms.fields.CharField object>, 'db_location': <django.forms.models.ModelChoiceField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectEditForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectEditForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectEditForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.objects.</code><code class="sig-name descname">ObjectAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin" 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>Describes the admin page for Objects.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.web.admin.objects.ObjectTagInline'>, <class 'evennia.web.admin.objects.ObjectAttributeInline'>]</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_typeclass_path', 'db_location', 'db_destination', 'db_account', 'db_date_created')</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['-db_date_created', '-id']</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['=id', '^db_key', 'db_typeclass_path', '^db_account__db_key', '^db_location__db_key']</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.raw_id_fields">
|
||||
<code class="sig-name descname">raw_id_fields</code><em class="property"> = ('db_destination', 'db_location', 'db_home', 'db_account')</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.raw_id_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.readonly_fields">
|
||||
<code class="sig-name descname">readonly_fields</code><em class="property"> = ('serialized_string', 'link_button')</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.readonly_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.view_on_site">
|
||||
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.view_on_site" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.list_filter">
|
||||
<code class="sig-name descname">list_filter</code><em class="property"> = ('db_typeclass_path',)</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.list_filter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.objects.ObjectEditForm" title="evennia.web.admin.objects.ObjectEditForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectEditForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_typeclass_path'), ('db_location', 'db_home', 'db_destination'), ('db_account', 'link_button'), 'db_cmdset_storage', 'db_lock_storage', 'serialized_string')}),)</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.add_form">
|
||||
<code class="sig-name descname">add_form</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.add_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.objects.ObjectCreateForm" title="evennia.web.admin.objects.ObjectCreateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectCreateForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.add_fieldsets">
|
||||
<code class="sig-name descname">add_fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_typeclass_path'), ('db_location', 'db_home', 'db_destination'), 'db_cmdset_storage')}),)</em><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.add_fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.serialized_string">
|
||||
<code class="sig-name descname">serialized_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin.serialized_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.serialized_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the serialized version of the object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.get_fieldsets">
|
||||
<code class="sig-name descname">get_fieldsets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin.get_fieldsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.get_fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return fieldsets.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em><em>, </em><em>optional</em>) – Database object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.get_form">
|
||||
<code class="sig-name descname">get_form</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin.get_form"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.get_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use special form during creation.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em><em>, </em><em>optional</em>) – Database object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.get_urls">
|
||||
<code class="sig-name descname">get_urls</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin.get_urls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.get_urls" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.link_button">
|
||||
<code class="sig-name descname">link_button</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin.link_button"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.link_button" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.link_object_to_account">
|
||||
<code class="sig-name descname">link_object_to_account</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">object_id</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin.link_object_to_account"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.link_object_to_account" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Link object and account when pressing the button.</p>
|
||||
<p>This will:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Set account.db._last_puppet to this object</p></li>
|
||||
<li><p>Add object to account.db._playable_characters</p></li>
|
||||
<li><p>Change object locks to allow puppeting by account</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.save_model">
|
||||
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.save_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Model-save hook.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – Database object.</p></li>
|
||||
<li><p><strong>form</strong> (<em>Form</em>) – Form instance.</p></li>
|
||||
<li><p><strong>change</strong> (<em>bool</em>) – If this is a change or a new object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.objects.ObjectAdmin.response_add">
|
||||
<code class="sig-name descname">response_add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">post_url_continue</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/objects.html#ObjectAdmin.response_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.objects.ObjectAdmin.response_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determine the HttpResponse for the add_view stage.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.objects.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.objects.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.objects</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
297
docs/1.0-dev/api/evennia.web.admin.scripts.html
Normal file
297
docs/1.0-dev/api/evennia.web.admin.scripts.html
Normal file
|
|
@ -0,0 +1,297 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.scripts — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.scripts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.scripts">
|
||||
<span id="evennia-web-admin-scripts"></span><h1>evennia.web.admin.scripts<a class="headerlink" href="#module-evennia.web.admin.scripts" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.scripts.ScriptForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.scripts.</code><code class="sig-name descname">ScriptForm</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/web/admin/scripts.html#ScriptForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptForm" 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>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_interval': <django.forms.fields.IntegerField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_persistent': <django.forms.fields.BooleanField object>, 'db_repeats': <django.forms.fields.IntegerField object>, 'db_start_delay': <django.forms.fields.BooleanField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_interval': <django.forms.fields.IntegerField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_persistent': <django.forms.fields.BooleanField object>, 'db_repeats': <django.forms.fields.IntegerField object>, 'db_start_delay': <django.forms.fields.BooleanField object>, 'db_typeclass_path': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.scripts.ScriptForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.scripts.ScriptTagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.scripts.</code><code class="sig-name descname">ScriptTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.tags.html#evennia.web.admin.tags.TagInline" title="evennia.web.admin.tags.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.tags.TagInline</span></code></a></p>
|
||||
<p>Inline script tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptTagInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline.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.scripts.models.ScriptDB_db_tags</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptTagInline.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.scripts.ScriptForm" title="evennia.web.admin.scripts.ScriptForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptTagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'scriptdb'</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.scripts.ScriptTagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAttributeInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.scripts.</code><code class="sig-name descname">ScriptAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.attributes.html#evennia.web.admin.attributes.AttributeInline" title="evennia.web.admin.attributes.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.attributes.AttributeInline</span></code></a></p>
|
||||
<p>Inline attribute tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAttributeInline.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline.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.scripts.models.ScriptDB_db_attributes</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAttributeInline.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.scripts.ScriptForm" title="evennia.web.admin.scripts.ScriptForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAttributeInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = 'scriptdb'</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAttributeInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.scripts.</code><code class="sig-name descname">ScriptAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin" 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>Displaying the main Script page.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_typeclass_path', 'db_obj', 'db_interval', 'db_repeats', 'db_persistent', 'db_date_created')</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['-db_date_created', '-id']</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['=id', '^db_key', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.readonly_fields">
|
||||
<code class="sig-name descname">readonly_fields</code><em class="property"> = ['serialized_string']</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.readonly_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.scripts.ScriptForm" title="evennia.web.admin.scripts.ScriptForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.view_on_site">
|
||||
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.view_on_site" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.raw_id_fields">
|
||||
<code class="sig-name descname">raw_id_fields</code><em class="property"> = ('db_obj',)</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.raw_id_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_typeclass_path'), ('db_interval', 'db_repeats', 'db_start_delay', 'db_persistent'), 'db_obj', 'db_lock_storage', 'serialized_string')}),)</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.inlines">
|
||||
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.web.admin.scripts.ScriptTagInline'>, <class 'evennia.web.admin.scripts.ScriptAttributeInline'>]</em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.serialized_string">
|
||||
<code class="sig-name descname">serialized_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptAdmin.serialized_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.serialized_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the serialized version of the object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.get_form">
|
||||
<code class="sig-name descname">get_form</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptAdmin.get_form"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.get_form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides help texts.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.save_model">
|
||||
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.save_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Model-save hook.</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>) – Incoming request.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – Database object.</p></li>
|
||||
<li><p><strong>form</strong> (<em>Form</em>) – Form instance.</p></li>
|
||||
<li><p><strong>change</strong> (<em>bool</em>) – If this is a change or a new object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.scripts.ScriptAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.scripts.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.scripts.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.scripts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.server.admin — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.web.admin.server — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.server.admin</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.server</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -38,51 +38,53 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.server.admin">
|
||||
<span id="evennia-server-admin"></span><h1>evennia.server.admin<a class="headerlink" href="#module-evennia.server.admin" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.web.admin.server">
|
||||
<span id="evennia-web-admin-server"></span><h1>evennia.web.admin.server<a class="headerlink" href="#module-evennia.web.admin.server" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This sets up how models are displayed
|
||||
in the web admin interface.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.admin.</code><code class="sig-name descname">ServerConfigAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/admin.html#ServerConfigAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.server.</code><code class="sig-name descname">ServerConfigAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/server.html#ServerConfigAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin" 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>Custom admin for server configs</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('db_key', 'db_value')</em><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('db_key', 'db_value')</em><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('db_key',)</em><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin.list_display_links">
|
||||
<code class="sig-name descname">list_display_links</code><em class="property"> = ('db_key',)</em><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['db_key', 'db_value']</em><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin.ordering">
|
||||
<code class="sig-name descname">ordering</code><em class="property"> = ['db_key', 'db_value']</em><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['db_key']</em><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ['db_key']</em><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin.save_as">
|
||||
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin.save_on_top">
|
||||
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin.list_select_related">
|
||||
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.server.admin.ServerConfigAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.server.admin.ServerConfigAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.web.admin.server.ServerConfigAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.server.ServerConfigAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -112,7 +114,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.server.admin.rst.txt"
|
||||
<li><a href="../_sources/api/evennia.web.admin.server.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -128,8 +130,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.server.admin.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.server.admin.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.web.admin.server.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -146,7 +148,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.server.admin</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.server</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
339
docs/1.0-dev/api/evennia.web.admin.tags.html
Normal file
339
docs/1.0-dev/api/evennia.web.admin.tags.html
Normal file
|
|
@ -0,0 +1,339 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.tags — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.tags</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.tags">
|
||||
<span id="evennia-web-admin-tags"></span><h1>evennia.web.admin.tags<a class="headerlink" href="#module-evennia.web.admin.tags" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Tag admin</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.tags.TagForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.tags.</code><code class="sig-name descname">TagForm</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/web/admin/tags.html#TagForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.TagForm" 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>Form to display fields in the stand-alone Tag display.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.tags.TagForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#TagForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.TagForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ('tag_key', 'tag_category', 'tag_data', 'tag_type')</em><a class="headerlink" href="#evennia.web.admin.tags.TagForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_category': <django.forms.fields.CharField object>, 'db_data': <django.forms.fields.CharField object>, 'db_key': <django.forms.fields.CharField object>, 'db_model': <django.forms.fields.ChoiceField object>, 'db_tagtype': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.tags.TagForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_category': <django.forms.fields.CharField object>, 'db_data': <django.forms.fields.CharField object>, 'db_key': <django.forms.fields.CharField object>, 'db_model': <django.forms.fields.ChoiceField object>, 'db_tagtype': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.tags.TagForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.tags.TagForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.tags.TagForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.tags.InlineTagForm">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.tags.</code><code class="sig-name descname">InlineTagForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#InlineTagForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.InlineTagForm" 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>Form for displaying tags inline together with other entities.</p>
|
||||
<p>This form overrides the base behavior of the ModelForm that would be used for a
|
||||
Tag-through-model. Since the through-models only have access to the foreignkeys of the Tag and
|
||||
the Object that they’re attached to, we need to spoof the behavior of it being a form that would
|
||||
correspond to its tag, or the creation of a tag. Instead of being saved, we’ll call to the
|
||||
Object’s handler, which will handle the creation, change, or deletion of a tag for us, as well
|
||||
as updating the handler’s cache so that all changes are instantly updated in-game.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.tags.InlineTagForm.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#InlineTagForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.InlineTagForm.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="py attribute">
|
||||
<dt id="evennia.web.admin.tags.InlineTagForm.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ('tag_key', 'tag_category', 'tag_data', 'tag_type')</em><a class="headerlink" href="#evennia.web.admin.tags.InlineTagForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.tags.InlineTagForm.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#InlineTagForm.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.InlineTagForm.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If we have a tag, then we’ll prepopulate our instance with the fields we’d expect it
|
||||
to have based on the tag. tag_key, tag_category, tag_type, and tag_data all refer to
|
||||
the corresponding tag fields. The initial data of the form fields will similarly be
|
||||
populated.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.tags.InlineTagForm.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#InlineTagForm.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.InlineTagForm.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>One thing we want to do here is the or None checks, because forms are saved with an empty
|
||||
string rather than null from forms, usually, and the Handlers may handle empty strings
|
||||
differently than None objects. So for consistency with how things are handled in game,
|
||||
we’ll try to make sure that empty form fields will be None, rather than ‘’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.InlineTagForm.base_fields">
|
||||
<code class="sig-name descname">base_fields</code><em class="property"> = {'tag_category': <django.forms.fields.CharField object>, 'tag_data': <django.forms.fields.CharField object>, 'tag_key': <django.forms.fields.CharField object>, 'tag_type': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.tags.InlineTagForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.InlineTagForm.declared_fields">
|
||||
<code class="sig-name descname">declared_fields</code><em class="property"> = {'tag_category': <django.forms.fields.CharField object>, 'tag_data': <django.forms.fields.CharField object>, 'tag_key': <django.forms.fields.CharField object>, 'tag_type': <django.forms.fields.ChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.tags.InlineTagForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.tags.InlineTagForm.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.tags.InlineTagForm.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all media required to render the widgets on this form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.tags.TagFormSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.tags.</code><code class="sig-name descname">TagFormSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">files</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">instance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">save_as_new</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">prefix</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#TagFormSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.TagFormSet" 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.BaseInlineFormSet</span></code></p>
|
||||
<p>The Formset handles all the inline forms that are grouped together on the change page of the
|
||||
corresponding object. All the tags will appear here, and we’ll save them by overriding the
|
||||
formset’s save method. The forms will similarly spoof their save methods to return an instance
|
||||
which hasn’t been saved to the database, but have the relevant fields filled out based on the
|
||||
contents of the cleaned form. We’ll then use that to call to the handler of the corresponding
|
||||
Object, where the handler is an AliasHandler, PermissionsHandler, or TagHandler, based on the
|
||||
type of tag.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagFormSet.verbose_name">
|
||||
<code class="sig-name descname">verbose_name</code><em class="property"> = 'Tag'</em><a class="headerlink" href="#evennia.web.admin.tags.TagFormSet.verbose_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagFormSet.verbose_name_plural">
|
||||
<code class="sig-name descname">verbose_name_plural</code><em class="property"> = 'Tags'</em><a class="headerlink" href="#evennia.web.admin.tags.TagFormSet.verbose_name_plural" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.tags.TagFormSet.save">
|
||||
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#TagFormSet.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.TagFormSet.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Save model instances for every form, adding and changing instances
|
||||
as necessary, and return the list of instances.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.tags.TagInline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.tags.</code><code class="sig-name descname">TagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#TagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.TagInline" 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.TabularInline</span></code></p>
|
||||
<p>A handler for inline Tags. This class should be subclassed in the admin of your models,
|
||||
and the ‘model’ and ‘related_field’ class attributes must be set. model should be the
|
||||
through model (ObjectDB_db_tag’, for example), while related field should be the name
|
||||
of the field on that through model which points to the model being used: ‘objectdb’,
|
||||
‘msg’, ‘accountdb’, etc.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagInline.model">
|
||||
<code class="sig-name descname">model</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.admin.tags.TagInline.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagInline.verbose_name">
|
||||
<code class="sig-name descname">verbose_name</code><em class="property"> = 'Tag'</em><a class="headerlink" href="#evennia.web.admin.tags.TagInline.verbose_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagInline.verbose_name_plural">
|
||||
<code class="sig-name descname">verbose_name_plural</code><em class="property"> = 'Tags'</em><a class="headerlink" href="#evennia.web.admin.tags.TagInline.verbose_name_plural" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagInline.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.tags.TagInline.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.tags.InlineTagForm" title="evennia.web.admin.tags.InlineTagForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">InlineTagForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagInline.formset">
|
||||
<code class="sig-name descname">formset</code><a class="headerlink" href="#evennia.web.admin.tags.TagInline.formset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.tags.TagFormSet" title="evennia.web.admin.tags.TagFormSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagFormSet</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagInline.related_field">
|
||||
<code class="sig-name descname">related_field</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.admin.tags.TagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagInline.extra">
|
||||
<code class="sig-name descname">extra</code><em class="property"> = 0</em><a class="headerlink" href="#evennia.web.admin.tags.TagInline.extra" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.tags.TagInline.get_formset">
|
||||
<code class="sig-name descname">get_formset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#TagInline.get_formset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.TagInline.get_formset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>get_formset has to return a class, but we need to make the class that we return
|
||||
know about the related_field that we’ll use. Returning the class itself rather than
|
||||
a proxy isn’t threadsafe, since it’d be the base class and would change if multiple
|
||||
people used the admin at the same time</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.tags.TagInline.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.tags.TagInline.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.admin.tags.TagAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.tags.</code><code class="sig-name descname">TagAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/tags.html#TagAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.tags.TagAdmin" 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>A django Admin wrapper for Tags.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagAdmin.search_fields">
|
||||
<code class="sig-name descname">search_fields</code><em class="property"> = ('db_key', 'db_category', 'db_tagtype')</em><a class="headerlink" href="#evennia.web.admin.tags.TagAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagAdmin.list_display">
|
||||
<code class="sig-name descname">list_display</code><em class="property"> = ('db_key', 'db_category', 'db_tagtype', 'db_model', 'db_data')</em><a class="headerlink" href="#evennia.web.admin.tags.TagAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagAdmin.list_filter">
|
||||
<code class="sig-name descname">list_filter</code><em class="property"> = ('db_tagtype', 'db_category', 'db_model')</em><a class="headerlink" href="#evennia.web.admin.tags.TagAdmin.list_filter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagAdmin.form">
|
||||
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.tags.TagAdmin.form" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.tags.TagForm" title="evennia.web.admin.tags.TagForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagAdmin.view_on_site">
|
||||
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.tags.TagAdmin.view_on_site" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.admin.tags.TagAdmin.fieldsets">
|
||||
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_category'), ('db_tagtype', 'db_model'), 'db_data')}),)</em><a class="headerlink" href="#evennia.web.admin.tags.TagAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.admin.tags.TagAdmin.media">
|
||||
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.tags.TagAdmin.media" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.tags.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.tags.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.tags</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
113
docs/1.0-dev/api/evennia.web.admin.urls.html
Normal file
113
docs/1.0-dev/api/evennia.web.admin.urls.html
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.urls — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.urls</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.urls">
|
||||
<span id="evennia-web-admin-urls"></span><h1>evennia.web.admin.urls<a class="headerlink" href="#module-evennia.web.admin.urls" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Rerouting admin frontpage to evennia version.</p>
|
||||
<p>These patterns are all under the admin/* namespace.</p>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.urls.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.urls.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.urls</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
152
docs/1.0-dev/api/evennia.web.admin.utils.html
Normal file
152
docs/1.0-dev/api/evennia.web.admin.utils.html
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.admin.utils — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.utils</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.admin.utils">
|
||||
<span id="evennia-web-admin-utils"></span><h1>evennia.web.admin.utils<a class="headerlink" href="#module-evennia.web.admin.utils" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Helper utils for admin views.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.web.admin.utils.get_and_load_typeclasses">
|
||||
<code class="sig-prename descclassname">evennia.web.admin.utils.</code><code class="sig-name descname">get_and_load_typeclasses</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">excluded_parents</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/utils.html#get_and_load_typeclasses"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.utils.get_and_load_typeclasses" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all typeclasses. We we need to initialize things here
|
||||
for them to be actually available in the admin process.
|
||||
This is intended to be used with forms.ChoiceField.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>parent</strong> (<em>str</em><em> or </em><em>class</em><em>, </em><em>optional</em>) – Limit selection to this class and its children
|
||||
(at any distance).</p></li>
|
||||
<li><p><strong>exclude</strong> (<em>list</em>) – Class-parents to exclude from the resulting list. All
|
||||
children of these paretns will be skipped.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>list</em> – A list of (str, str), the way ChoiceField wants it.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.web.admin.utils.get_and_load_cmdsets">
|
||||
<code class="sig-prename descclassname">evennia.web.admin.utils.</code><code class="sig-name descname">get_and_load_cmdsets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">excluded_parents</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/utils.html#get_and_load_cmdsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.utils.get_and_load_cmdsets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all cmdsets available or as children based on a parent cmdset. We need
|
||||
to initialize things here to make sure as much as possible is loaded in the
|
||||
admin process. This is intended to be used with forms.ChoiceField.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>parent</strong> (<em>str</em><em>, </em><em>optional</em>) – Python-path to the parent cmdset, if any.</p></li>
|
||||
<li><p><strong>excluded_parents</strong> (<em>list</em>) – A list of cmset-paths to exclude from the result.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>list</em> – A list of (str, str), the way ChoiceField wants it.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.admin.utils.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.admin.utils.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.utils</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -183,14 +183,14 @@ documentation specifically regarding DRF integration.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.filters.AccountDBFilterSet.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ['db_key', 'db_typeclass_path', 'db_tags__db_key', 'db_tags__db_category', 'username', 'db_is_connected', 'db_is_bot']</em><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ['db_typeclass_path', 'db_tags__db_key', 'db_tags__db_category', 'username', 'db_is_connected', 'db_is_bot']</em><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.filters.AccountDBFilterSet.base_filters">
|
||||
<code class="sig-name descname">base_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'db_is_bot': <django_filters.rest_framework.filters.BooleanFilter object>, 'db_is_connected': <django_filters.rest_framework.filters.BooleanFilter object>, 'db_key': <django_filters.filters.CharFilter object>, 'db_tags__db_category': <django_filters.filters.CharFilter object>, 'db_tags__db_key': <django_filters.filters.CharFilter object>, 'db_typeclass_path': <django_filters.filters.CharFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>, 'username': <django_filters.filters.CharFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.base_filters" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">base_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'db_is_bot': <django_filters.rest_framework.filters.BooleanFilter object>, 'db_is_connected': <django_filters.rest_framework.filters.BooleanFilter object>, 'db_tags__db_category': <django_filters.filters.CharFilter object>, 'db_tags__db_key': <django_filters.filters.CharFilter object>, 'db_typeclass_path': <django_filters.filters.CharFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>, 'username': <django_filters.filters.CharFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.base_filters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -234,6 +234,23 @@ documentation specifically regarding DRF integration.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.filters.HelpFilterSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">HelpFilterSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">request</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">prefix</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#HelpFilterSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.HelpFilterSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django_filters.rest_framework.filterset.FilterSet</span></code></p>
|
||||
<p>Filter for help entries</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.filters.HelpFilterSet.base_filters">
|
||||
<code class="sig-name descname">base_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'category': <django_filters.filters.CharFilter object>, 'name': <django_filters.filters.CharFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.HelpFilterSet.base_filters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.filters.HelpFilterSet.declared_filters">
|
||||
<code class="sig-name descname">declared_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'category': <django_filters.filters.CharFilter object>, 'name': <django_filters.filters.CharFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.HelpFilterSet.declared_filters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -44,6 +44,7 @@
|
|||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.api.filters.html">evennia.web.api.filters</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.api.permissions.html">evennia.web.api.permissions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.api.root.html">evennia.web.api.root</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.api.serializers.html">evennia.web.api.serializers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.api.tests.html">evennia.web.api.tests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.api.urls.html">evennia.web.api.urls</a></li>
|
||||
|
|
|
|||
|
|
@ -40,13 +40,14 @@
|
|||
|
||||
<section id="module-evennia.web.api.permissions">
|
||||
<span id="evennia-web-api-permissions"></span><h1>evennia.web.api.permissions<a class="headerlink" href="#module-evennia.web.api.permissions" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Sets up an api-access permission check using the in-game permission hierarchy.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.permissions.EvenniaPermission">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.permissions.</code><code class="sig-name descname">EvenniaPermission</code><a class="reference internal" href="../_modules/evennia/web/api/permissions.html#EvenniaPermission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.permissions.BasePermission</span></code></p>
|
||||
<p>A Django Rest Framework permission class that allows us to use
|
||||
Evennia’s permission structure. Based on the action in a given
|
||||
view, we’ll check a corresponding Evennia access/lock check.</p>
|
||||
<p>A Django Rest Framework permission class that allows us to use Evennia’s
|
||||
permission structure. Based on the action in a given view, we’ll check a
|
||||
corresponding Evennia access/lock check.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.permissions.EvenniaPermission.MINIMUM_LIST_PERMISSION">
|
||||
<code class="sig-name descname">MINIMUM_LIST_PERMISSION</code><em class="property"> = 'builder'</em><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.MINIMUM_LIST_PERMISSION" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
131
docs/1.0-dev/api/evennia.web.api.root.html
Normal file
131
docs/1.0-dev/api/evennia.web.api.root.html
Normal file
|
|
@ -0,0 +1,131 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.api.root — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.api.root</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.api.root">
|
||||
<span id="evennia-web-api-root"></span><h1>evennia.web.api.root<a class="headerlink" href="#module-evennia.web.api.root" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Set a more useful description on the Api root.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.root.EvenniaAPIRoot">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.root.</code><code class="sig-name descname">EvenniaAPIRoot</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/root.html#EvenniaAPIRoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.root.EvenniaAPIRoot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.routers.APIRootView</span></code></p>
|
||||
<p>Root of the Evennia API tree.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.root.APIRootRouter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.root.</code><code class="sig-name descname">APIRootRouter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/root.html#APIRootRouter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.root.APIRootRouter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.routers.DefaultRouter</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.root.APIRootRouter.APIRootView">
|
||||
<code class="sig-name descname">APIRootView</code><a class="headerlink" href="#evennia.web.api.root.APIRootRouter.APIRootView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="#evennia.web.api.root.EvenniaAPIRoot" title="evennia.web.api.root.EvenniaAPIRoot"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvenniaAPIRoot</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.api.root.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.api.root.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.api.root</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -52,6 +52,7 @@ often django model instances, that we can use (deserialization).</p>
|
|||
<dt id="evennia.web.api.serializers.AttributeSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">AttributeSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AttributeSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||||
<p>Serialize Attribute views.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.AttributeSerializer.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AttributeSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -133,12 +134,14 @@ often django model instances, that we can use (deserialization).</p>
|
|||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">TypeclassSerializerMixin</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin" 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>Mixin that contains types shared by typeclasses. A note about tags, aliases, and permissions. You
|
||||
might note that the methods and fields are defined here, but they’re included explicitly in each child
|
||||
class. What gives? It’s a DRF error: serializer method fields which are inherited do not resolve correctly
|
||||
in child classes, and as of this current version (3.11) you must have them in the child classes explicitly
|
||||
to avoid field errors. Similarly, the child classes must contain the attribute serializer explicitly to
|
||||
not have them render PK-related fields.</p>
|
||||
<p>Mixin that contains types shared by typeclasses. A note about tags,
|
||||
aliases, and permissions. You might note that the methods and fields are
|
||||
defined here, but they’re included explicitly in each child class. What
|
||||
gives? It’s a DRF error: serializer method fields which are inherited do
|
||||
not resolve correctly in child classes, and as of this current version
|
||||
(3.11) you must have them in the child classes explicitly to avoid field
|
||||
errors. Similarly, the child classes must contain the attribute serializer
|
||||
explicitly to not have them render PK-related fields.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin.shared_fields">
|
||||
<code class="sig-name descname">shared_fields</code><em class="property"> = ['id', 'db_key', 'attributes', 'db_typeclass_path', 'aliases', 'tags', 'permissions']</em><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.shared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -206,10 +209,23 @@ not have them render PK-related fields.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.TypeclassListSerializerMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">TypeclassListSerializerMixin</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassListSerializerMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" 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>Shortened serializer for list views.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.TypeclassListSerializerMixin.shared_fields">
|
||||
<code class="sig-name descname">shared_fields</code><em class="property"> = ['id', 'db_key', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.api.serializers.TypeclassListSerializerMixin.shared_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.ObjectDBSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">ObjectDBSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin" title="evennia.web.api.serializers.TypeclassSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||||
<p>Serializing Objects.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.ObjectDBSerializer.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -258,6 +274,35 @@ not have them render PK-related fields.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.ObjectListSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">ObjectListSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectListSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassListSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||||
<p>Shortened representation for listings.]</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.ObjectListSerializer.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectListSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer.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="py attribute">
|
||||
<dt id="evennia.web.api.serializers.ObjectListSerializer.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.ObjectListSerializer.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ['db_location', 'db_home', 'id', 'db_key', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.ObjectListSerializer.Meta.read_only_fields">
|
||||
<code class="sig-name descname">read_only_fields</code><em class="property"> = ['id']</em><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.read_only_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.AccountSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">AccountSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -300,10 +345,40 @@ not have them render PK-related fields.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.AccountListSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">AccountListSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountListSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassListSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||||
<p>A shortened form for listing.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.AccountListSerializer.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountListSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer.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="py attribute">
|
||||
<dt id="evennia.web.api.serializers.AccountListSerializer.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount" title="evennia.accounts.accounts.DefaultAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.accounts.DefaultAccount</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.AccountListSerializer.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ['username', 'id', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.AccountListSerializer.Meta.read_only_fields">
|
||||
<code class="sig-name descname">read_only_fields</code><em class="property"> = ['id']</em><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer.Meta.read_only_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.ScriptDBSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">ScriptDBSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptDBSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin" title="evennia.web.api.serializers.TypeclassSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||||
<p>Serializing Account.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.ScriptDBSerializer.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptDBSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -328,6 +403,93 @@ not have them render PK-related fields.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.ScriptListSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">ScriptListSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptListSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassListSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||||
<p>Shortened form for listing.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.ScriptListSerializer.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptListSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer.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="py attribute">
|
||||
<dt id="evennia.web.api.serializers.ScriptListSerializer.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.scripts.models.html#evennia.scripts.models.ScriptDB" title="evennia.scripts.models.ScriptDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.models.ScriptDB</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.ScriptListSerializer.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ['db_interval', 'db_persistent', 'db_start_delay', 'db_is_active', 'db_repeats', 'id', 'db_key', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.ScriptListSerializer.Meta.read_only_fields">
|
||||
<code class="sig-name descname">read_only_fields</code><em class="property"> = ['id']</em><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.read_only_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.HelpSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">HelpSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#HelpSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin" title="evennia.web.api.serializers.TypeclassSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||||
<p>Serializers Help entries (not a typeclass).</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.HelpSerializer.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#HelpSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer.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="py attribute">
|
||||
<dt id="evennia.web.api.serializers.HelpSerializer.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.help.models.html#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>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.HelpSerializer.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ['id', 'db_key', 'db_help_category', 'db_entrytext', 'db_date_created', 'tags', 'aliases']</em><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.HelpSerializer.Meta.read_only_fields">
|
||||
<code class="sig-name descname">read_only_fields</code><em class="property"> = ['id']</em><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer.Meta.read_only_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.HelpListSerializer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">HelpListSerializer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#HelpListSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassListSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||||
<p>Shortened form for listings.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.serializers.HelpListSerializer.Meta">
|
||||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#HelpListSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer.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="py attribute">
|
||||
<dt id="evennia.web.api.serializers.HelpListSerializer.Meta.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.help.models.html#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>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.HelpListSerializer.Meta.fields">
|
||||
<code class="sig-name descname">fields</code><em class="property"> = ['id', 'db_key', 'db_help_category', 'db_date_created']</em><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.serializers.HelpListSerializer.Meta.read_only_fields">
|
||||
<code class="sig-name descname">read_only_fields</code><em class="property"> = ['id']</em><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer.Meta.read_only_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
|
||||
<section id="module-evennia.web.api.tests">
|
||||
<span id="evennia-web-api-tests"></span><h1>evennia.web.api.tests<a class="headerlink" href="#module-evennia.web.api.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Tests for the REST API</p>
|
||||
<p>Tests for the REST API.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.tests.</code><code class="sig-name descname">TestEvenniaRESTApi</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
|
|
@ -47,8 +47,8 @@ that you want, and then a router will automatically generate URLs based on the
|
|||
actions that it detects for a viewset. For example, below we create a DefaultRouter.
|
||||
We then register ObjectDBViewSet, a viewset for CRUD operations for ObjectDB
|
||||
instances, to the ‘objects’ base endpoint. That will generate a number of URLs
|
||||
like the following:
|
||||
list objects: action: GET, url: /objects/, view name: object-list
|
||||
like the following:</p>
|
||||
<p>list objects: action: GET, url: /objects/, view name: object-list
|
||||
create object: action: POST, url: /objects/, view name: object-list
|
||||
retrieve object: action: GET, url: /objects/<:pk>, view name: object-detail
|
||||
update object: action: POST, url: /objects/<:pk>, view name: object-detail
|
||||
|
|
|
|||
|
|
@ -40,15 +40,35 @@
|
|||
|
||||
<section id="module-evennia.web.api.views">
|
||||
<span id="evennia-web-api-views"></span><h1>evennia.web.api.views<a class="headerlink" href="#module-evennia.web.api.views" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Views are the functions that are called by different url endpoints.
|
||||
The Django Rest Framework provides collections called ‘ViewSets’, which
|
||||
can generate a number of views for the common CRUD operations.</p>
|
||||
<p>Views are the functions that are called by different url endpoints. The Django
|
||||
Rest Framework provides collections called ‘ViewSets’, which can generate a
|
||||
number of views for the common CRUD operations.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.views.GeneralViewSetMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">GeneralViewSetMixin</code><a class="reference internal" href="../_modules/evennia/web/api/views.html#GeneralViewSetMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.GeneralViewSetMixin" 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>Mixin for both typeclass- and non-typeclass entities.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.api.views.GeneralViewSetMixin.get_serializer_class">
|
||||
<code class="sig-name descname">get_serializer_class</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#GeneralViewSetMixin.get_serializer_class"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.GeneralViewSetMixin.get_serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allow different serializers for certain actions.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.views.TypeclassViewSetMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">TypeclassViewSetMixin</code><a class="reference internal" href="../_modules/evennia/web/api/views.html#TypeclassViewSetMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.TypeclassViewSetMixin" 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>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.GeneralViewSetMixin" title="evennia.web.api.views.GeneralViewSetMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.GeneralViewSetMixin</span></code></a></p>
|
||||
<p>This mixin adds some shared functionality to each viewset of a typeclass. They all use the same
|
||||
permission classes and filter backend. You can override any of these in your own viewsets.</p>
|
||||
<p>The <strong>set_atribute</strong> action is an example of a custom action added to a
|
||||
viewset. Based on the name of the method, it will create a default url_name
|
||||
(used for reversing) and url_path. The ‘pk’ argument is automatically
|
||||
passed to this action because it has a url path of the format <object
|
||||
type>/:pk/set-attribute. The get_object method is automatically set in the
|
||||
expected viewset classes that will inherit this, using the pk that’s passed
|
||||
along to retrieve the object.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.TypeclassViewSetMixin.permission_classes">
|
||||
<code class="sig-name descname">permission_classes</code><em class="property"> = [<class 'evennia.web.api.permissions.EvenniaPermission'>]</em><a class="headerlink" href="#evennia.web.api.views.TypeclassViewSetMixin.permission_classes" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -62,14 +82,8 @@ permission classes and filter backend. You can override any of these in your own
|
|||
<dl class="py method">
|
||||
<dt id="evennia.web.api.views.TypeclassViewSetMixin.set_attribute">
|
||||
<code class="sig-name descname">set_attribute</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">pk</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#TypeclassViewSetMixin.set_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.TypeclassViewSetMixin.set_attribute" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is an example of a custom action added to a viewset. Based on the name of the
|
||||
method, it will create a default url_name (used for reversing) and url_path.
|
||||
The ‘pk’ argument is automatically passed to this action because it has a url path
|
||||
of the format <object type>/:pk/set-attribute. The get_object method is automatically
|
||||
set in the expected viewset classes that will inherit this, using the pk that’s
|
||||
passed along to retrieve the object.</p>
|
||||
<p>This action will set an attribute if the db_value is defined, or remove it
|
||||
if no db_value is provided.</p>
|
||||
<dd><p>This action will set an attribute if the db_value is defined, or remove
|
||||
it if no db_value is provided.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -78,10 +92,8 @@ if no db_value is provided.</p>
|
|||
<dt id="evennia.web.api.views.ObjectDBViewSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">ObjectDBViewSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#ObjectDBViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.TypeclassViewSetMixin" title="evennia.web.api.views.TypeclassViewSetMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.TypeclassViewSetMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.viewsets.ModelViewSet</span></code></p>
|
||||
<p>An example of a basic viewset for all ObjectDB instances. It declares the
|
||||
serializer to use for both retrieving and changing/creating/deleting
|
||||
instances. Serializers are similar to django forms, used for the
|
||||
transmitting of data (typically json).</p>
|
||||
<p>The Object is the parent for all in-game entities that have a location
|
||||
(rooms, exits, characters etc).</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ObjectDBViewSet.serializer_class">
|
||||
<code class="sig-name descname">serializer_class</code><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -99,6 +111,12 @@ transmitting of data (typically json).</p>
|
|||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.filters.html#evennia.web.api.filters.ObjectDBFilterSet" title="evennia.web.api.filters.ObjectDBFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.ObjectDBFilterSet</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ObjectDBViewSet.list_serializer_class">
|
||||
<code class="sig-name descname">list_serializer_class</code><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.list_serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.serializers.html#evennia.web.api.serializers.ObjectListSerializer" title="evennia.web.api.serializers.ObjectListSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.ObjectListSerializer</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ObjectDBViewSet.basename">
|
||||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -130,13 +148,18 @@ transmitting of data (typically json).</p>
|
|||
<dt id="evennia.web.api.views.CharacterViewSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">CharacterViewSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#CharacterViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.ObjectDBViewSet" title="evennia.web.api.views.ObjectDBViewSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.ObjectDBViewSet</span></code></a></p>
|
||||
<p>This overrides the queryset to only retrieve Character objects
|
||||
based on your DefaultCharacter typeclass path.</p>
|
||||
<p>Characters are a type of Object commonly used as player avatars in-game.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.CharacterViewSet.queryset">
|
||||
<code class="sig-name descname">queryset</code><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.CharacterViewSet.list_serializer_class">
|
||||
<code class="sig-name descname">list_serializer_class</code><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.list_serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.serializers.html#evennia.web.api.serializers.ObjectListSerializer" title="evennia.web.api.serializers.ObjectListSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.ObjectListSerializer</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.CharacterViewSet.basename">
|
||||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -168,12 +191,18 @@ based on your DefaultCharacter typeclass path.</p>
|
|||
<dt id="evennia.web.api.views.RoomViewSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">RoomViewSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#RoomViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.RoomViewSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.ObjectDBViewSet" title="evennia.web.api.views.ObjectDBViewSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.ObjectDBViewSet</span></code></a></p>
|
||||
<p>Viewset for Room objects</p>
|
||||
<p>Rooms indicate discrete locations in-game.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.RoomViewSet.queryset">
|
||||
<code class="sig-name descname">queryset</code><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.RoomViewSet.list_serializer_class">
|
||||
<code class="sig-name descname">list_serializer_class</code><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.list_serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.serializers.html#evennia.web.api.serializers.ObjectListSerializer" title="evennia.web.api.serializers.ObjectListSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.ObjectListSerializer</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.RoomViewSet.basename">
|
||||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -205,12 +234,19 @@ based on your DefaultCharacter typeclass path.</p>
|
|||
<dt id="evennia.web.api.views.ExitViewSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">ExitViewSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#ExitViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.ExitViewSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.ObjectDBViewSet" title="evennia.web.api.views.ObjectDBViewSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.ObjectDBViewSet</span></code></a></p>
|
||||
<p>Viewset for Exit objects</p>
|
||||
<p>Exits are objects with a destination and allows for traversing from one
|
||||
location to another.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ExitViewSet.queryset">
|
||||
<code class="sig-name descname">queryset</code><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ExitViewSet.list_serializer_class">
|
||||
<code class="sig-name descname">list_serializer_class</code><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.list_serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.serializers.html#evennia.web.api.serializers.ObjectListSerializer" title="evennia.web.api.serializers.ObjectListSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.ObjectListSerializer</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ExitViewSet.basename">
|
||||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -242,7 +278,7 @@ based on your DefaultCharacter typeclass path.</p>
|
|||
<dt id="evennia.web.api.views.AccountDBViewSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">AccountDBViewSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#AccountDBViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.TypeclassViewSetMixin" title="evennia.web.api.views.TypeclassViewSetMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.TypeclassViewSetMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.viewsets.ModelViewSet</span></code></p>
|
||||
<p>Viewset for Account objects</p>
|
||||
<p>Accounts represent the players connected to the game</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.AccountDBViewSet.serializer_class">
|
||||
<code class="sig-name descname">serializer_class</code><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -260,6 +296,12 @@ based on your DefaultCharacter typeclass path.</p>
|
|||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.filters.html#evennia.web.api.filters.AccountDBFilterSet" title="evennia.web.api.filters.AccountDBFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.AccountDBFilterSet</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.AccountDBViewSet.list_serializer_class">
|
||||
<code class="sig-name descname">list_serializer_class</code><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.list_serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.serializers.html#evennia.web.api.serializers.AccountListSerializer" title="evennia.web.api.serializers.AccountListSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.AccountListSerializer</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.AccountDBViewSet.basename">
|
||||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -291,7 +333,8 @@ based on your DefaultCharacter typeclass path.</p>
|
|||
<dt id="evennia.web.api.views.ScriptDBViewSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">ScriptDBViewSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#ScriptDBViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.TypeclassViewSetMixin" title="evennia.web.api.views.TypeclassViewSetMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.TypeclassViewSetMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.viewsets.ModelViewSet</span></code></p>
|
||||
<p>Viewset for Script objects</p>
|
||||
<p>Scripts are meta-objects for storing system data, running timers etc. They
|
||||
have no in-game existence.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ScriptDBViewSet.serializer_class">
|
||||
<code class="sig-name descname">serializer_class</code><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -309,6 +352,12 @@ based on your DefaultCharacter typeclass path.</p>
|
|||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.filters.html#evennia.web.api.filters.ScriptDBFilterSet" title="evennia.web.api.filters.ScriptDBFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.ScriptDBFilterSet</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ScriptDBViewSet.list_serializer_class">
|
||||
<code class="sig-name descname">list_serializer_class</code><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.list_serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.serializers.html#evennia.web.api.serializers.ScriptListSerializer" title="evennia.web.api.serializers.ScriptListSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.ScriptListSerializer</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.ScriptDBViewSet.basename">
|
||||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -336,6 +385,62 @@ based on your DefaultCharacter typeclass path.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.api.views.HelpViewSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">HelpViewSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#HelpViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.HelpViewSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.GeneralViewSetMixin" title="evennia.web.api.views.GeneralViewSetMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.GeneralViewSetMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.viewsets.ModelViewSet</span></code></p>
|
||||
<p>Database-stored help entries.
|
||||
Note that command auto-help and file-based help entries are not accessible this way.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.serializer_class">
|
||||
<code class="sig-name descname">serializer_class</code><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.serializers.html#evennia.web.api.serializers.HelpSerializer" title="evennia.web.api.serializers.HelpSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.HelpSerializer</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.queryset">
|
||||
<code class="sig-name descname">queryset</code><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.filterset_class">
|
||||
<code class="sig-name descname">filterset_class</code><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.filterset_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.filters.html#evennia.web.api.filters.HelpFilterSet" title="evennia.web.api.filters.HelpFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.HelpFilterSet</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.list_serializer_class">
|
||||
<code class="sig-name descname">list_serializer_class</code><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.list_serializer_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.api.serializers.html#evennia.web.api.serializers.HelpListSerializer" title="evennia.web.api.serializers.HelpListSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.HelpListSerializer</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.basename">
|
||||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.description">
|
||||
<code class="sig-name descname">description</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.detail">
|
||||
<code class="sig-name descname">detail</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.api.views.HelpViewSet.suffix">
|
||||
<code class="sig-name descname">suffix</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.HelpViewSet.suffix" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -40,10 +40,8 @@
|
|||
|
||||
<section id="module-evennia.web">
|
||||
<span id="evennia-web"></span><h1>evennia.web<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 <strong>server</strong> package).</p>
|
||||
<p>This sub-package holds the web presence of Evennia, using normal Django to
|
||||
relate the database contents to web pages.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.urls.html">evennia.web.urls</a></li>
|
||||
|
|
@ -51,16 +49,36 @@ found under the <strong>server</strong> package).</p>
|
|||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.admin.html">evennia.web.admin</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.accounts.html">evennia.web.admin.accounts</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.attributes.html">evennia.web.admin.attributes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.comms.html">evennia.web.admin.comms</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.frontpage.html">evennia.web.admin.frontpage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.help.html">evennia.web.admin.help</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.objects.html">evennia.web.admin.objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.scripts.html">evennia.web.admin.scripts</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.server.html">evennia.web.admin.server</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.tags.html">evennia.web.admin.tags</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.urls.html">evennia.web.admin.urls</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.admin.utils.html">evennia.web.admin.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.api.html">evennia.web.api</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.filters.html">evennia.web.api.filters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.permissions.html">evennia.web.api.permissions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.root.html">evennia.web.api.root</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.serializers.html">evennia.web.api.serializers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.tests.html">evennia.web.api.tests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.urls.html">evennia.web.api.urls</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.views.html">evennia.web.api.views</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.templatetags.html">evennia.web.templatetags</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.templatetags.addclass.html">evennia.web.templatetags.addclass</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.adminsite.html">evennia.web.utils.adminsite</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.backends.html">evennia.web.utils.backends</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.general_context.html">evennia.web.utils.general_context</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.middleware.html">evennia.web.utils.middleware</a></li>
|
||||
|
|
@ -76,9 +94,15 @@ found under the <strong>server</strong> package).</p>
|
|||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.forms.html">evennia.web.website.forms</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.tests.html">evennia.web.website.tests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.urls.html">evennia.web.website.urls</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.templatetags.html">evennia.web.website.templatetags</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.templatetags.addclass.html">evennia.web.website.templatetags.addclass</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.accounts.html">evennia.web.website.views.accounts</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.channels.html">evennia.web.website.views.channels</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.characters.html">evennia.web.website.views.characters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.errors.html">evennia.web.website.views.errors</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.help.html">evennia.web.website.views.help</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.index.html">evennia.web.website.views.index</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.mixins.html">evennia.web.website.views.mixins</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.views.objects.html">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.templatetags.addclass — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.web.templatetags.addclass — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.templatetags.addclass</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.templatetags.addclass</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -38,11 +38,11 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.templatetags.addclass">
|
||||
<span id="evennia-web-website-templatetags-addclass"></span><h1>evennia.web.website.templatetags.addclass<a class="headerlink" href="#module-evennia.web.website.templatetags.addclass" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.web.templatetags.addclass">
|
||||
<span id="evennia-web-templatetags-addclass"></span><h1>evennia.web.templatetags.addclass<a class="headerlink" href="#module-evennia.web.templatetags.addclass" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py 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"><span class="n">field</span></em>, <em class="sig-param"><span class="n">given_class</span></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>
|
||||
<dt id="evennia.web.templatetags.addclass.addclass">
|
||||
<code class="sig-prename descclassname">evennia.web.templatetags.addclass.</code><code class="sig-name descname">addclass</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">field</span></em>, <em class="sig-param"><span class="n">given_class</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/templatetags/addclass.html#addclass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.templatetags.addclass.addclass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</section>
|
||||
|
|
@ -70,7 +70,7 @@
|
|||
<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.addclass.rst.txt"
|
||||
<li><a href="../_sources/api/evennia.web.templatetags.addclass.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -86,8 +86,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.templatetags.addclass.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.web.website.templatetags.addclass.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.web.templatetags.addclass.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -104,7 +104,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.templatetags.addclass</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.templatetags.addclass</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.templatetags — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.web.templatetags — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.templatetags</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.templatetags</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -38,11 +38,11 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.templatetags">
|
||||
<span id="evennia-web-website-templatetags"></span><h1>evennia.web.website.templatetags<a class="headerlink" href="#module-evennia.web.website.templatetags" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.web.templatetags">
|
||||
<span id="evennia-web-templatetags"></span><h1>evennia.web.templatetags<a class="headerlink" href="#module-evennia.web.templatetags" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.templatetags.addclass.html">evennia.web.website.templatetags.addclass</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.templatetags.addclass.html">evennia.web.templatetags.addclass</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -70,7 +70,7 @@
|
|||
<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"
|
||||
<li><a href="../_sources/api/evennia.web.templatetags.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -86,8 +86,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.templatetags.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.web.website.templatetags.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.web.templatetags.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -104,7 +104,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.templatetags</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.templatetags</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,6 +40,21 @@
|
|||
|
||||
<section id="module-evennia.web.urls">
|
||||
<span id="evennia-web-urls"></span><h1>evennia.web.urls<a class="headerlink" href="#module-evennia.web.urls" title="Permalink to this headline">¶</a></h1>
|
||||
<p>File that determines what each URL points to. This uses Python regular expressions.
|
||||
This is the starting point when a user enters an URL.</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>The URL is matched with a regex, tying it to a given view. Note that this central url.py
|
||||
file includes url.py from all the various web-components found in views/ so the search
|
||||
space is much larger than what is shown here.</p></li>
|
||||
<li><p>The view (a Python function or class is executed)</p></li>
|
||||
<li><p>The view uses a template (a HTML file which may contain template markers for dynamically
|
||||
modifying its contents; the locations of such templates are given by
|
||||
<strong>settings.TEMPLATES[0][‘DIRS’]</strong>) and which may in turn may include static
|
||||
assets (CSS, images etc).</p></li>
|
||||
<li><p>The view ‘renders’ the template into a finished HTML page, replacing all
|
||||
dynamic content as appropriate.</p></li>
|
||||
<li><p>The HTML page is returned to the user.</p></li>
|
||||
</ol>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
153
docs/1.0-dev/api/evennia.web.utils.adminsite.html
Normal file
153
docs/1.0-dev/api/evennia.web.utils.adminsite.html
Normal file
|
|
@ -0,0 +1,153 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.utils.adminsite — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.utils.adminsite</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.utils.adminsite">
|
||||
<span id="evennia-web-utils-adminsite"></span><h1>evennia.web.utils.adminsite<a class="headerlink" href="#module-evennia.web.utils.adminsite" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Custom Evennia admin-site, for better customization of the admin-site
|
||||
as a whole.</p>
|
||||
<p>This must be located outside of the admin/ folder because it must be imported
|
||||
before any of the app-data (which in turn must be imported in the <strong>__init__.py</strong>
|
||||
of that folder for Django to find them).</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.utils.adminsite.EvenniaAdminApp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.adminsite.</code><code class="sig-name descname">EvenniaAdminApp</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">app_name</span></em>, <em class="sig-param"><span class="n">app_module</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/adminsite.html#EvenniaAdminApp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.adminsite.EvenniaAdminApp" 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.apps.AdminConfig</span></code></p>
|
||||
<p>This is imported in INSTALLED_APPS instead of django.contrib.admin.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.utils.adminsite.EvenniaAdminApp.default_site">
|
||||
<code class="sig-name descname">default_site</code><em class="property"> = 'evennia.web.utils.adminsite.EvenniaAdminSite'</em><a class="headerlink" href="#evennia.web.utils.adminsite.EvenniaAdminApp.default_site" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.utils.adminsite.EvenniaAdminSite">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.adminsite.</code><code class="sig-name descname">EvenniaAdminSite</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'admin'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/adminsite.html#EvenniaAdminSite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.adminsite.EvenniaAdminSite" 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.sites.AdminSite</span></code></p>
|
||||
<p>The main admin site root (replacing the default from Django). When doing
|
||||
admin.register in the admin/ folder, this is what is being registered to.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.utils.adminsite.EvenniaAdminSite.site_header">
|
||||
<code class="sig-name descname">site_header</code><em class="property"> = 'Evennia web admin'</em><a class="headerlink" href="#evennia.web.utils.adminsite.EvenniaAdminSite.site_header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.utils.adminsite.EvenniaAdminSite.app_order">
|
||||
<code class="sig-name descname">app_order</code><em class="property"> = ['accounts', 'objects', 'scripts', 'comms', 'help', 'typeclasses', 'server', 'sites', 'flatpages', 'auth']</em><a class="headerlink" href="#evennia.web.utils.adminsite.EvenniaAdminSite.app_order" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.utils.adminsite.EvenniaAdminSite.get_app_list">
|
||||
<code class="sig-name descname">get_app_list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/adminsite.html#EvenniaAdminSite.get_app_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.adminsite.EvenniaAdminSite.get_app_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return a sorted list of all the installed apps that have been
|
||||
registered in this site.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.utils.adminsite.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.utils.adminsite.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.utils.adminsite</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -40,6 +40,10 @@
|
|||
|
||||
<section id="module-evennia.web.utils.general_context">
|
||||
<span id="evennia-web-utils-general-context"></span><h1>evennia.web.utils.general_context<a class="headerlink" href="#module-evennia.web.utils.general_context" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This file defines global variables that will always be available in a view
|
||||
context without having to repeatedly include it.</p>
|
||||
<p>For this to work, this file is included in the settings file, in the
|
||||
TEMPLATES[“OPTIONS”][“context_processors”] list.</p>
|
||||
<dl class="py 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>
|
||||
|
|
@ -61,8 +65,8 @@ to webclient settings.</p>
|
|||
<dl class="py 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"><span class="n">request</span></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><p>Returns common Evennia-related context stuff, which is automatically added
|
||||
to context of all views.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -42,6 +42,7 @@
|
|||
<span id="evennia-web-utils"></span><h1>evennia.web.utils<a class="headerlink" href="#module-evennia.web.utils" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.utils.adminsite.html">evennia.web.utils.adminsite</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.utils.backends.html">evennia.web.utils.backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.utils.general_context.html">evennia.web.utils.general_context</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.utils.middleware.html">evennia.web.utils.middleware</a></li>
|
||||
|
|
|
|||
|
|
@ -40,8 +40,7 @@
|
|||
|
||||
<section id="module-evennia.web.webclient.urls">
|
||||
<span id="evennia-web-webclient-urls"></span><h1>evennia.web.webclient.urls<a class="headerlink" href="#module-evennia.web.webclient.urls" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This structures the (simple) structure of the
|
||||
webpage ‘application’.</p>
|
||||
<p>This structures the (simple) structure of the webpage ‘application’.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -45,13 +45,19 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.forms.html">evennia.web.website.forms</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.tests.html">evennia.web.website.tests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.urls.html">evennia.web.website.urls</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.templatetags.html">evennia.web.website.templatetags</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.templatetags.addclass.html">evennia.web.website.templatetags.addclass</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.html">evennia.web.website.views</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.accounts.html">evennia.web.website.views.accounts</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.channels.html">evennia.web.website.views.channels</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.characters.html">evennia.web.website.views.characters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.errors.html">evennia.web.website.views.errors</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.help.html">evennia.web.website.views.help</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.index.html">evennia.web.website.views.index</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.mixins.html">evennia.web.website.views.mixins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.views.objects.html">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
|
||||
<section id="module-evennia.web.website.urls">
|
||||
<span id="evennia-web-website-urls"></span><h1>evennia.web.website.urls<a class="headerlink" href="#module-evennia.web.website.urls" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This structures the website.</p>
|
||||
<p>This redirects to website sub-pages.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
159
docs/1.0-dev/api/evennia.web.website.views.accounts.html
Normal file
159
docs/1.0-dev/api/evennia.web.website.views.accounts.html
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.views.accounts — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.accounts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.views.accounts">
|
||||
<span id="evennia-web-website-views-accounts"></span><h1>evennia.web.website.views.accounts<a class="headerlink" href="#module-evennia.web.website.views.accounts" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Views for managing accounts.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.accounts.AccountMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.accounts.</code><code class="sig-name descname">AccountMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views/accounts.html#AccountMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.accounts.AccountMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
|
||||
<p>This is used to grant abilities to classes it is added to.</p>
|
||||
<p>Any view class with this in its inheritance list will be modified to work
|
||||
with Account objects instead of generic Objects or otherwise.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.accounts.AccountMixin.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.accounts.AccountMixin.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount" title="evennia.accounts.accounts.DefaultAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.accounts.DefaultAccount</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.accounts.AccountMixin.form_class">
|
||||
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.accounts.AccountMixin.form_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.AccountForm" title="evennia.web.website.forms.AccountForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.AccountForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.accounts.AccountCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.accounts.</code><code class="sig-name descname">AccountCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/accounts.html#AccountCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.accounts.AccountCreateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.accounts.AccountMixin" title="evennia.web.website.views.accounts.AccountMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.accounts.AccountMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaCreateView" title="evennia.web.website.views.mixins.EvenniaCreateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaCreateView</span></code></a></p>
|
||||
<p>Account creation view.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.accounts.AccountCreateView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/registration/register.html'</em><a class="headerlink" href="#evennia.web.website.views.accounts.AccountCreateView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.accounts.AccountCreateView.success_url">
|
||||
<code class="sig-name descname">success_url</code><a class="headerlink" href="#evennia.web.website.views.accounts.AccountCreateView.success_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.accounts.AccountCreateView.form_valid">
|
||||
<code class="sig-name descname">form_valid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">form</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/accounts.html#AccountCreateView.form_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.accounts.AccountCreateView.form_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook, modified for Evennia.</p>
|
||||
<p>This hook is called after a valid form is submitted.</p>
|
||||
<p>When an account creation form is submitted and the data is deemed valid,
|
||||
proceeds with creating the Account object.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.views.accounts.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.views.accounts.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.accounts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
234
docs/1.0-dev/api/evennia.web.website.views.channels.html
Normal file
234
docs/1.0-dev/api/evennia.web.website.views.channels.html
Normal file
|
|
@ -0,0 +1,234 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.views.channels — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.channels</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.views.channels">
|
||||
<span id="evennia-web-website-views-channels"></span><h1>evennia.web.website.views.channels<a class="headerlink" href="#module-evennia.web.website.views.channels" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Views for managing channels.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.channels.ChannelMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.channels.</code><code class="sig-name descname">ChannelMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views/channels.html#ChannelMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.channels.ChannelMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
|
||||
<p>This is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Any view class with this in its inheritance list will be modified to work
|
||||
with HelpEntry objects instead of generic Objects or otherwise.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelMixin.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.channels.ChannelMixin.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.comms.comms.html#evennia.comms.comms.DefaultChannel" title="evennia.comms.comms.DefaultChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.comms.comms.DefaultChannel</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelMixin.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Channels'</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelMixin.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelMixin.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'listen'</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelMixin.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.channels.ChannelMixin.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/channels.html#ChannelMixin.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.channels.ChannelMixin.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook; here we want to return a list of only those Channels
|
||||
and other documentation that the current user is allowed to see.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – List of Channels available to the user.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.channels.ChannelListView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.channels.</code><code class="sig-name descname">ChannelListView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/channels.html#ChannelListView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.channels.ChannelListView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.channels.ChannelMixin" title="evennia.web.website.views.channels.ChannelMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.channels.ChannelMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
|
||||
<p>Returns a list of channels that can be viewed by a user, authenticated
|
||||
or not.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelListView.paginate_by">
|
||||
<code class="sig-name descname">paginate_by</code><em class="property"> = 100</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelListView.paginate_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelListView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/channel_list.html'</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelListView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelListView.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Channel Index'</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelListView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelListView.max_popular">
|
||||
<code class="sig-name descname">max_popular</code><em class="property"> = 10</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelListView.max_popular" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.channels.ChannelListView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/channels.html#ChannelListView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.channels.ChannelListView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook; we override it to calculate the most popular channels.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.channels.ChannelDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.channels.</code><code class="sig-name descname">ChannelDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/channels.html#ChannelDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.channels.ChannelDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.channels.ChannelMixin" title="evennia.web.website.views.channels.ChannelMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.channels.ChannelMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a></p>
|
||||
<p>Returns the log entries for a given channel.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/channel_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelDetailView.attributes">
|
||||
<code class="sig-name descname">attributes</code><em class="property"> = ['name']</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelDetailView.attributes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.channels.ChannelDetailView.max_num_lines">
|
||||
<code class="sig-name descname">max_num_lines</code><em class="property"> = 10000</em><a class="headerlink" href="#evennia.web.website.views.channels.ChannelDetailView.max_num_lines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.channels.ChannelDetailView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/channels.html#ChannelDetailView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.channels.ChannelDetailView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook; before we can display the channel logs, we need to recall
|
||||
the logfile and read its lines.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.channels.ChannelDetailView.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/channels.html#ChannelDetailView.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.channels.ChannelDetailView.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook that retrieves an object by slugified channel
|
||||
name.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>channel (Channel)</em> – Channel requested in the URL.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.views.channels.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.views.channels.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.channels</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
325
docs/1.0-dev/api/evennia.web.website.views.characters.html
Normal file
325
docs/1.0-dev/api/evennia.web.website.views.characters.html
Normal file
|
|
@ -0,0 +1,325 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.views.characters — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.characters</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.views.characters">
|
||||
<span id="evennia-web-website-views-characters"></span><h1>evennia.web.website.views.characters<a class="headerlink" href="#module-evennia.web.website.views.characters" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Views for manipulating Characters (children of Objects often used for
|
||||
puppeting).</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.characters.CharacterMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
|
||||
<p>This is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Any view class with this in its inheritance list will be modified to work
|
||||
with Character objects instead of generic Objects or otherwise.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterMixin.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterMixin.form_class">
|
||||
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.form_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.CharacterForm" title="evennia.web.website.forms.CharacterForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.CharacterForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterMixin.success_url">
|
||||
<code class="sig-name descname">success_url</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.success_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.characters.CharacterMixin.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterMixin.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will override the Django get_queryset method to only
|
||||
return a list of characters associated with the current authenticated
|
||||
user.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.characters.CharacterListView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterListView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterListView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
|
||||
<p>This view provides a mechanism by which a logged-in player can view a list
|
||||
of all other characters.</p>
|
||||
<p>This view requires authentication by default as a nominal effort to prevent
|
||||
human stalkers and automated bots/scrapers from harvesting data on your users.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterListView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_list.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterListView.paginate_by">
|
||||
<code class="sig-name descname">paginate_by</code><em class="property"> = 100</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.paginate_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterListView.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Character List'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterListView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.characters.CharacterListView.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterListView.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will override the Django get_queryset method to return a
|
||||
list of all characters (filtered/sorted) instead of just those limited
|
||||
to the account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.characters.CharacterPuppetView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterPuppetView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterPuppetView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterPuppetView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.base.RedirectView</span></code>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a logged-in player can “puppet” one
|
||||
of their characters within the context of the website.</p>
|
||||
<p>It also ensures that any user attempting to puppet something is logged in,
|
||||
and that their intended puppet is one that they own.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.characters.CharacterPuppetView.get_redirect_url">
|
||||
<code class="sig-name descname">get_redirect_url</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterPuppetView.get_redirect_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterPuppetView.get_redirect_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook.</p>
|
||||
<p>This view returns the URL to which the user should be redirected after
|
||||
a passed or failed puppet attempt.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>url (str)</em> – Path to post-puppet destination.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.characters.CharacterManageView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterManageView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterManageView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
|
||||
<p>This view provides a mechanism by which a logged-in player can browse,
|
||||
edit, or delete their own characters.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterManageView.paginate_by">
|
||||
<code class="sig-name descname">paginate_by</code><em class="property"> = 10</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.paginate_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterManageView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_manage_list.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterManageView.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Manage Characters'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.characters.CharacterUpdateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterUpdateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterUpdateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectUpdateView" title="evennia.web.website.views.objects.ObjectUpdateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectUpdateView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a logged-in player (enforced by
|
||||
ObjectUpdateView) can edit the attributes of a character they own.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterUpdateView.form_class">
|
||||
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView.form_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.CharacterUpdateForm" title="evennia.web.website.forms.CharacterUpdateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.CharacterUpdateForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterUpdateView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_form.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.characters.CharacterDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a user can view the attributes of
|
||||
a character, owned by them or not.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterDetailView.attributes">
|
||||
<code class="sig-name descname">attributes</code><em class="property"> = ['name', 'desc']</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.attributes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterDetailView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.characters.CharacterDetailView.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterDetailView.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will override the Django get_queryset method to return a
|
||||
list of all characters the user may access.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.characters.CharacterDeleteView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterDeleteView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterDeleteView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDeleteView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectDeleteView" title="evennia.web.website.views.objects.ObjectDeleteView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDeleteView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a logged-in player (enforced by
|
||||
ObjectDeleteView) can delete a character they own.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.characters.CharacterCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectCreateView" title="evennia.web.website.views.objects.ObjectCreateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectCreateView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a logged-in player (enforced by
|
||||
ObjectCreateView) can create a new character.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.characters.CharacterCreateView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_form.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.characters.CharacterCreateView.form_valid">
|
||||
<code class="sig-name descname">form_valid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">form</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterCreateView.form_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView.form_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook, modified for Evennia.</p>
|
||||
<p>This hook is called after a valid form is submitted.</p>
|
||||
<p>When an character creation form is submitted and the data is deemed valid,
|
||||
proceeds with creating the Character object.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.views.characters.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.views.characters.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.characters</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
119
docs/1.0-dev/api/evennia.web.website.views.errors.html
Normal file
119
docs/1.0-dev/api/evennia.web.website.views.errors.html
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.views.errors — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.errors</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.views.errors">
|
||||
<span id="evennia-web-website-views-errors"></span><h1>evennia.web.website.views.errors<a class="headerlink" href="#module-evennia.web.website.views.errors" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Error views.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.web.website.views.errors.to_be_implemented">
|
||||
<code class="sig-prename descclassname">evennia.web.website.views.errors.</code><code class="sig-name descname">to_be_implemented</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/errors.html#to_be_implemented"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.errors.to_be_implemented" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A notice letting the user know that this particular feature hasn’t been
|
||||
implemented yet.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.views.errors.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.views.errors.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.errors</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
203
docs/1.0-dev/api/evennia.web.website.views.help.html
Normal file
203
docs/1.0-dev/api/evennia.web.website.views.help.html
Normal file
|
|
@ -0,0 +1,203 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.views.help — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.help</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.views.help">
|
||||
<span id="evennia-web-website-views-help"></span><h1>evennia.web.website.views.help<a class="headerlink" href="#module-evennia.web.website.views.help" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Views to manipulate help entries.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.help.HelpMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.help.</code><code class="sig-name descname">HelpMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views/help.html#HelpMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.help.HelpMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
|
||||
<p>This is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Any view class with this in its inheritance list will be modified to work
|
||||
with HelpEntry objects instead of generic Objects or otherwise.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.help.HelpMixin.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.help.HelpMixin.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.help.models.html#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>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.help.HelpMixin.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Help'</em><a class="headerlink" href="#evennia.web.website.views.help.HelpMixin.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.help.HelpMixin.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/help.html#HelpMixin.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.help.HelpMixin.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook; here we want to return a list of only those HelpEntries
|
||||
and other documentation that the current user is allowed to see.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – List of Help entries available to the user.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.help.HelpListView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.help.</code><code class="sig-name descname">HelpListView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/help.html#HelpListView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.help.HelpListView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.help.HelpMixin" title="evennia.web.website.views.help.HelpMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.help.HelpMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
|
||||
<p>Returns a list of help entries that can be viewed by a user, authenticated
|
||||
or not.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.help.HelpListView.paginate_by">
|
||||
<code class="sig-name descname">paginate_by</code><em class="property"> = 500</em><a class="headerlink" href="#evennia.web.website.views.help.HelpListView.paginate_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.help.HelpListView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/help_list.html'</em><a class="headerlink" href="#evennia.web.website.views.help.HelpListView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.help.HelpListView.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Help Index'</em><a class="headerlink" href="#evennia.web.website.views.help.HelpListView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.help.HelpDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.help.</code><code class="sig-name descname">HelpDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/help.html#HelpDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.help.HelpDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.help.HelpMixin" title="evennia.web.website.views.help.HelpMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.help.HelpMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaDetailView" title="evennia.web.website.views.mixins.EvenniaDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaDetailView</span></code></a></p>
|
||||
<p>Returns the detail page for a given help entry.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.help.HelpDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/help_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.help.HelpDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.help.HelpDetailView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/help.html#HelpDetailView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.help.HelpDetailView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds navigational data to the template to let browsers go to the next
|
||||
or previous entry in the help list.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.help.HelpDetailView.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/help.html#HelpDetailView.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.help.HelpDetailView.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook that retrieves an object by category and topic
|
||||
instead of pk and slug.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>entry (HelpEntry)</em> – HelpEntry requested in the URL.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.views.help.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.views.help.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.help</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -40,793 +40,19 @@
|
|||
|
||||
<section id="module-evennia.web.website.views">
|
||||
<span id="evennia-web-website-views"></span><h1>evennia.web.website.views<a class="headerlink" href="#module-evennia.web.website.views" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This file contains the generic, assorted views that don’t fall under one of the other applications.
|
||||
Views are django’s way of processing e.g. html templates on the fly.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.web.website.views.to_be_implemented">
|
||||
<code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">to_be_implemented</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#to_be_implemented"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.to_be_implemented" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A notice letting the user know that this particular feature hasn’t been
|
||||
implemented yet.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.web.website.views.evennia_admin">
|
||||
<code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">evennia_admin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#evennia_admin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.evennia_admin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Helpful Evennia-specific admin page.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.web.website.views.admin_wrapper">
|
||||
<code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">admin_wrapper</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#admin_wrapper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.admin_wrapper" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Wrapper that allows us to properly use the base Django admin site, if needed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.EvenniaIndexView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">EvenniaIndexView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#EvenniaIndexView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.EvenniaIndexView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.base.TemplateView</span></code></p>
|
||||
<p>This is a basic example of a Django class-based view, which are functionally
|
||||
very similar to Evennia Commands but differ in structure. Commands are used
|
||||
to interface with users using a terminal client. Views are used to interface
|
||||
with users using a web browser.</p>
|
||||
<p>To use a class-based view, you need to have written a template in HTML, and
|
||||
then you write a view like this to tell Django what values to display on it.</p>
|
||||
<p>While there are simpler ways of writing views using plain functions (and
|
||||
Evennia currently contains a few examples of them), just like Commands,
|
||||
writing views as classes provides you with more flexibility– you can extend
|
||||
classes and change things to suit your needs rather than having to copy and
|
||||
paste entire code blocks over and over. Django also comes with many default
|
||||
views for displaying things, all of them implemented as classes.</p>
|
||||
<p>This particular example displays the index page.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.EvenniaIndexView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/index.html'</em><a class="headerlink" href="#evennia.web.website.views.EvenniaIndexView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.EvenniaIndexView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#EvenniaIndexView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.EvenniaIndexView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is a common Django method. Think of this as the website
|
||||
equivalent of the Evennia Command.func() method.</p>
|
||||
<p>If you just want to display a static page with no customization, you
|
||||
don’t need to define this method– just create a view, define
|
||||
template_name and you’re done.</p>
|
||||
<p>The only catch here is that if you extend or overwrite this method,
|
||||
you’ll always want to make sure you call the parent method to get a
|
||||
context object. It’s just a dict, but it comes prepopulated with all
|
||||
sorts of background data intended for display on the page.</p>
|
||||
<p>You can do whatever you want to it, but it must be returned at the end
|
||||
of this method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
<dd class="field-odd"><p><strong>any</strong> (<em>any</em>) – Passed through.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>context (dict)</em> – Dictionary of data you want to display on the page.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.TypeclassMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">TypeclassMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views.html#TypeclassMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.TypeclassMixin" 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 is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Django views typically work with classes called “models.” Evennia objects
|
||||
are an enhancement upon these Django models and are called “typeclasses.”
|
||||
But Django itself has no idea what a “typeclass” is.</p>
|
||||
<p>For the sake of mitigating confusion, any view class with this in its
|
||||
inheritance list will be modified to work with Evennia Typeclass objects or
|
||||
Django models interchangeably.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.TypeclassMixin.typeclass">
|
||||
<em class="property">property </em><code class="sig-name descname">typeclass</code><a class="headerlink" href="#evennia.web.website.views.TypeclassMixin.typeclass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.EvenniaCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">EvenniaCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#EvenniaCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.EvenniaCreateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.edit.CreateView</span></code>, <a class="reference internal" href="#evennia.web.website.views.TypeclassMixin" title="evennia.web.website.views.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.TypeclassMixin</span></code></a></p>
|
||||
<p>This view extends Django’s default CreateView.</p>
|
||||
<p>CreateView is used for creating new objects, be they Accounts, Characters or
|
||||
otherwise.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.EvenniaCreateView.page_title">
|
||||
<em class="property">property </em><code class="sig-name descname">page_title</code><a class="headerlink" href="#evennia.web.website.views.EvenniaCreateView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.EvenniaDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">EvenniaDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#EvenniaDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.EvenniaDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.detail.DetailView</span></code>, <a class="reference internal" href="#evennia.web.website.views.TypeclassMixin" title="evennia.web.website.views.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.TypeclassMixin</span></code></a></p>
|
||||
<p>This view extends Django’s default DetailView.</p>
|
||||
<p>DetailView is used for displaying objects, be they Accounts, Characters or
|
||||
otherwise.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.EvenniaDetailView.page_title">
|
||||
<em class="property">property </em><code class="sig-name descname">page_title</code><a class="headerlink" href="#evennia.web.website.views.EvenniaDetailView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.EvenniaUpdateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">EvenniaUpdateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#EvenniaUpdateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.EvenniaUpdateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.edit.UpdateView</span></code>, <a class="reference internal" href="#evennia.web.website.views.TypeclassMixin" title="evennia.web.website.views.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.TypeclassMixin</span></code></a></p>
|
||||
<p>This view extends Django’s default UpdateView.</p>
|
||||
<p>UpdateView is used for updating objects, be they Accounts, Characters or
|
||||
otherwise.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.EvenniaUpdateView.page_title">
|
||||
<em class="property">property </em><code class="sig-name descname">page_title</code><a class="headerlink" href="#evennia.web.website.views.EvenniaUpdateView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.EvenniaDeleteView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">EvenniaDeleteView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#EvenniaDeleteView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.EvenniaDeleteView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.edit.DeleteView</span></code>, <a class="reference internal" href="#evennia.web.website.views.TypeclassMixin" title="evennia.web.website.views.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.TypeclassMixin</span></code></a></p>
|
||||
<p>This view extends Django’s default DeleteView.</p>
|
||||
<p>DeleteView is used for deleting objects, be they Accounts, Characters or
|
||||
otherwise.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.EvenniaDeleteView.page_title">
|
||||
<em class="property">property </em><code class="sig-name descname">page_title</code><a class="headerlink" href="#evennia.web.website.views.EvenniaDeleteView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.ObjectDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">ObjectDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.EvenniaDetailView" title="evennia.web.website.views.EvenniaDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.EvenniaDetailView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with displaying, updating or deleting a
|
||||
specific object will want to inherit from this. It provides the mechanisms
|
||||
by which to retrieve the object and make sure the user requesting it has
|
||||
permissions to actually <em>do</em> things to it.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectDetailView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.ObjectDetailView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.ObjectDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectDetailView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.ObjectDetailView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectDetailView.attributes">
|
||||
<code class="sig-name descname">attributes</code><em class="property"> = ['name', 'desc']</em><a class="headerlink" href="#evennia.web.website.views.ObjectDetailView.attributes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ObjectDetailView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectDetailView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectDetailView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds an ‘attributes’ list to the request context consisting of the
|
||||
attributes specified at the class level, and in the order provided.</p>
|
||||
<p>Django views do not provide a way to reference dynamic attributes, so
|
||||
we have to grab them all before we render the template.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ObjectDetailView.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectDetailView.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectDetailView.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook that provides some important Evennia-specific
|
||||
functionality.</p>
|
||||
<p>Evennia does not natively store slugs, so where a slug is provided,
|
||||
calculate the same for the object and make sure it matches.</p>
|
||||
<p>This also checks to make sure the user has access to view/edit/delete
|
||||
this object!</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.ObjectCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">ObjectCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectCreateView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.EvenniaCreateView" title="evennia.web.website.views.EvenniaCreateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.EvenniaCreateView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with creating a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting creation of an object is authenticated, and provides a sane
|
||||
default title for the page.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectCreateView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.ObjectCreateView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.ObjectDeleteView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">ObjectDeleteView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectDeleteView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectDeleteView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.ObjectDetailView" title="evennia.web.website.views.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ObjectDetailView</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.EvenniaDeleteView" title="evennia.web.website.views.EvenniaDeleteView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.EvenniaDeleteView</span></code></a></p>
|
||||
<p>This is an important view for obvious reasons!</p>
|
||||
<p>Any view you write that deals with deleting a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting deletion of an object is authenticated, and that they have
|
||||
permissions to delete the requested object.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectDeleteView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.ObjectDeleteView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectDeleteView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_confirm_delete.html'</em><a class="headerlink" href="#evennia.web.website.views.ObjectDeleteView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectDeleteView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'delete'</em><a class="headerlink" href="#evennia.web.website.views.ObjectDeleteView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ObjectDeleteView.delete">
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectDeleteView.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectDeleteView.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Calls the delete() method on the fetched object and then
|
||||
redirects to the success URL.</p>
|
||||
<p>We extend this so we can capture the name for the sake of confirmation.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.ObjectUpdateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">ObjectUpdateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectUpdateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectUpdateView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.ObjectDetailView" title="evennia.web.website.views.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ObjectDetailView</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.EvenniaUpdateView" title="evennia.web.website.views.EvenniaUpdateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.EvenniaUpdateView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with updating a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting editing of an object is authenticated, and that they have
|
||||
permissions to edit the requested object.</p>
|
||||
<p>This functions slightly different from default Django UpdateViews in that
|
||||
it does not update core model fields, <em>only</em> object attributes!</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectUpdateView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.ObjectUpdateView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ObjectUpdateView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'edit'</em><a class="headerlink" href="#evennia.web.website.views.ObjectUpdateView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ObjectUpdateView.get_success_url">
|
||||
<code class="sig-name descname">get_success_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectUpdateView.get_success_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectUpdateView.get_success_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook.</p>
|
||||
<p>Can be overridden to return any URL you want to redirect the user to
|
||||
after the object is successfully updated, but by default it goes to the
|
||||
object detail page so the user can see their changes reflected.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ObjectUpdateView.get_initial">
|
||||
<code class="sig-name descname">get_initial</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectUpdateView.get_initial"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectUpdateView.get_initial" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook, modified for Evennia.</p>
|
||||
<p>Prepopulates the update form field values based on object db attributes.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><p><em>data (dict)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>Dictionary of key:value pairs containing initial form</dt><dd><p>data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ObjectUpdateView.form_valid">
|
||||
<code class="sig-name descname">form_valid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">form</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ObjectUpdateView.form_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ObjectUpdateView.form_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook.</p>
|
||||
<p>Updates object attributes based on values submitted.</p>
|
||||
<p>This is run when the form is submitted and the data on it is deemed
|
||||
valid– all values are within expected ranges, all strings contain
|
||||
valid characters and lengths, etc.</p>
|
||||
<p>This method is only called if all values for the fields submitted
|
||||
passed form validation, so at this point we can assume the data is
|
||||
validated and sanitized.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.AccountMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">AccountMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views.html#AccountMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.AccountMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.TypeclassMixin" title="evennia.web.website.views.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.TypeclassMixin</span></code></a></p>
|
||||
<p>This is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Any view class with this in its inheritance list will be modified to work
|
||||
with Account objects instead of generic Objects or otherwise.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.AccountMixin.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.AccountMixin.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount" title="evennia.accounts.accounts.DefaultAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.accounts.DefaultAccount</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.AccountMixin.form_class">
|
||||
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.AccountMixin.form_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.AccountForm" title="evennia.web.website.forms.AccountForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.AccountForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.AccountCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">AccountCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#AccountCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.AccountCreateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.AccountMixin" title="evennia.web.website.views.AccountMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.AccountMixin</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.EvenniaCreateView" title="evennia.web.website.views.EvenniaCreateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.EvenniaCreateView</span></code></a></p>
|
||||
<p>Account creation view.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.AccountCreateView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/registration/register.html'</em><a class="headerlink" href="#evennia.web.website.views.AccountCreateView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.AccountCreateView.success_url">
|
||||
<code class="sig-name descname">success_url</code><a class="headerlink" href="#evennia.web.website.views.AccountCreateView.success_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.AccountCreateView.form_valid">
|
||||
<code class="sig-name descname">form_valid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">form</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#AccountCreateView.form_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.AccountCreateView.form_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook, modified for Evennia.</p>
|
||||
<p>This hook is called after a valid form is submitted.</p>
|
||||
<p>When an account creation form is submitted and the data is deemed valid,
|
||||
proceeds with creating the Account object.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.CharacterMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">CharacterMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.TypeclassMixin" title="evennia.web.website.views.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.TypeclassMixin</span></code></a></p>
|
||||
<p>This is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Any view class with this in its inheritance list will be modified to work
|
||||
with Character objects instead of generic Objects or otherwise.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterMixin.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.CharacterMixin.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterMixin.form_class">
|
||||
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.CharacterMixin.form_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.CharacterForm" title="evennia.web.website.forms.CharacterForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.CharacterForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterMixin.success_url">
|
||||
<code class="sig-name descname">success_url</code><a class="headerlink" href="#evennia.web.website.views.CharacterMixin.success_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.CharacterMixin.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterMixin.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterMixin.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will override the Django get_queryset method to only
|
||||
return a list of characters associated with the current authenticated
|
||||
user.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.CharacterListView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">CharacterListView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterListView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterListView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.CharacterMixin" title="evennia.web.website.views.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
|
||||
<p>This view provides a mechanism by which a logged-in player can view a list
|
||||
of all other characters.</p>
|
||||
<p>This view requires authentication by default as a nominal effort to prevent
|
||||
human stalkers and automated bots/scrapers from harvesting data on your users.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterListView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_list.html'</em><a class="headerlink" href="#evennia.web.website.views.CharacterListView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterListView.paginate_by">
|
||||
<code class="sig-name descname">paginate_by</code><em class="property"> = 100</em><a class="headerlink" href="#evennia.web.website.views.CharacterListView.paginate_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterListView.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Character List'</em><a class="headerlink" href="#evennia.web.website.views.CharacterListView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterListView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.CharacterListView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.CharacterListView.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterListView.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterListView.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will override the Django get_queryset method to return a
|
||||
list of all characters (filtered/sorted) instead of just those limited
|
||||
to the account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.CharacterPuppetView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">CharacterPuppetView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterPuppetView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterPuppetView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.CharacterMixin" title="evennia.web.website.views.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.base.RedirectView</span></code>, <a class="reference internal" href="#evennia.web.website.views.ObjectDetailView" title="evennia.web.website.views.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ObjectDetailView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a logged-in player can “puppet” one
|
||||
of their characters within the context of the website.</p>
|
||||
<p>It also ensures that any user attempting to puppet something is logged in,
|
||||
and that their intended puppet is one that they own.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.CharacterPuppetView.get_redirect_url">
|
||||
<code class="sig-name descname">get_redirect_url</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterPuppetView.get_redirect_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterPuppetView.get_redirect_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook.</p>
|
||||
<p>This view returns the URL to which the user should be redirected after
|
||||
a passed or failed puppet attempt.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>url (str)</em> – Path to post-puppet destination.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.CharacterManageView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">CharacterManageView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterManageView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterManageView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.CharacterMixin" title="evennia.web.website.views.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
|
||||
<p>This view provides a mechanism by which a logged-in player can browse,
|
||||
edit, or delete their own characters.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterManageView.paginate_by">
|
||||
<code class="sig-name descname">paginate_by</code><em class="property"> = 10</em><a class="headerlink" href="#evennia.web.website.views.CharacterManageView.paginate_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterManageView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_manage_list.html'</em><a class="headerlink" href="#evennia.web.website.views.CharacterManageView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterManageView.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Manage Characters'</em><a class="headerlink" href="#evennia.web.website.views.CharacterManageView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.CharacterUpdateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">CharacterUpdateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterUpdateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterUpdateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.CharacterMixin" title="evennia.web.website.views.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.CharacterMixin</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.ObjectUpdateView" title="evennia.web.website.views.ObjectUpdateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ObjectUpdateView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a logged-in player (enforced by
|
||||
ObjectUpdateView) can edit the attributes of a character they own.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterUpdateView.form_class">
|
||||
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.CharacterUpdateView.form_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.CharacterUpdateForm" title="evennia.web.website.forms.CharacterUpdateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.CharacterUpdateForm</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterUpdateView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_form.html'</em><a class="headerlink" href="#evennia.web.website.views.CharacterUpdateView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.CharacterDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">CharacterDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.CharacterMixin" title="evennia.web.website.views.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.CharacterMixin</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.ObjectDetailView" title="evennia.web.website.views.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ObjectDetailView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a user can view the attributes of
|
||||
a character, owned by them or not.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.CharacterDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterDetailView.attributes">
|
||||
<code class="sig-name descname">attributes</code><em class="property"> = ['name', 'desc']</em><a class="headerlink" href="#evennia.web.website.views.CharacterDetailView.attributes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterDetailView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.CharacterDetailView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.CharacterDetailView.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterDetailView.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterDetailView.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will override the Django get_queryset method to return a
|
||||
list of all characters the user may access.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.CharacterDeleteView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">CharacterDeleteView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterDeleteView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterDeleteView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.CharacterMixin" title="evennia.web.website.views.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.CharacterMixin</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.ObjectDeleteView" title="evennia.web.website.views.ObjectDeleteView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ObjectDeleteView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a logged-in player (enforced by
|
||||
ObjectDeleteView) can delete a character they own.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.CharacterCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">CharacterCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterCreateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.CharacterMixin" title="evennia.web.website.views.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.CharacterMixin</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.ObjectCreateView" title="evennia.web.website.views.ObjectCreateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ObjectCreateView</span></code></a></p>
|
||||
<p>This view provides a mechanism by which a logged-in player (enforced by
|
||||
ObjectCreateView) can create a new character.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.CharacterCreateView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_form.html'</em><a class="headerlink" href="#evennia.web.website.views.CharacterCreateView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.CharacterCreateView.form_valid">
|
||||
<code class="sig-name descname">form_valid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">form</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#CharacterCreateView.form_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.CharacterCreateView.form_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook, modified for Evennia.</p>
|
||||
<p>This hook is called after a valid form is submitted.</p>
|
||||
<p>When an character creation form is submitted and the data is deemed valid,
|
||||
proceeds with creating the Character object.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.ChannelMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">ChannelMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views.html#ChannelMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ChannelMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.TypeclassMixin" title="evennia.web.website.views.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.TypeclassMixin</span></code></a></p>
|
||||
<p>This is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Any view class with this in its inheritance list will be modified to work
|
||||
with HelpEntry objects instead of generic Objects or otherwise.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelMixin.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.ChannelMixin.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.comms.comms.html#evennia.comms.comms.DefaultChannel" title="evennia.comms.comms.DefaultChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.comms.comms.DefaultChannel</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelMixin.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Channels'</em><a class="headerlink" href="#evennia.web.website.views.ChannelMixin.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelMixin.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'listen'</em><a class="headerlink" href="#evennia.web.website.views.ChannelMixin.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ChannelMixin.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ChannelMixin.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ChannelMixin.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook; here we want to return a list of only those Channels
|
||||
and other documentation that the current user is allowed to see.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – List of Channels available to the user.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.ChannelListView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">ChannelListView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ChannelListView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ChannelListView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.ChannelMixin" title="evennia.web.website.views.ChannelMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ChannelMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
|
||||
<p>Returns a list of channels that can be viewed by a user, authenticated
|
||||
or not.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelListView.paginate_by">
|
||||
<code class="sig-name descname">paginate_by</code><em class="property"> = 100</em><a class="headerlink" href="#evennia.web.website.views.ChannelListView.paginate_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelListView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/channel_list.html'</em><a class="headerlink" href="#evennia.web.website.views.ChannelListView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelListView.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Channel Index'</em><a class="headerlink" href="#evennia.web.website.views.ChannelListView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelListView.max_popular">
|
||||
<code class="sig-name descname">max_popular</code><em class="property"> = 10</em><a class="headerlink" href="#evennia.web.website.views.ChannelListView.max_popular" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ChannelListView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ChannelListView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ChannelListView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook; we override it to calculate the most popular channels.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.ChannelDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">ChannelDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ChannelDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ChannelDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.ChannelMixin" title="evennia.web.website.views.ChannelMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ChannelMixin</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.ObjectDetailView" title="evennia.web.website.views.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.ObjectDetailView</span></code></a></p>
|
||||
<p>Returns the log entries for a given channel.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/channel_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.ChannelDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelDetailView.attributes">
|
||||
<code class="sig-name descname">attributes</code><em class="property"> = ['name']</em><a class="headerlink" href="#evennia.web.website.views.ChannelDetailView.attributes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.ChannelDetailView.max_num_lines">
|
||||
<code class="sig-name descname">max_num_lines</code><em class="property"> = 10000</em><a class="headerlink" href="#evennia.web.website.views.ChannelDetailView.max_num_lines" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ChannelDetailView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ChannelDetailView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ChannelDetailView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook; before we can display the channel logs, we need to recall
|
||||
the logfile and read its lines.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.ChannelDetailView.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#ChannelDetailView.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.ChannelDetailView.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook that retrieves an object by slugified channel
|
||||
name.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>channel (Channel)</em> – Channel requested in the URL.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.HelpMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">HelpMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views.html#HelpMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.HelpMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.TypeclassMixin" title="evennia.web.website.views.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.TypeclassMixin</span></code></a></p>
|
||||
<p>This is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Any view class with this in its inheritance list will be modified to work
|
||||
with HelpEntry objects instead of generic Objects or otherwise.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.HelpMixin.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.HelpMixin.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.help.models.html#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>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.HelpMixin.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Help'</em><a class="headerlink" href="#evennia.web.website.views.HelpMixin.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.HelpMixin.get_queryset">
|
||||
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#HelpMixin.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.HelpMixin.get_queryset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook; here we want to return a list of only those HelpEntries
|
||||
and other documentation that the current user is allowed to see.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – List of Help entries available to the user.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.HelpListView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">HelpListView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#HelpListView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.HelpListView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.HelpMixin" title="evennia.web.website.views.HelpMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.HelpMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
|
||||
<p>Returns a list of help entries that can be viewed by a user, authenticated
|
||||
or not.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.HelpListView.paginate_by">
|
||||
<code class="sig-name descname">paginate_by</code><em class="property"> = 500</em><a class="headerlink" href="#evennia.web.website.views.HelpListView.paginate_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.HelpListView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/help_list.html'</em><a class="headerlink" href="#evennia.web.website.views.HelpListView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.HelpListView.page_title">
|
||||
<code class="sig-name descname">page_title</code><em class="property"> = 'Help Index'</em><a class="headerlink" href="#evennia.web.website.views.HelpListView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.HelpDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.</code><code class="sig-name descname">HelpDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#HelpDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.HelpDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.HelpMixin" title="evennia.web.website.views.HelpMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.HelpMixin</span></code></a>, <a class="reference internal" href="#evennia.web.website.views.EvenniaDetailView" title="evennia.web.website.views.EvenniaDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.EvenniaDetailView</span></code></a></p>
|
||||
<p>Returns the detail page for a given help entry.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.HelpDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/help_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.HelpDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.HelpDetailView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#HelpDetailView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.HelpDetailView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds navigational data to the template to let browsers go to the next
|
||||
or previous entry in the help list.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.HelpDetailView.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views.html#HelpDetailView.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.HelpDetailView.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook that retrieves an object by category and topic
|
||||
instead of pk and slug.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>entry (HelpEntry)</em> – HelpEntry requested in the URL.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<p>Website views.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.accounts.html">evennia.web.website.views.accounts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.channels.html">evennia.web.website.views.channels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.characters.html">evennia.web.website.views.characters</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.errors.html">evennia.web.website.views.errors</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.help.html">evennia.web.website.views.help</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.index.html">evennia.web.website.views.index</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.mixins.html">evennia.web.website.views.mixins</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.views.objects.html">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
160
docs/1.0-dev/api/evennia.web.website.views.index.html
Normal file
160
docs/1.0-dev/api/evennia.web.website.views.index.html
Normal file
|
|
@ -0,0 +1,160 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.views.index — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.index</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.views.index">
|
||||
<span id="evennia-web-website-views-index"></span><h1>evennia.web.website.views.index<a class="headerlink" href="#module-evennia.web.website.views.index" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The main index page, including the game stats</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.index.EvenniaIndexView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.index.</code><code class="sig-name descname">EvenniaIndexView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/index.html#EvenniaIndexView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.index.EvenniaIndexView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.base.TemplateView</span></code></p>
|
||||
<p>This is a basic example of a Django class-based view, which are functionally
|
||||
very similar to Evennia Commands but differ in structure. Commands are used
|
||||
to interface with users using a terminal client. Views are used to interface
|
||||
with users using a web browser.</p>
|
||||
<p>To use a class-based view, you need to have written a template in HTML, and
|
||||
then you write a view like this to tell Django what values to display on it.</p>
|
||||
<p>While there are simpler ways of writing views using plain functions (and
|
||||
Evennia currently contains a few examples of them), just like Commands,
|
||||
writing views as classes provides you with more flexibility– you can extend
|
||||
classes and change things to suit your needs rather than having to copy and
|
||||
paste entire code blocks over and over. Django also comes with many default
|
||||
views for displaying things, all of them implemented as classes.</p>
|
||||
<p>This particular example displays the index page.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.index.EvenniaIndexView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/index.html'</em><a class="headerlink" href="#evennia.web.website.views.index.EvenniaIndexView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.index.EvenniaIndexView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/index.html#EvenniaIndexView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.index.EvenniaIndexView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is a common Django method. Think of this as the website
|
||||
equivalent of the Evennia Command.func() method.</p>
|
||||
<p>If you just want to display a static page with no customization, you
|
||||
don’t need to define this method– just create a view, define
|
||||
template_name and you’re done.</p>
|
||||
<p>The only catch here is that if you extend or overwrite this method,
|
||||
you’ll always want to make sure you call the parent method to get a
|
||||
context object. It’s just a dict, but it comes prepopulated with all
|
||||
sorts of background data intended for display on the page.</p>
|
||||
<p>You can do whatever you want to it, but it must be returned at the end
|
||||
of this method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
<dd class="field-odd"><p><strong>any</strong> (<em>any</em>) – Passed through.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>context (dict)</em> – Dictionary of data you want to display on the page.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.views.index.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.views.index.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.index</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
186
docs/1.0-dev/api/evennia.web.website.views.mixins.html
Normal file
186
docs/1.0-dev/api/evennia.web.website.views.mixins.html
Normal file
|
|
@ -0,0 +1,186 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.views.mixins — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.mixins</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.views.mixins">
|
||||
<span id="evennia-web-website-views-mixins"></span><h1>evennia.web.website.views.mixins<a class="headerlink" href="#module-evennia.web.website.views.mixins" title="Permalink to this headline">¶</a></h1>
|
||||
<p>These are mixins for class-based views, granting functionality.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.mixins.TypeclassMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.mixins.</code><code class="sig-name descname">TypeclassMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views/mixins.html#TypeclassMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.mixins.TypeclassMixin" 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 is a “mixin”, a modifier of sorts.</p>
|
||||
<p>Django views typically work with classes called “models.” Evennia objects
|
||||
are an enhancement upon these Django models and are called “typeclasses.”
|
||||
But Django itself has no idea what a “typeclass” is.</p>
|
||||
<p>For the sake of mitigating confusion, any view class with this in its
|
||||
inheritance list will be modified to work with Evennia Typeclass objects or
|
||||
Django models interchangeably.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.mixins.TypeclassMixin.typeclass">
|
||||
<em class="property">property </em><code class="sig-name descname">typeclass</code><a class="headerlink" href="#evennia.web.website.views.mixins.TypeclassMixin.typeclass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.mixins.EvenniaCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.mixins.</code><code class="sig-name descname">EvenniaCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/mixins.html#EvenniaCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.mixins.EvenniaCreateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.edit.CreateView</span></code>, <a class="reference internal" href="#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
|
||||
<p>This view extends Django’s default CreateView.</p>
|
||||
<p>CreateView is used for creating new objects, be they Accounts, Characters or
|
||||
otherwise.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.mixins.EvenniaCreateView.page_title">
|
||||
<em class="property">property </em><code class="sig-name descname">page_title</code><a class="headerlink" href="#evennia.web.website.views.mixins.EvenniaCreateView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.mixins.EvenniaDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.mixins.</code><code class="sig-name descname">EvenniaDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/mixins.html#EvenniaDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.mixins.EvenniaDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.detail.DetailView</span></code>, <a class="reference internal" href="#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
|
||||
<p>This view extends Django’s default DetailView.</p>
|
||||
<p>DetailView is used for displaying objects, be they Accounts, Characters or
|
||||
otherwise.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.mixins.EvenniaDetailView.page_title">
|
||||
<em class="property">property </em><code class="sig-name descname">page_title</code><a class="headerlink" href="#evennia.web.website.views.mixins.EvenniaDetailView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.mixins.EvenniaUpdateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.mixins.</code><code class="sig-name descname">EvenniaUpdateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/mixins.html#EvenniaUpdateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.mixins.EvenniaUpdateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.edit.UpdateView</span></code>, <a class="reference internal" href="#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
|
||||
<p>This view extends Django’s default UpdateView.</p>
|
||||
<p>UpdateView is used for updating objects, be they Accounts, Characters or
|
||||
otherwise.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.mixins.EvenniaUpdateView.page_title">
|
||||
<em class="property">property </em><code class="sig-name descname">page_title</code><a class="headerlink" href="#evennia.web.website.views.mixins.EvenniaUpdateView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.mixins.EvenniaDeleteView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.mixins.</code><code class="sig-name descname">EvenniaDeleteView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/mixins.html#EvenniaDeleteView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.mixins.EvenniaDeleteView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.edit.DeleteView</span></code>, <a class="reference internal" href="#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
|
||||
<p>This view extends Django’s default DeleteView.</p>
|
||||
<p>DeleteView is used for deleting objects, be they Accounts, Characters or
|
||||
otherwise.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.mixins.EvenniaDeleteView.page_title">
|
||||
<em class="property">property </em><code class="sig-name descname">page_title</code><a class="headerlink" href="#evennia.web.website.views.mixins.EvenniaDeleteView.page_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.views.mixins.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.views.mixins.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.mixins</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
284
docs/1.0-dev/api/evennia.web.website.views.objects.html
Normal file
284
docs/1.0-dev/api/evennia.web.website.views.objects.html
Normal file
|
|
@ -0,0 +1,284 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.web.website.views.objects — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.web.website.views.objects">
|
||||
<span id="evennia-web-website-views-objects"></span><h1>evennia.web.website.views.objects<a class="headerlink" href="#module-evennia.web.website.views.objects" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Views for managing a specific object)</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.objects.</code><code class="sig-name descname">ObjectDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaDetailView" title="evennia.web.website.views.mixins.EvenniaDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaDetailView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with displaying, updating or deleting a
|
||||
specific object will want to inherit from this. It provides the mechanisms
|
||||
by which to retrieve the object and make sure the user requesting it has
|
||||
permissions to actually <em>do</em> things to it.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.attributes">
|
||||
<code class="sig-name descname">attributes</code><em class="property"> = ['name', 'desc']</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.attributes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDetailView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds an ‘attributes’ list to the request context consisting of the
|
||||
attributes specified at the class level, and in the order provided.</p>
|
||||
<p>Django views do not provide a way to reference dynamic attributes, so
|
||||
we have to grab them all before we render the template.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDetailView.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook that provides some important Evennia-specific
|
||||
functionality.</p>
|
||||
<p>Evennia does not natively store slugs, so where a slug is provided,
|
||||
calculate the same for the object and make sure it matches.</p>
|
||||
<p>This also checks to make sure the user has access to view/edit/delete
|
||||
this object!</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.objects.ObjectCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.objects.</code><code class="sig-name descname">ObjectCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectCreateView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaCreateView" title="evennia.web.website.views.mixins.EvenniaCreateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaCreateView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with creating a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting creation of an object is authenticated, and provides a sane
|
||||
default title for the page.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectCreateView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.objects.ObjectCreateView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.objects.</code><code class="sig-name descname">ObjectDeleteView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDeleteView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a>, <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaDeleteView" title="evennia.web.website.views.mixins.EvenniaDeleteView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaDeleteView</span></code></a></p>
|
||||
<p>This is an important view for obvious reasons!</p>
|
||||
<p>Any view you write that deals with deleting a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting deletion of an object is authenticated, and that they have
|
||||
permissions to delete the requested object.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_confirm_delete.html'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'delete'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView.delete">
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDeleteView.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Calls the delete() method on the fetched object and then
|
||||
redirects to the success URL.</p>
|
||||
<p>We extend this so we can capture the name for the sake of confirmation.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.objects.</code><code class="sig-name descname">ObjectUpdateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectUpdateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView" 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.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a>, <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaUpdateView" title="evennia.web.website.views.mixins.EvenniaUpdateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaUpdateView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with updating a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting editing of an object is authenticated, and that they have
|
||||
permissions to edit the requested object.</p>
|
||||
<p>This functions slightly different from default Django UpdateViews in that
|
||||
it does not update core model fields, <em>only</em> object attributes!</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'edit'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.get_success_url">
|
||||
<code class="sig-name descname">get_success_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectUpdateView.get_success_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.get_success_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook.</p>
|
||||
<p>Can be overridden to return any URL you want to redirect the user to
|
||||
after the object is successfully updated, but by default it goes to the
|
||||
object detail page so the user can see their changes reflected.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.get_initial">
|
||||
<code class="sig-name descname">get_initial</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectUpdateView.get_initial"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.get_initial" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook, modified for Evennia.</p>
|
||||
<p>Prepopulates the update form field values based on object db attributes.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><p><em>data (dict)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>Dictionary of key:value pairs containing initial form</dt><dd><p>data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.form_valid">
|
||||
<code class="sig-name descname">form_valid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">form</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectUpdateView.form_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.form_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook.</p>
|
||||
<p>Updates object attributes based on values submitted.</p>
|
||||
<p>This is run when the form is submitted and the data on it is deemed
|
||||
valid– all values are within expected ranges, all strings contain
|
||||
valid characters and lengths, etc.</p>
|
||||
<p>This method is only called if all values for the fields submitted
|
||||
passed form validation, so at this point we can assume the data is
|
||||
validated and sanitized.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.web.website.views.objects.rst.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||||
</li>
|
||||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.web.website.views.objects.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue