<spanid="evennia-locks-lockfuncs"></span><h1>evennia.locks.lockfuncs<aclass="headerlink"href="#module-evennia.locks.lockfuncs"title="Permalink to this headline">¶</a></h1>
<p>This module provides a set of permission lock functions for use
with Evennia’s permissions system.</p>
<p>To call these locks, make sure this module is included in the
settings tuple <strong>PERMISSION_FUNC_MODULES</strong> then define a lock on the form
‘<access_type>:func(args)’ and add it to the object’s lockhandler.
Run the <strong>access()</strong> method of the handler to execute the lock check.</p>
<p>Note that <strong>accessing_obj</strong> and <strong>accessed_obj</strong> can be any object type
with a lock variable/field, so be careful to not expect
a certain object type.</p>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.true">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">true</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/locks/lockfuncs.html#true"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.true"title="Permalink to this definition">¶</a></dt>
<dd><p>Always returns True.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.all">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">all</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/locks/lockfuncs.html#all"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.all"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.false">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">false</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/locks/lockfuncs.html#false"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.false"title="Permalink to this definition">¶</a></dt>
<dd><p>Always returns False</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.none">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">none</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/locks/lockfuncs.html#none"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.none"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.superuser">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">superuser</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/locks/lockfuncs.html#superuser"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.superuser"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.self">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">self</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#self"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.self"title="Permalink to this definition">¶</a></dt>
<dd><p>Check if accessing_obj is the same as accessed_obj</p>
<dlclass="simple">
<dt>Usage:</dt><dd><p>self()</p>
</dd>
</dl>
<p>This can be used to lock specifically only to
the same object that the lock is defined on.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.perm">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">perm</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#perm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.perm"title="Permalink to this definition">¶</a></dt>
<p>where <permission> is the permission accessing_obj must
have in order to pass the lock.</p>
<p>If the given permission is part of settings.PERMISSION_HIERARCHY,
permission is also granted to all ranks higher up in the hierarchy.</p>
<p>If accessing_object is an Object controlled by an Account, the
permissions of the Account is used unless the Attribute _quell
is set to True on the Object. In this case however, the
LOWEST hieararcy-permission of the Account/Object-pair will be used
(this is order to avoid Accounts potentially escalating their own permissions
by use of a higher-level Object)</p>
<p>For non-hierarchical permissions, a puppeted object’s account is checked first,
followed by the puppet (unless quelled, when only puppet’s access is checked).</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.perm_above">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">perm_above</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#perm_above"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.perm_above"title="Permalink to this definition">¶</a></dt>
<dd><p>Only allow objects with a permission <em>higher</em> in the permission
hierarchy than the one given. If there is no such higher rank,
it’s assumed we refer to superuser. If no hierarchy is defined,
this function has no meaning and returns False.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.pperm">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">pperm</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#pperm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.pperm"title="Permalink to this definition">¶</a></dt>
<dd><p>The basic permission-checker only for Account objects. Ignores case.</p>
<p>where <permission> is the permission accessing_obj must
have in order to pass the lock. If the given permission
is part of _PERMISSION_HIERARCHY, permission is also granted
to all ranks higher up in the hierarchy.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.pperm_above">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">pperm_above</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#pperm_above"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.pperm_above"title="Permalink to this definition">¶</a></dt>
<dd><p>Only allow Account objects with a permission <em>higher</em> in the permission
hierarchy than the one given. If there is no such higher rank,
it’s assumed we refer to superuser. If no hierarchy is defined,
this function has no meaning and returns False.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.dbref">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">dbref</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#dbref"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.dbref"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>dbref(3)</p>
</dd>
</dl>
<p>This lock type checks if the checking object
has a particular dbref. Note that this only
works for checking objects that are stored
in the database (e.g. not for commands)</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.pdbref">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">pdbref</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#pdbref"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.pdbref"title="Permalink to this definition">¶</a></dt>
<dd><p>Same as dbref, but making sure accessing_obj is an account.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.id">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">id</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#id"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.id"title="Permalink to this definition">¶</a></dt>
<dd><p>Alias to dbref</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.pid">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">pid</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#pid"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.pid"title="Permalink to this definition">¶</a></dt>
<dd><p>Alias to dbref, for Accounts</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.attr">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.attr"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>attr(attrname)
attr(attrname, value)
attr(attrname, value, compare=type)</p>
</dd>
</dl>
<p>where compare’s type is one of (eq,gt,lt,ge,le,ne) and signifies
how the value should be compared with one on accessing_obj (so
compare=gt means the accessing_obj must have a value greater than
the one given).</p>
<p>Searches attributes <em>and</em> properties stored on the accessing_obj.
if accessing_obj has a property “obj”, then this is used as
accessing_obj (this makes this usable for Commands too)</p>
<p>The first form works like a flag - if the attribute/property
exists on the object, the value is checked for True/False. The
second form also requires that the value of the attribute/property
matches. Note that all retrieved values will be converted to
strings before doing the comparison.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.objattr">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">objattr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#objattr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.objattr"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>objattr(attrname)
objattr(attrname, value)
objattr(attrname, value, compare=type)</p>
</dd>
</dl>
<p>Works like attr, except it looks for an attribute on
accessed_obj instead.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.locattr">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">locattr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#locattr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.locattr"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>locattr(attrname)
locattr(attrname, value)
locattr(attrname, value, compare=type)</p>
</dd>
</dl>
<p>Works like attr, except it looks for an attribute on
accessing_obj.location, if such an entity exists.</p>
<p>if accessing_obj has a property “.obj” (such as is the case for a
Command), then accessing_obj.obj.location is used instead.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.objlocattr">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">objlocattr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#objlocattr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.objlocattr"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>locattr(attrname)
locattr(attrname, value)
locattr(attrname, value, compare=type)</p>
</dd>
</dl>
<p>Works like attr, except it looks for an attribute on
accessed_obj.location, if such an entity exists.</p>
<p>if accessed_obj has a property “.obj” (such as is the case for a
Command), then accessing_obj.obj.location is used instead.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.attr_eq">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">attr_eq</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#attr_eq"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.attr_eq"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>attr_gt(attrname, 54)</p>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.attr_gt">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">attr_gt</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#attr_gt"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.attr_gt"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>attr_gt(attrname, 54)</p>
</dd>
</dl>
<p>Only true if access_obj’s attribute > the value given.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.attr_ge">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">attr_ge</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#attr_ge"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.attr_ge"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>attr_gt(attrname, 54)</p>
</dd>
</dl>
<p>Only true if access_obj’s attribute >= the value given.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.attr_lt">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">attr_lt</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#attr_lt"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.attr_lt"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>attr_gt(attrname, 54)</p>
</dd>
</dl>
<p>Only true if access_obj’s attribute < the value given.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.attr_le">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">attr_le</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#attr_le"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.attr_le"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>attr_gt(attrname, 54)</p>
</dd>
</dl>
<p>Only true if access_obj’s attribute <= the value given.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.attr_ne">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">attr_ne</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#attr_ne"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.attr_ne"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>attr_gt(attrname, 54)</p>
</dd>
</dl>
<p>Only true if access_obj’s attribute != the value given.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.tag">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">tag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#tag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.tag"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>tag(tagkey)
tag(tagkey, category)</p>
</dd>
</dl>
<p>Only true if accessing_obj has the specified tag and optional
category.
If accessing_obj has the “.obj” property (such as is the case for
a command), then accessing_obj.obj is used instead.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.objloctag">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">objloctag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#objloctag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.objloctag"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>objloctag(tagkey)
objloctag(tagkey, category):</p>
</dd>
</dl>
<p>Only true if <strong>accessed_obj.location</strong> has the given tag and optional category.
If obj has no location, this lockfunc fails.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.is_ooc">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">is_ooc</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#is_ooc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.is_ooc"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>is_ooc()</p>
</dd>
</dl>
<p>This is normally used to lock a Command, so it can be used
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">objtag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#objtag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.objtag"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>objtag(tagkey)
objtag(tagkey, category)</p>
</dd>
</dl>
<p>Only true if accessed_obj has the specified tag and optional
category.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.inside">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">inside</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#inside"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.inside"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>inside()</p>
</dd>
</dl>
<p>True if accessing_obj is ‘inside’ accessing_obj. Note that this only checks
one level down. So if if the lock is on a room, you will pass but not your
inventory (since their location is you, not the locked object). If you
want also nested objects to pass the lock, use the <strong>insiderecursive</strong>
lockfunc.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.inside_rec">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">inside_rec</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#inside_rec"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.inside_rec"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><p>inside_rec()</p>
</dd>
</dl>
<p>True if accessing_obj is inside the accessed obj, at up to 10 levels
of recursion (so if this lock is on a room, then an object inside a box
in your inventory will also pass the lock).</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.holds">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">holds</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#holds"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.holds"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>Usage:</dt><dd><dlclass="simple">
<dt>holds() checks if accessed_obj or accessed_obj.obj</dt><dd><p>is held by accessing_obj</p>
</dd>
<dt>holds(key/dbref) checks if accessing_obj holds an object</dt><dd><p>with given key/dbref</p>
</dd>
<dt>holds(attrname, value) checks if accessing_obj holds an</dt><dd><p>object with the given attrname and value</p>
</dd>
</dl>
</dd>
</dl>
<p>This is passed if accessed_obj is carried by accessing_obj (that is,
accessed_obj.location == accessing_obj), or if accessing_obj itself holds
an object matching the given key.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.has_account">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">has_account</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#has_account"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.has_account"title="Permalink to this definition">¶</a></dt>
<dd><p>Only returns true if accessing_obj has_account is true, that is,
this is an account-controlled object. It fails on actual accounts!</p>
<p>This is a useful lock for traverse-locking Exits to restrain NPC
mobiles from moving outside their areas.</p>
</dd></dl>
<dlclass="py function">
<dtid="evennia.locks.lockfuncs.serversetting">
<codeclass="sig-prename descclassname">evennia.locks.lockfuncs.</code><codeclass="sig-name descname">serversetting</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">accessed_obj</span></em>, <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/locks/lockfuncs.html#serversetting"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.locks.lockfuncs.serversetting"title="Permalink to this definition">¶</a></dt>
<dd><p>Only returns true if the Evennia settings exists, alternatively has
a certain value.</p>
<dlclass="simple">
<dt>Usage:</dt><dd><p>serversetting(IRC_ENABLED)
serversetting(BASE_SCRIPT_PATH, [‘types’])</p>
</dd>
</dl>
<p>A given True/False or integers will be converted properly. Note that
everything will enter this function as strings, so they have to be
unpacked to their real value. We only support basic properties.</p>
