Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-18 13:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.web.admin.objects.html

461 lines
34 KiB
HTML
Raw Normal View History

Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<!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 &#8212; Evennia latest 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" />
<link rel="next" title="evennia.web.admin.scripts" href="evennia.web.admin.scripts.html" />
<link rel="prev" title="evennia.web.admin.help" href="evennia.web.admin.help.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="right" >
<a href="evennia.web.admin.scripts.html" title="evennia.web.admin.scripts"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.web.admin.help.html" title="evennia.web.admin.help"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.web.html" >evennia.web</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.web.admin.html" accesskey="U">evennia.web.admin</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.objects</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<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>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.web.admin.help.html"
title="previous chapter">evennia.web.admin.help</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.web.admin.scripts.html"
title="next chapter">evennia.web.admin.scripts</a></p>
<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.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
Updated HTML docs.
2023-12-20 18:20:20 +00:00
<h3>Doc Versions</h3>
<ul>
<li><a href="evennia.web.admin.objects.html">latest (main branch)</a></li>
Updated HTML docs.
2023-12-20 19:10:36 +00:00
Updated HTML docs.
2023-12-20 22:47:51 +00:00
<li><a href="../../3.x/index.html">v3.0.0 branch (outdated)</a></li>
Updated HTML docs.
2023-12-20 22:23:04 +00:00
Updated HTML docs.
2023-12-20 22:47:51 +00:00
<li><a href="../../2.x/index.html">v2.0.0 branch (outdated)</a></li>
Updated HTML docs.
2023-12-20 18:20:20 +00:00
Updated HTML docs.
2023-12-20 22:47:51 +00:00
<li><a href="../../1.x/index.html">v1.0.0 branch (outdated)</a></li>
Updated HTML docs.
2023-12-20 18:20:20 +00:00
Updated HTML docs.
2023-12-20 22:47:51 +00:00
<li><a href="../../0.x/index.html">v0.9.5 branch (outdated)</a></li>
Updated HTML docs.
2023-12-20 18:20:20 +00:00
</ul>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
</div>
</div>
<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': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_attributes': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_cmdset_storage': &lt;django.forms.fields.CharField object&gt;, 'db_destination': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_home': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_location': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_sessid': &lt;django.forms.fields.CharField object&gt;, 'db_tags': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.ChoiceField object&gt;}</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': &lt;django.forms.fields.CharField object&gt;, 'db_destination': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_home': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_location': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.ChoiceField object&gt;}</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': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_attributes': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_cmdset_storage': &lt;django.forms.fields.CharField object&gt;, 'db_destination': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_home': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_location': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_sessid': &lt;django.forms.fields.CharField object&gt;, 'db_tags': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.ChoiceField object&gt;}</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': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_cmdset_storage': &lt;django.forms.fields.CharField object&gt;, 'db_destination': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_home': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_location': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.ChoiceField object&gt;}</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"> = [&lt;class 'evennia.web.admin.objects.ObjectTagInline'&gt;, &lt;class 'evennia.web.admin.objects.ObjectAttributeInline'&gt;]</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.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.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>
<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>
</dd></dl>
</section>
</div>
</div>
</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="right" >
<a href="evennia.web.admin.scripts.html" title="evennia.web.admin.scripts"
>next</a> |</li>
<li class="right" >
<a href="evennia.web.admin.help.html" title="evennia.web.admin.help"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.web.html" >evennia.web</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.web.admin.html" >evennia.web.admin</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.objects</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink