Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-28 10:37:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.web.admin.scripts.html

393 lines
35 KiB
HTML
Raw Normal View History

Updated HTML docs.
2025-08-15 18:14:21 +00:00
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>evennia.web.admin.scripts &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="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.server" href="evennia.web.admin.server.html" />
<link rel="prev" title="evennia.web.admin.objects" href="evennia.web.admin.objects.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<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.server.html" title="evennia.web.admin.server"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.web.admin.objects.html" title="evennia.web.admin.objects"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</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.scripts</a></li>
</ul>
</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="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptForm">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.admin.scripts.</span></span><span class="sig-name descname"><span class="pre">ScriptForm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_id='id_%s'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_class=&lt;class</span> <span class="pre">'django.forms.utils.ErrorList'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label_suffix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty_permitted=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_required_attribute=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renderer=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptForm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptForm" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelForm</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptForm.base_fields">
<span class="sig-name descname"><span class="pre">base_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'db_interval':</span> <span class="pre">&lt;django.forms.fields.IntegerField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_key':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_lock_storage':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_persistent':</span> <span class="pre">&lt;django.forms.fields.BooleanField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_repeats':</span> <span class="pre">&lt;django.forms.fields.IntegerField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_start_delay':</span> <span class="pre">&lt;django.forms.fields.BooleanField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_typeclass_path':</span> <span class="pre">&lt;django.forms.fields.ChoiceField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptForm.base_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptForm.declared_fields">
<span class="sig-name descname"><span class="pre">declared_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'db_interval':</span> <span class="pre">&lt;django.forms.fields.IntegerField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_key':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_lock_storage':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_persistent':</span> <span class="pre">&lt;django.forms.fields.BooleanField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_repeats':</span> <span class="pre">&lt;django.forms.fields.IntegerField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_start_delay':</span> <span class="pre">&lt;django.forms.fields.BooleanField</span> <span class="pre">object&gt;,</span> <span class="pre">'db_typeclass_path':</span> <span class="pre">&lt;django.forms.fields.ChoiceField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptForm.declared_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptForm.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.admin.scripts.ScriptForm.media" title="Link 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 class="sig sig-object py" id="evennia.web.admin.scripts.ScriptTagInline">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.admin.scripts.</span></span><span class="sig-name descname"><span class="pre">ScriptTagInline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent_model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">admin_site</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptTagInline"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline" title="Link 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">TagInline</span></code></a></p>
<p>Inline script tags.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptTagInline.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline.model" title="Link to this definition"></a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptDB_db_tags</span></code></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptTagInline.related_field">
<span class="sig-name descname"><span class="pre">related_field</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'scriptdb'</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline.related_field" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptTagInline.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.admin.scripts.ScriptTagInline.media" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAttributeInline">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.admin.scripts.</span></span><span class="sig-name descname"><span class="pre">ScriptAttributeInline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent_model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">admin_site</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptAttributeInline"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline" title="Link 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">AttributeInline</span></code></a></p>
<p>Inline attribute tags.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAttributeInline.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline.model" title="Link to this definition"></a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptDB_db_attributes</span></code></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAttributeInline.related_field">
<span class="sig-name descname"><span class="pre">related_field</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'scriptdb'</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline.related_field" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAttributeInline.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAttributeInline.media" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.admin.scripts.</span></span><span class="sig-name descname"><span class="pre">ScriptAdmin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">admin_site</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/scripts.html#ScriptAdmin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelAdmin</span></code></p>
<p>Displaying the main Script page.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.list_display">
<span class="sig-name descname"><span class="pre">list_display</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('id',</span> <span class="pre">'db_key',</span> <span class="pre">'db_typeclass_path',</span> <span class="pre">'db_obj',</span> <span class="pre">'db_interval',</span> <span class="pre">'db_repeats',</span> <span class="pre">'db_persistent',</span> <span class="pre">'db_date_created')</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.list_display" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.list_display_links">
<span class="sig-name descname"><span class="pre">list_display_links</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('id',</span> <span class="pre">'db_key')</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.list_display_links" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.ordering">
<span class="sig-name descname"><span class="pre">ordering</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['-db_date_created',</span> <span class="pre">'-id']</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.ordering" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.search_fields">
<span class="sig-name descname"><span class="pre">search_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['=id',</span> <span class="pre">'^db_key',</span> <span class="pre">'db_typeclass_path']</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.search_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.readonly_fields">
<span class="sig-name descname"><span class="pre">readonly_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['serialized_string']</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.readonly_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.form">
<span class="sig-name descname"><span class="pre">form</span></span><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.form" title="Link 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 class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.save_as">
<span class="sig-name descname"><span class="pre">save_as</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.save_as" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.save_on_top">
<span class="sig-name descname"><span class="pre">save_on_top</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.save_on_top" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.list_select_related">
<span class="sig-name descname"><span class="pre">list_select_related</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.list_select_related" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.view_on_site">
<span class="sig-name descname"><span class="pre">view_on_site</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.view_on_site" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.raw_id_fields">
<span class="sig-name descname"><span class="pre">raw_id_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('db_obj',)</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.raw_id_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.fieldsets">
<span class="sig-name descname"><span class="pre">fieldsets</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">((None,</span> <span class="pre">{'fields':</span> <span class="pre">(('db_key',</span> <span class="pre">'db_typeclass_path'),</span> <span class="pre">('db_interval',</span> <span class="pre">'db_repeats',</span> <span class="pre">'db_start_delay',</span> <span class="pre">'db_persistent'),</span> <span class="pre">'db_obj',</span> <span class="pre">'db_lock_storage',</span> <span class="pre">'serialized_string')}),)</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.fieldsets" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.inlines">
<span class="sig-name descname"><span class="pre">inlines</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[&lt;class</span> <span class="pre">'evennia.web.admin.scripts.ScriptTagInline'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'evennia.web.admin.scripts.ScriptAttributeInline'&gt;]</span></em><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.inlines" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.serialized_string">
<span class="sig-name descname"><span class="pre">serialized_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.serialized_string" title="Link to this definition"></a></dt>
<dd><p>Get the serialized version of the object.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.get_form">
<span class="sig-name descname"><span class="pre">get_form</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.get_form" title="Link to this definition"></a></dt>
<dd><p>Overrides help texts.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.save_model">
<span class="sig-name descname"><span class="pre">save_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">form</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">change</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.save_model" title="Link to this definition"></a></dt>
<dd><p>Model-save hook.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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 property">
<dt class="sig sig-object py" id="evennia.web.admin.scripts.ScriptAdmin.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.admin.scripts.ScriptAdmin.media" title="Link 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">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.web.admin.scripts</a><ul>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptForm"><code class="docutils literal notranslate"><span class="pre">ScriptForm</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptForm.base_fields"><code class="docutils literal notranslate"><span class="pre">ScriptForm.base_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptForm.declared_fields"><code class="docutils literal notranslate"><span class="pre">ScriptForm.declared_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptForm.media"><code class="docutils literal notranslate"><span class="pre">ScriptForm.media</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptTagInline"><code class="docutils literal notranslate"><span class="pre">ScriptTagInline</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptTagInline.model"><code class="docutils literal notranslate"><span class="pre">ScriptTagInline.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptTagInline.related_field"><code class="docutils literal notranslate"><span class="pre">ScriptTagInline.related_field</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptTagInline.media"><code class="docutils literal notranslate"><span class="pre">ScriptTagInline.media</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAttributeInline"><code class="docutils literal notranslate"><span class="pre">ScriptAttributeInline</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAttributeInline.model"><code class="docutils literal notranslate"><span class="pre">ScriptAttributeInline.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAttributeInline.related_field"><code class="docutils literal notranslate"><span class="pre">ScriptAttributeInline.related_field</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAttributeInline.media"><code class="docutils literal notranslate"><span class="pre">ScriptAttributeInline.media</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.list_display"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.list_display</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.list_display_links"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.list_display_links</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.ordering"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.ordering</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.search_fields"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.search_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.readonly_fields"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.readonly_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.form"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.form</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.save_as"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.save_as</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.save_on_top"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.save_on_top</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.list_select_related"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.list_select_related</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.view_on_site"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.view_on_site</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.raw_id_fields"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.raw_id_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.fieldsets"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.fieldsets</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.inlines"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.inlines</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.serialized_string"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.serialized_string()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.get_form"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.get_form()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.save_model"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.save_model()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.admin.scripts.ScriptAdmin.media"><code class="docutils literal notranslate"><span class="pre">ScriptAdmin.media</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.web.admin.objects.html"
title="previous chapter">evennia.web.admin.objects</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.web.admin.server.html"
title="next chapter">evennia.web.admin.server</a></p>
</div>
<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.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>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
Updated HTML docs.
2026-02-15 18:13:08 +00:00
<li>
<a href="https://www.evennia.com/docs/6.x/index.html">v6.0.0 branch (outdated)</a>
</li>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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.server.html" title="evennia.web.admin.server"
>next</a> |</li>
<li class="right" >
<a href="evennia.web.admin.objects.html" title="evennia.web.admin.objects"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</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.scripts</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue Copy permalink