Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-03 14:37:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.contrib.grid.simpledoor.simpledoor.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

439 lines
No EOL
41 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.contrib.grid.simpledoor.simpledoor &#8212; 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.contrib.grid.simpledoor.tests" href="evennia.contrib.grid.simpledoor.tests.html" />
<link rel="prev" title="evennia.contrib.grid.simpledoor" href="evennia.contrib.grid.simpledoor.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.contrib.grid.simpledoor.tests.html" title="evennia.contrib.grid.simpledoor.tests"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.grid.simpledoor.html" title="evennia.contrib.grid.simpledoor"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.grid.html" >evennia.contrib.grid</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.grid.simpledoor.html" accesskey="U">evennia.contrib.grid.simpledoor</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.simpledoor.simpledoor</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.grid.simpledoor.simpledoor">
<span id="evennia-contrib-grid-simpledoor-simpledoor"></span><h1>evennia.contrib.grid.simpledoor.simpledoor<a class="headerlink" href="#module-evennia.contrib.grid.simpledoor.simpledoor" title="Link to this heading"></a></h1>
<p>SimpleDoor</p>
<p>Contribution - Griatch 2016</p>
<p>A simple two-way exit that represents a door that can be opened and
closed. Can easily be expanded from to make it lockable, destroyable
etc. Note that the simpledoor is based on Evennia locks, so it will
not work for a superuser (which bypasses all locks) - the superuser
will always appear to be able to close/open the door over and over
without the locks stopping you. To use the door, use <strong>&#64;quell</strong> or a
non-superuser account.</p>
<p>Installation:</p>
<p>Import this module in mygame/commands/default_cmdsets and add
the SimpleDoorCmdSet to your CharacterCmdSet:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># in mygame/commands/default_cmdsets.py</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">evennia.contrib.grid</span><span class="w"> </span><span class="kn">import</span> <span class="n">simpledoor</span> <span class="o">&lt;---</span>
<span class="k">class</span><span class="w"> </span><span class="nc">CharacterCmdSet</span><span class="p">(</span><span class="n">default_cmds</span><span class="o">.</span><span class="n">CharacterCmdSet</span><span class="p">):</span>
<span class="c1"># ...</span>
<span class="k">def</span><span class="w"> </span><span class="nf">at_cmdset_creation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># ...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">simpledoor</span><span class="o">.</span><span class="n">SimpleDoorCmdSet</span><span class="p">)</span>
</pre></div>
</div>
<p>Usage:</p>
<p>To try it out, <strong>dig</strong> a new room and then use the (overloaded) <strong>&#64;open</strong>
commmand to open a new doorway to it like this:</p>
<blockquote>
<div><p>&#64;open doorway:contrib.grid.simpledoor.SimpleDoor = otherroom</p>
</div></blockquote>
<p>You can then use <strong>open doorway’ and **close doorway</strong> to change the open
state. If you are not superuser (<strong>&#64;quell</strong> yourself) you’ll find you
cannot pass through either side of the door once it’s closed from the
other side.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.grid.simpledoor.simpledoor.</span></span><span class="sig-name descname"><span class="pre">SimpleDoor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#SimpleDoor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit" title="evennia.objects.objects.DefaultExit"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultExit</span></code></a></p>
<p>A two-way exit “door” with some methods for affecting both “sides”
of the door at the same time. For example, set a lock on either of the two
sides using <strong>exitname.setlock(“traverse:false())</strong></p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.at_object_creation">
<span class="sig-name descname"><span class="pre">at_object_creation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#SimpleDoor.at_object_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.at_object_creation" title="Link to this definition"></a></dt>
<dd><p>Called the very first time the door is created.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.setlock">
<span class="sig-name descname"><span class="pre">setlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lockstring</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#SimpleDoor.setlock"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.setlock" title="Link to this definition"></a></dt>
<dd><p>Sets identical locks on both sides of the door.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>lockstring</strong> (<em>str</em>) – A lockstring, like <strong>“traverse:true()”</strong>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.setdesc">
<span class="sig-name descname"><span class="pre">setdesc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#SimpleDoor.setdesc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.setdesc" title="Link to this definition"></a></dt>
<dd><p>Sets identical descs on both sides of the door.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>setdesc</strong> (<em>str</em>) – A description.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#SimpleDoor.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes both sides of the door.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.at_failed_traverse">
<span class="sig-name descname"><span class="pre">at_failed_traverse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">traversing_object</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#SimpleDoor.at_failed_traverse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.at_failed_traverse" title="Link to this definition"></a></dt>
<dd><p>Called when door traverse: lock fails.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>traversing_object</strong> (<em>Typeclassed entity</em>) – The object
attempting the traversal.</p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.DoesNotExist">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DoesNotExist</span></span><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit.DoesNotExist" title="evennia.objects.objects.DefaultExit.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.MultipleObjectsReturned">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MultipleObjectsReturned</span></span><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit.MultipleObjectsReturned" title="evennia.objects.objects.DefaultExit.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.typename">
<span class="sig-name descname"><span class="pre">typename</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SimpleDoor'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.typename" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpen">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.grid.simpledoor.simpledoor.</span></span><span class="sig-name descname"><span class="pre">CmdOpen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#CmdOpen"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.building.html#evennia.commands.default.building.CmdOpen" title="evennia.commands.default.building.CmdOpen"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdOpen</span></code></a></p>
<p>open a new exit from the current room</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>open &lt;new exit&gt;[;alias;alias..][:typeclass] [,&lt;return exit&gt;[;alias;..][:typeclass]]] = &lt;destination&gt;</p>
</dd>
</dl>
<p>Handles the creation of exits. If a destination is given, the exit
will point there. The &lt;return exit&gt; argument sets up an exit at the
destination leading back to the current room. Destination name
can be given both as a #dbref and a name, if that name is globally
unique.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.create_exit">
<span class="sig-name descname"><span class="pre">create_exit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exit_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exit_aliases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typeclass</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#CmdOpen.create_exit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.create_exit" title="Link to this definition"></a></dt>
<dd><p>Simple wrapper for the default CmdOpen.create_exit</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'building'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'&#64;open'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:perm(open)</span> <span class="pre">or</span> <span class="pre">perm(Builder)'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'',</span> <span class="pre">'category':</span> <span class="pre">'building',</span> <span class="pre">'key':</span> <span class="pre">'&#64;open',</span> <span class="pre">'no_prefix':</span> <span class="pre">'open</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nopen</span> <span class="pre">a</span> <span class="pre">new</span> <span class="pre">exit</span> <span class="pre">from</span> <span class="pre">the</span> <span class="pre">current</span> <span class="pre">room\n\nUsage:\n</span>&#160; <span class="pre">open</span> <span class="pre">&lt;new</span> <span class="pre">exit&gt;[;alias;alias..][:typeclass]</span> <span class="pre">[,&lt;return</span> <span class="pre">exit&gt;[;alias;..][:typeclass]]]</span> <span class="pre">=</span> <span class="pre">&lt;destination&gt;\n\nHandles</span> <span class="pre">the</span> <span class="pre">creation</span> <span class="pre">of</span> <span class="pre">exits.</span> <span class="pre">If</span> <span class="pre">a</span> <span class="pre">destination</span> <span class="pre">is</span> <span class="pre">given,</span> <span class="pre">the</span> <span class="pre">exit\nwill</span> <span class="pre">point</span> <span class="pre">there.</span> <span class="pre">The</span> <span class="pre">&lt;return</span> <span class="pre">exit&gt;</span> <span class="pre">argument</span> <span class="pre">sets</span> <span class="pre">up</span> <span class="pre">an</span> <span class="pre">exit</span> <span class="pre">at</span> <span class="pre">the\ndestination</span> <span class="pre">leading</span> <span class="pre">back</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">current</span> <span class="pre">room.</span> <span class="pre">Destination</span> <span class="pre">name\ncan</span> <span class="pre">be</span> <span class="pre">given</span> <span class="pre">both</span> <span class="pre">as</span> <span class="pre">a</span> <span class="pre">#dbref</span> <span class="pre">and</span> <span class="pre">a</span> <span class="pre">name,</span> <span class="pre">if</span> <span class="pre">that</span> <span class="pre">name</span> <span class="pre">is</span> <span class="pre">globally\nunique.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.grid.simpledoor.simpledoor.</span></span><span class="sig-name descname"><span class="pre">CmdOpenCloseDoor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#CmdOpenCloseDoor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">MuxCommand</span></code></a></p>
<p>Open and close a door</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>open &lt;door&gt;
close &lt;door&gt;</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'open'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['close']</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.locks">
<span class="sig-name descname"><span class="pre">locks</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:all()'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'general'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.func">
<span class="sig-name descname"><span class="pre">func</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#CmdOpenCloseDoor.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.func" title="Link to this definition"></a></dt>
<dd><p>implement the door functionality</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:all()'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'close',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'open',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">close',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nOpen</span> <span class="pre">and</span> <span class="pre">close</span> <span class="pre">a</span> <span class="pre">door\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">open</span> <span class="pre">&lt;door&gt;\n</span>&#160;&#160;&#160; <span class="pre">close</span> <span class="pre">&lt;door&gt;\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.grid.simpledoor.simpledoor.</span></span><span class="sig-name descname"><span class="pre">SimpleDoorCmdSet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdsetobj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#SimpleDoorCmdSet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdSet</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet.at_cmdset_creation">
<span class="sig-name descname"><span class="pre">at_cmdset_creation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/simpledoor/simpledoor.html#SimpleDoorCmdSet.at_cmdset_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet.at_cmdset_creation" title="Link to this definition"></a></dt>
<dd><p>Hook method - this should be overloaded in the inheriting
class, and should take care of populating the cmdset by use of
self.add().</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet'</span></em><a class="headerlink" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</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>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.grid.simpledoor.simpledoor</a><ul>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor"><code class="docutils literal notranslate"><span class="pre">SimpleDoor</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.at_object_creation"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.at_object_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.setlock"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.setlock()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.setdesc"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.setdesc()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.delete"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.delete()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.at_failed_traverse"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.at_failed_traverse()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.path"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoor.typename"><code class="docutils literal notranslate"><span class="pre">SimpleDoor.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen"><code class="docutils literal notranslate"><span class="pre">CmdOpen</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.create_exit"><code class="docutils literal notranslate"><span class="pre">CmdOpen.create_exit()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.aliases"><code class="docutils literal notranslate"><span class="pre">CmdOpen.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.help_category"><code class="docutils literal notranslate"><span class="pre">CmdOpen.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.key"><code class="docutils literal notranslate"><span class="pre">CmdOpen.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdOpen.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpen.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdOpen.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor"><code class="docutils literal notranslate"><span class="pre">CmdOpenCloseDoor</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.key"><code class="docutils literal notranslate"><span class="pre">CmdOpenCloseDoor.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.aliases"><code class="docutils literal notranslate"><span class="pre">CmdOpenCloseDoor.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.locks"><code class="docutils literal notranslate"><span class="pre">CmdOpenCloseDoor.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.help_category"><code class="docutils literal notranslate"><span class="pre">CmdOpenCloseDoor.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.func"><code class="docutils literal notranslate"><span class="pre">CmdOpenCloseDoor.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdOpenCloseDoor.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.CmdOpenCloseDoor.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdOpenCloseDoor.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet"><code class="docutils literal notranslate"><span class="pre">SimpleDoorCmdSet</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet.at_cmdset_creation"><code class="docutils literal notranslate"><span class="pre">SimpleDoorCmdSet.at_cmdset_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.grid.simpledoor.simpledoor.SimpleDoorCmdSet.path"><code class="docutils literal notranslate"><span class="pre">SimpleDoorCmdSet.path</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.grid.simpledoor.html"
title="previous chapter">evennia.contrib.grid.simpledoor</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.grid.simpledoor.tests.html"
title="next chapter">evennia.contrib.grid.simpledoor.tests</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.contrib.grid.simpledoor.simpledoor.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.contrib.grid.simpledoor.tests.html" title="evennia.contrib.grid.simpledoor.tests"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.grid.simpledoor.html" title="evennia.contrib.grid.simpledoor"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.grid.html" >evennia.contrib.grid</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.grid.simpledoor.html" >evennia.contrib.grid.simpledoor</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.simpledoor.simpledoor</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink