Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-03 06:27:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/_modules/evennia/scripts/admin.html

186 lines
12 KiB
HTML
Raw Normal View History

Updated HTML docs
2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<html>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<head>
<meta charset="utf-8" />
Updated HTML docs
2020-10-15 01:31:30 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
Updated HTML docs
2020-06-15 21:52:33 +02:00
<title>evennia.scripts.admin &#8212; 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>
Updated HTML docs
2020-06-13 23:31:27 +02:00
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<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>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia 1.0-dev</a> &#187;</li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-2"><a href="../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.scripts.admin</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-11-14 11:55:52 +01:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
Updated HTML docs
2020-06-13 00:36:45 +02:00
<h1>Source code for evennia.scripts.admin</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># This sets up how models are displayed</span>
<span class="c1"># in the web admin interface.</span>
<span class="c1">#</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="k">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">evennia.typeclasses.admin</span> <span class="k">import</span> <span class="n">AttributeInline</span><span class="p">,</span> <span class="n">TagInline</span>
<span class="kn">from</span> <span class="nn">evennia.scripts.models</span> <span class="k">import</span> <span class="n">ScriptDB</span>
<span class="kn">from</span> <span class="nn">django.contrib</span> <span class="k">import</span> <span class="n">admin</span>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="viewcode-block" id="ScriptTagInline"><a class="viewcode-back" href="../../../api/evennia.scripts.admin.html#evennia.scripts.admin.ScriptTagInline">[docs]</a><span class="k">class</span> <span class="nc">ScriptTagInline</span><span class="p">(</span><span class="n">TagInline</span><span class="p">):</span>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Inline script tags.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">ScriptDB</span><span class="o">.</span><span class="n">db_tags</span><span class="o">.</span><span class="n">through</span>
<span class="n">related_field</span> <span class="o">=</span> <span class="s2">&quot;scriptdb&quot;</span></div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="viewcode-block" id="ScriptAttributeInline"><a class="viewcode-back" href="../../../api/evennia.scripts.admin.html#evennia.scripts.admin.ScriptAttributeInline">[docs]</a><span class="k">class</span> <span class="nc">ScriptAttributeInline</span><span class="p">(</span><span class="n">AttributeInline</span><span class="p">):</span>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Inline attribute tags.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">ScriptDB</span><span class="o">.</span><span class="n">db_attributes</span><span class="o">.</span><span class="n">through</span>
<span class="n">related_field</span> <span class="o">=</span> <span class="s2">&quot;scriptdb&quot;</span></div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="viewcode-block" id="ScriptDBAdmin"><a class="viewcode-back" href="../../../api/evennia.scripts.admin.html#evennia.scripts.admin.ScriptDBAdmin">[docs]</a><span class="k">class</span> <span class="nc">ScriptDBAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Displaying the main Script page.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span>
<span class="s2">&quot;id&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_key&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_typeclass_path&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_obj&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_interval&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_repeats&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_persistent&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">list_display_links</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;id&quot;</span><span class="p">,</span> <span class="s2">&quot;db_key&quot;</span><span class="p">)</span>
<span class="n">ordering</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;db_obj&quot;</span><span class="p">,</span> <span class="s2">&quot;db_typeclass_path&quot;</span><span class="p">]</span>
<span class="n">search_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;^db_key&quot;</span><span class="p">,</span> <span class="s2">&quot;db_typeclass_path&quot;</span><span class="p">]</span>
<span class="n">save_as</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">save_on_top</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">list_select_related</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">raw_id_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;db_obj&quot;</span><span class="p">,)</span>
<span class="n">fieldsets</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span>
<span class="kc">None</span><span class="p">,</span>
<span class="p">{</span>
<span class="s2">&quot;fields&quot;</span><span class="p">:</span> <span class="p">(</span>
<span class="p">(</span><span class="s2">&quot;db_key&quot;</span><span class="p">,</span> <span class="s2">&quot;db_typeclass_path&quot;</span><span class="p">),</span>
<span class="s2">&quot;db_interval&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_repeats&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_start_delay&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_persistent&quot;</span><span class="p">,</span>
<span class="s2">&quot;db_obj&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">},</span>
<span class="p">),</span>
<span class="p">)</span>
<span class="n">inlines</span> <span class="o">=</span> <span class="p">[</span><span class="n">ScriptTagInline</span><span class="p">,</span> <span class="n">ScriptAttributeInline</span><span class="p">]</span>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<div class="viewcode-block" id="ScriptDBAdmin.save_model"><a class="viewcode-back" href="../../../api/evennia.scripts.admin.html#evennia.scripts.admin.ScriptDBAdmin.save_model">[docs]</a> <span class="k">def</span> <span class="nf">save_model</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">form</span><span class="p">,</span> <span class="n">change</span><span class="p">):</span>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Model-save hook.</span>
<span class="sd"> Args:</span>
<span class="sd"> request (Request): Incoming request.</span>
<span class="sd"> obj (Object): Database object.</span>
<span class="sd"> form (Form): Form instance.</span>
<span class="sd"> change (bool): If this is a change or a new object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">obj</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">change</span><span class="p">:</span>
<span class="c1"># adding a new object</span>
<span class="c1"># have to call init with typeclass passed to it</span>
<span class="n">obj</span><span class="o">.</span><span class="n">set_class_from_typeclass</span><span class="p">(</span><span class="n">typeclass_path</span><span class="o">=</span><span class="n">obj</span><span class="o">.</span><span class="n">db_typeclass_path</span><span class="p">)</span></div></div>
<span class="n">admin</span><span class="o">.</span><span class="n">site</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">ScriptDB</span><span class="p">,</span> <span class="n">ScriptDBAdmin</span><span class="p">)</span>
</pre></div>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<div class="clearer"></div>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
</div>
</div>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<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>
<h3>Versions</h3>
<ul>
<li><a href="admin.html">1.0-dev (develop branch)</a></li>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<li><a href="../../../../0.9.5/index.html">0.9.5 (master branch)</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
Updated HTML docs
2020-06-15 21:52:33 +02:00
</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>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia 1.0-dev</a> &#187;</li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-2"><a href="../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.scripts.admin</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-11-14 11:55:52 +01:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Updated HTML docs
2020-10-15 01:31:30 +02:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
</body>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</html>
Reference in a new issue Copy permalink