<spanid="evennia-help-models"></span><h1>evennia.help.models<aclass="headerlink"href="#module-evennia.help.models"title="Permalink to this headline">¶</a></h1>
<p>Models for the help system.</p>
<p>The database-tied help system is only half of Evennia’s help
functionality, the other one being the auto-generated command help
that is created on the fly from each command’s <strong>__doc__</strong> string. The
persistent database system defined here is intended for all other
forms of help that do not concern commands, like information about the
game world, policy info, rules and similar.</p>
<dlclass="py class">
<dtid="evennia.help.models.HelpEntry">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.help.models.</code><codeclass="sig-name descname">HelpEntry</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry"title="Permalink to this definition">¶</a></dt>
<dt>An HelpEntry object has the following properties defined:</dt><dd><p>key - main name of entry
help_category - which category entry belongs to (defaults to General)
entrytext - the actual help text
permissions - perm strings</p>
</dd>
<dt>Method:</dt><dd><p>access</p>
</dd>
</dl>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.db_key">
<codeclass="sig-name descname">db_key</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_key"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<codeclass="sig-name descname">db_help_category</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_help_category"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<codeclass="sig-name descname">db_entrytext</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_entrytext"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<codeclass="sig-name descname">db_lock_storage</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_lock_storage"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>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.db_tags">
<codeclass="sig-name descname">db_tags</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_tags"title="Permalink to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<codeclass="sig-name descname">db_date_created</code><aclass="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>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.objects">
<codeclass="sig-name descname">objects</code><emclass="property"> = <evennia.help.manager.HelpEntryManager object></em><aclass="headerlink"href="#evennia.help.models.HelpEntry.objects"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.locks">
<codeclass="sig-name descname">locks</code><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.locks"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.locks"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.tags">
<codeclass="sig-name descname">tags</code><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.tags"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.tags"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.aliases">
<codeclass="sig-name descname">aliases</code><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.aliases"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.aliases"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="evennia.help.models.HelpEntry.access">
<codeclass="sig-name descname">access</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">access_type</span><spanclass="o">=</span><spanclass="default_value">'read'</span></em>, <emclass="sig-param"><spanclass="n">default</span><spanclass="o">=</span><spanclass="default_value">True</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.access"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="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>
<emclass="property">property </em><codeclass="sig-name descname">search_index_entry</code><aclass="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>
<codeclass="sig-name descname">web_get_admin_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_admin_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_admin_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for the Django Admin page for this object.</p>
<emclass="property">classmethod </em><codeclass="sig-name descname">web_get_create_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_create_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_create_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to create new
instances of this object.</p>
<p>ex. Chargen = ‘/characters/create/’</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>
<codeclass="sig-name descname">web_get_detail_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_detail_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_detail_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to view details for
this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</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>
<codeclass="sig-name descname">web_get_update_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_update_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_update_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to update this
object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/change/’</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>
<codeclass="sig-name descname">web_get_delete_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_delete_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_delete_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to delete this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/delete/’</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>
<codeclass="sig-name descname">get_absolute_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.help.models.HelpEntry.get_absolute_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to view details for
this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</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>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">date_created</code><aclass="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>
<dlclass="py method">
<dtid="evennia.help.models.HelpEntry.entrytext">
<emclass="property">property </em><codeclass="sig-name descname">entrytext</code><aclass="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>
<codeclass="sig-name descname">get_next_by_db_date_created</code><spanclass="sig-paren">(</span><emclass="sig-param">*</em>, <emclass="sig-param">field=<django.db.models.fields.DateTimeField: db_date_created></em>, <emclass="sig-param">is_next=True</em>, <emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.help.models.HelpEntry.get_next_by_db_date_created"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_previous_by_db_date_created</code><spanclass="sig-paren">(</span><emclass="sig-param">*</em>, <emclass="sig-param">field=<django.db.models.fields.DateTimeField: db_date_created></em>, <emclass="sig-param">is_next=False</em>, <emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.help.models.HelpEntry.get_previous_by_db_date_created"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">help_category</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.help_category"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <strong>db_help_category</strong>.</p>
</dd></dl>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.id">
<codeclass="sig-name descname">id</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.id"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>
<dlclass="py method">
<dtid="evennia.help.models.HelpEntry.key">
<emclass="property">property </em><codeclass="sig-name descname">key</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.key"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <strong>db_key</strong>.</p>
<emclass="property">property </em><codeclass="sig-name descname">lock_storage</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.lock_storage"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <strong>db_lock_storage</strong>.</p>
</dd></dl>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.path">
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.help.models.HelpEntry'</em><aclass="headerlink"href="#evennia.help.models.HelpEntry.path"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py attribute">
<dtid="evennia.help.models.HelpEntry.typename">
<codeclass="sig-name descname">typename</code><emclass="property"> = 'SharedMemoryModelBase'</em><aclass="headerlink"href="#evennia.help.models.HelpEntry.typename"title="Permalink to this definition">¶</a></dt>
