mirror of
https://github.com/evennia/evennia.git
synced 2026-03-24 00:36:30 +01:00
234 lines
No EOL
19 KiB
HTML
234 lines
No EOL
19 KiB
HTML
<!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.locks — 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.locks.lockfuncs" href="evennia.locks.lockfuncs.html" />
|
|
<link rel="prev" title="evennia.help.utils" href="evennia.help.utils.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.locks.lockfuncs.html" title="evennia.locks.lockfuncs"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.help.utils.html" title="evennia.help.utils"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-3"><a href="evennia.html" accesskey="U">evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.locks</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<section id="module-evennia.locks">
|
|
<span id="evennia-locks"></span><h1>evennia.locks<a class="headerlink" href="#module-evennia.locks" title="Link to this heading">¶</a></h1>
|
|
<p>This sub-package defines the lock (access) mechanism of Evennia. All
|
|
lock strings are processed through the lockhandler in this package. It
|
|
also contains the default lock functions used in lock definitions.</p>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.true"><code class="docutils literal notranslate"><span class="pre">true()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.all"><code class="docutils literal notranslate"><span class="pre">all()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.false"><code class="docutils literal notranslate"><span class="pre">false()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.none"><code class="docutils literal notranslate"><span class="pre">none()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.superuser"><code class="docutils literal notranslate"><span class="pre">superuser()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.self"><code class="docutils literal notranslate"><span class="pre">self()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.perm"><code class="docutils literal notranslate"><span class="pre">perm()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.perm_above"><code class="docutils literal notranslate"><span class="pre">perm_above()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.pperm"><code class="docutils literal notranslate"><span class="pre">pperm()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.pperm_above"><code class="docutils literal notranslate"><span class="pre">pperm_above()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.dbref"><code class="docutils literal notranslate"><span class="pre">dbref()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.pdbref"><code class="docutils literal notranslate"><span class="pre">pdbref()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.id"><code class="docutils literal notranslate"><span class="pre">id()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.pid"><code class="docutils literal notranslate"><span class="pre">pid()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.attr"><code class="docutils literal notranslate"><span class="pre">attr()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.objattr"><code class="docutils literal notranslate"><span class="pre">objattr()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.locattr"><code class="docutils literal notranslate"><span class="pre">locattr()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.objlocattr"><code class="docutils literal notranslate"><span class="pre">objlocattr()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.attr_eq"><code class="docutils literal notranslate"><span class="pre">attr_eq()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.attr_gt"><code class="docutils literal notranslate"><span class="pre">attr_gt()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.attr_ge"><code class="docutils literal notranslate"><span class="pre">attr_ge()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.attr_lt"><code class="docutils literal notranslate"><span class="pre">attr_lt()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.attr_le"><code class="docutils literal notranslate"><span class="pre">attr_le()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.attr_ne"><code class="docutils literal notranslate"><span class="pre">attr_ne()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.tag"><code class="docutils literal notranslate"><span class="pre">tag()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.objloctag"><code class="docutils literal notranslate"><span class="pre">objloctag()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.is_ooc"><code class="docutils literal notranslate"><span class="pre">is_ooc()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.objtag"><code class="docutils literal notranslate"><span class="pre">objtag()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.inside"><code class="docutils literal notranslate"><span class="pre">inside()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.inside_rec"><code class="docutils literal notranslate"><span class="pre">inside_rec()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.holds"><code class="docutils literal notranslate"><span class="pre">holds()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.has_account"><code class="docutils literal notranslate"><span class="pre">has_account()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockfuncs.html#evennia.locks.lockfuncs.serversetting"><code class="docutils literal notranslate"><span class="pre">serversetting()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="evennia.locks.lockhandler.html">evennia.locks.lockhandler</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler"><code class="docutils literal notranslate"><span class="pre">LockHandler</span></code></a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.__init__"><code class="docutils literal notranslate"><span class="pre">LockHandler.__init__()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.cache_lock_bypass"><code class="docutils literal notranslate"><span class="pre">LockHandler.cache_lock_bypass()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.add"><code class="docutils literal notranslate"><span class="pre">LockHandler.add()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.validate"><code class="docutils literal notranslate"><span class="pre">LockHandler.validate()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.replace"><code class="docutils literal notranslate"><span class="pre">LockHandler.replace()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.get"><code class="docutils literal notranslate"><span class="pre">LockHandler.get()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.all"><code class="docutils literal notranslate"><span class="pre">LockHandler.all()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.remove"><code class="docutils literal notranslate"><span class="pre">LockHandler.remove()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.delete"><code class="docutils literal notranslate"><span class="pre">LockHandler.delete()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.clear"><code class="docutils literal notranslate"><span class="pre">LockHandler.clear()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.reset"><code class="docutils literal notranslate"><span class="pre">LockHandler.reset()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.append"><code class="docutils literal notranslate"><span class="pre">LockHandler.append()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.check"><code class="docutils literal notranslate"><span class="pre">LockHandler.check()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.check_lockstring"><code class="docutils literal notranslate"><span class="pre">LockHandler.check_lockstring()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockException"><code class="docutils literal notranslate"><span class="pre">LockException</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.check_lockstring"><code class="docutils literal notranslate"><span class="pre">check_lockstring()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.check_perm"><code class="docutils literal notranslate"><span class="pre">check_perm()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.get_all_lockfuncs"><code class="docutils literal notranslate"><span class="pre">get_all_lockfuncs()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="evennia.locks.lockhandler.html#evennia.locks.lockhandler.validate_lockstring"><code class="docutils literal notranslate"><span class="pre">validate_lockstring()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</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>
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="evennia.help.utils.html"
|
|
title="previous chapter">evennia.help.utils</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="evennia.locks.lockfuncs.html"
|
|
title="next chapter">evennia.locks.lockfuncs</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.locks.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>
|
|
|
|
|
|
<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.locks.lockfuncs.html" title="evennia.locks.lockfuncs"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.help.utils.html" title="evennia.help.utils"
|
|
>previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.locks</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2024, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
</div>
|
|
</body>
|
|
</html> |