mirror of
https://github.com/evennia/evennia.git
synced 2026-04-03 14:37:17 +02:00
Updated HTML docs
This commit is contained in:
Griatch
parent
86fb09d6bf
commit
86c930be7a
1221 changed files with 76528 additions and 29095 deletions
|
|
@ -30,6 +30,7 @@
|
|||
<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.models</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
|
|
@ -105,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>
|
||||
|
|
@ -133,11 +134,28 @@ object the first time, the query is executed.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.help.models.HelpEntry.access">
|
||||
<code class="sig-name descname">access</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">accessing_obj</span></em>, <em class="sig-param"><span class="n">access_type</span><span class="o">=</span><span class="default_value">'read'</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.access"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.access" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determines if another object has permission to access.
|
||||
accessing_obj - object trying to access this one
|
||||
access_type - type of access sought
|
||||
default - what to return if no lock of access_type was found</p>
|
||||
<code class="sig-name descname">access</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">accessing_obj</span></em>, <em class="sig-param"><span class="n">access_type</span><span class="o">=</span><span class="default_value">'read'</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/models.html#HelpEntry.access"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.models.HelpEntry.access" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Determines if another object has permission to access this help entry.</p>
|
||||
<dl class="simple">
|
||||
<dt>Accesses used by default:</dt><dd><p>‘read’ - read the help entry itself.
|
||||
‘view’ - see help entry in help index.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>accessing_obj</strong> (<em>Object</em><em> or </em><em>Account</em>) – Entity trying to access this one.</p></li>
|
||||
<li><p><strong>access_type</strong> (<em>str</em>) – type of access sought.</p></li>
|
||||
<li><p><strong>default</strong> (<em>bool</em>) – What to return if no lock of <strong>access_type</strong> was found.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.help.models.HelpEntry.search_index_entry">
|
||||
<em class="property">property </em><code class="sig-name descname">search_index_entry</code><a class="headerlink" href="#evennia.help.models.HelpEntry.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Property for easily retaining a search index entry for this object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -161,8 +179,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
|
||||
|
|
@ -184,11 +204,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
|
||||
|
|
@ -210,11 +230,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
|
||||
|
|
@ -235,11 +255,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
|
||||
|
|
@ -261,11 +281,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
|
||||
|
|
@ -290,12 +310,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>
|
||||
|
|
@ -326,12 +362,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>
|
||||
|
|
@ -384,7 +414,6 @@ object the first time, the query is executed.</p>
|
|||
<li><a href="../../0.9.5/api/evennia.help.models.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
|
|
@ -401,6 +430,7 @@ object the first time, the query is executed.</p>
|
|||
<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.models</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue