Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-26 09:46:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
evennia/docs/latest/api/evennia.contrib.full_systems.evscaperoom.objects.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

2220 lines
No EOL
285 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.full_systems.evscaperoom.objects &#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.full_systems.evscaperoom.room" href="evennia.contrib.full_systems.evscaperoom.room.html" />
<link rel="prev" title="evennia.contrib.full_systems.evscaperoom.menu" href="evennia.contrib.full_systems.evscaperoom.menu.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.full_systems.evscaperoom.room.html" title="evennia.contrib.full_systems.evscaperoom.room"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.full_systems.evscaperoom.menu.html" title="evennia.contrib.full_systems.evscaperoom.menu"
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.full_systems.html" >evennia.contrib.full_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.full_systems.evscaperoom.html" accesskey="U">evennia.contrib.full_systems.evscaperoom</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.objects</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.full_systems.evscaperoom.objects">
<span id="evennia-contrib-full-systems-evscaperoom-objects"></span><h1>evennia.contrib.full_systems.evscaperoom.objects<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.objects" title="Link to this heading"></a></h1>
<p>Base objects for the Evscaperoom contrib.</p>
<p>The object class itself provide the actions possible to use on that object.
This makes these objects suitable for use with multi-inheritance. For example,
to make an object both possible to smell and eat or drink, find the appropriate
parents in this module and make an object like this:</p>
<p>class Apple(Edible, Smellable):</p>
<blockquote>
<div><dl class="simple">
<dt>def at_drink(self, caller):</dt><dd><p># …</p>
</dd>
<dt>def at_smell(self, caller):</dt><dd><p># …</p>
</dd>
</dl>
</div></blockquote>
<p>Various object parents could be more complex, so read the class for more info.</p>
<p>Available parents:</p>
<ul class="simple">
<li><p>EvscapeRoomObject - parent class for all Evscaperoom entities (also the room itself)</p></li>
<li><p>Feelable</p></li>
<li><p>Listenable</p></li>
<li><p>Smellable</p></li>
<li><p>Rotatable</p></li>
<li><p>Openable</p></li>
<li><p>Readable</p></li>
<li><p>IndexReadable (like a lexicon you have to give a search term in)</p></li>
<li><p>Movable</p></li>
<li><p>Edible</p></li>
<li><p>Drinkable</p></li>
<li><p>Usable</p></li>
<li><p>Insertable (can be inserted into a target)</p></li>
<li><p>Combinable (combines with another object to create a new one)</p></li>
<li><p>Mixable (used for mixing potions into it)</p></li>
<li><p>HasButtons (an object with buttons on it)</p></li>
<li><p>CodeInput (code locks)</p></li>
<li><p>Sittable (can be sat on)</p></li>
<li><p>Liable (can be lied down on)</p></li>
<li><p>Kneeable (can be kneed down on)</p></li>
<li><p>Climbable (can be climbed on)</p></li>
<li><p>Positionable (supports sit/lie/knee/climb at once)</p></li>
</ul>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">EvscaperoomObject</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/full_systems/evscaperoom/objects.html#EvscaperoomObject"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultObject</span></code></a></p>
<p>Default object base for all objects related to the contrib.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.action_prepositions">
<span class="sig-name descname"><span class="pre">action_prepositions</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('in',</span> <span class="pre">'with',</span> <span class="pre">'on',</span> <span class="pre">'into',</span> <span class="pre">'to')</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.action_prepositions" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.position_prep_map">
<span class="sig-name descname"><span class="pre">position_prep_map</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'climb':</span> <span class="pre">'standing',</span> <span class="pre">'kneel':</span> <span class="pre">'kneeling',</span> <span class="pre">'lie':</span> <span class="pre">'lying',</span> <span class="pre">'sit':</span> <span class="pre">'sitting'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.position_prep_map" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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/full_systems/evscaperoom/objects.html#EvscaperoomObject.at_object_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_object_creation" title="Link to this definition"></a></dt>
<dd><p>Called once when object is first created.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.tagcategory">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tagcategory</span></span><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.tagcategory" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.room">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">room</span></span><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.room" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.roomstate">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">roomstate</span></span><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.roomstate" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.next_state">
<span class="sig-name descname"><span class="pre">next_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statename</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/full_systems/evscaperoom/objects.html#EvscaperoomObject.next_state"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.next_state" title="Link to this definition"></a></dt>
<dd><p>Helper to have the object switch the room to next state</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>statename</strong> (<em>str</em><em>, </em><em>optional</em>) – If given, move to this
state next. Otherwise use the default next-state
of the current state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_flag">
<span class="sig-name descname"><span class="pre">set_flag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flagname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.set_flag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_flag" title="Link to this definition"></a></dt>
<dd><p>Set flag on object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.unset_flag">
<span class="sig-name descname"><span class="pre">unset_flag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flagname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.unset_flag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.unset_flag" title="Link to this definition"></a></dt>
<dd><p>Unset flag on object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.check_flag">
<span class="sig-name descname"><span class="pre">check_flag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flagname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.check_flag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.check_flag" title="Link to this definition"></a></dt>
<dd><p>Check if flag is set on this object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_character_flag">
<span class="sig-name descname"><span class="pre">set_character_flag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">char</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flagname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.set_character_flag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_character_flag" title="Link to this definition"></a></dt>
<dd><p>Set flag on character</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.unset_character_flag">
<span class="sig-name descname"><span class="pre">unset_character_flag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">char</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flagname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.unset_character_flag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.unset_character_flag" title="Link to this definition"></a></dt>
<dd><p>Set flag on character</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.check_character_flag">
<span class="sig-name descname"><span class="pre">check_character_flag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">char</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flagname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.check_character_flag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.check_character_flag" title="Link to this definition"></a></dt>
<dd><p>Check if flag is set on character</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_room">
<span class="sig-name descname"><span class="pre">msg_room</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_caller</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.msg_room"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_room" title="Link to this definition"></a></dt>
<dd><p>Message everyone in the room with a message that is parsed for
~first/third person grammar, as well as for <a href="#id1"><span class="problematic" id="id2">*</span></a>thing markers.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>caller</strong> (<em>Object</em><em> or </em><em>None</em>) – Sender of the message. If None, there
is no sender.</p></li>
<li><p><strong>string</strong> (<em>str</em>) – Message to parse and send to the room.</p></li>
<li><p><strong>skip_caller</strong> (<em>bool</em>) – Send to everyone except caller.</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Messages sent by this method will be tagged with a type of
‘your_action’ and <strong>others_action</strong>. This is an experiment for
allowing users of e.g. the webclient to redirect messages to
differnt windows.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_char">
<span class="sig-name descname"><span class="pre">msg_char</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'your_action'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.msg_char"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_char" title="Link to this definition"></a></dt>
<dd><p>Send message only to caller (not to the room at large)</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_system">
<span class="sig-name descname"><span class="pre">msg_system</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</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">borders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.msg_system"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_system" title="Link to this definition"></a></dt>
<dd><p>Send a ‘system message’ by using the State.msg function.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_position">
<span class="sig-name descname"><span class="pre">get_position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.get_position"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_position" title="Link to this definition"></a></dt>
<dd><p>Get position of caller on this object (like lying, sitting, kneeling,
standing). See the Positionable child class.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>caller</strong> (<em>Object</em>) – The one position we seek.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><p><em>obj, pos (Object, str)</em> –</p>
<dl class="simple">
<dt>The object we have a position relative to,</dt><dd><p>as well as the name of that position (lying, sitting, kneeling,
standing). If these are None, it means we are standing on the
floor.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_position">
<span class="sig-name descname"><span class="pre">set_position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_position</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.set_position"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_position" title="Link to this definition"></a></dt>
<dd><p>Set position of caller (like lying, sitting, kneeling, standing)
on this object. See Positionable child class.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>caller</strong> (<em>Object</em>) – The one positioning themselves on this object.</p></li>
<li><p><strong>new_position</strong> (<em>str</em><em>, </em><em>None</em>) – One of “lie”, “kneel”, “sit” or “stand”.
If <strong>None</strong>, remove position (character stands normally on the
floor).</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_focus">
<span class="sig-name descname"><span class="pre">at_focus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.at_focus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_focus" title="Link to this definition"></a></dt>
<dd><p>Called when somone is focusing on this object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>caller</strong> (<em>Character</em>) – The one doing the focusing.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_unfocus">
<span class="sig-name descname"><span class="pre">at_unfocus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.at_unfocus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_unfocus" title="Link to this definition"></a></dt>
<dd><p>Called when focus leaves this object. Note that more than one caller
may be focusing on the object at the same time, so we should not change
the state of the object itself here!</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>caller</strong> (<em>Character</em>) – The one doing the unfocusing.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_speech">
<span class="sig-name descname"><span class="pre">at_speech</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">speaker</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.at_speech"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_speech" title="Link to this definition"></a></dt>
<dd><p>We don’t use the default at_say hook since we handle the send logic in
the command. This is only meant to trigger eventual game-events when
speaking to an object or the room.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>speaker</strong> (<em>Character</em>) – The one speaking.</p></li>
<li><p><strong>action</strong> (<em>str</em>) – One of ‘say’, ‘whisper’ or ‘shout’</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.parse">
<span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.parse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.parse" title="Link to this definition"></a></dt>
<dd><p>Simple parser of focus arguments starting with a preposition,
like ‘combine with &lt;object&gt;’ &lt;- we want to strip out the preposition
here.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_cmd_signatures">
<span class="sig-name descname"><span class="pre">get_cmd_signatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.get_cmd_signatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_cmd_signatures" title="Link to this definition"></a></dt>
<dd><p>This allows the object to return more detailed call signs
for each of their at_focus_* methods. This is useful for
things like detailed arguments (only ‘move’ but ‘move left/right’)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>callsigns (list, None)</em> –</p>
<dl class="simple">
<dt>List of strings to inject into the</dt><dd><p>available action list produced by <strong>self.get_help</strong>. If <strong>None</strong>,
automatically find actions based on the method names.</p>
</dd>
<dt>custom_helpstr (str): This should be the help text for</dt><dd><p>the command with a marker <strong>{callsigns}</strong> for where to
inject the list of callsigns.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_short_desc">
<span class="sig-name descname"><span class="pre">get_short_desc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_desc</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.get_short_desc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_short_desc" title="Link to this definition"></a></dt>
<dd><p>Extract the first sentence from the desc and use as the short desc.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_help">
<span class="sig-name descname"><span class="pre">get_help</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#EvscaperoomObject.get_help"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_help" title="Link to this definition"></a></dt>
<dd><p>Get help about this object. By default we return a
listing of all actions you can do on this object.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.return_appearance">
<span class="sig-name descname"><span class="pre">return_appearance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">looker</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/full_systems/evscaperoom/objects.html#EvscaperoomObject.return_appearance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.return_appearance" title="Link to this definition"></a></dt>
<dd><p>Could be modified per state. We generally don’t worry about the
contents of the object by default.</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.DoesNotExist" title="evennia.objects.objects.DefaultObject.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.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.MultipleObjectsReturned" title="evennia.objects.objects.DefaultObject.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.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.EvscaperoomObject'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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">'EvscaperoomObject'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Feelable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Feelable</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/full_systems/evscaperoom/objects.html#Feelable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object that you can feel the surface of.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Feelable.at_focus_feel">
<span class="sig-name descname"><span class="pre">at_focus_feel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Feelable.at_focus_feel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable.at_focus_feel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Feelable.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.full_systems.evscaperoom.objects.Feelable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Feelable.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.full_systems.evscaperoom.objects.Feelable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Feelable.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.full_systems.evscaperoom.objects.Feelable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Feelable.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">'Feelable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable.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.full_systems.evscaperoom.objects.Listenable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Listenable</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/full_systems/evscaperoom/objects.html#Listenable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object one can listen to.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Listenable.at_focus_listen">
<span class="sig-name descname"><span class="pre">at_focus_listen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Listenable.at_focus_listen"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable.at_focus_listen" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Listenable.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.full_systems.evscaperoom.objects.Listenable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Listenable.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.full_systems.evscaperoom.objects.Listenable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Listenable.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.full_systems.evscaperoom.objects.Listenable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Listenable.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">'Listenable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable.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.full_systems.evscaperoom.objects.Smellable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Smellable</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/full_systems/evscaperoom/objects.html#Smellable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object you can smell.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Smellable.at_focus_smell">
<span class="sig-name descname"><span class="pre">at_focus_smell</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Smellable.at_focus_smell"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable.at_focus_smell" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Smellable.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.full_systems.evscaperoom.objects.Smellable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Smellable.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.full_systems.evscaperoom.objects.Smellable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Smellable.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.full_systems.evscaperoom.objects.Smellable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Smellable.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">'Smellable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable.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.full_systems.evscaperoom.objects.Rotatable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Rotatable</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/full_systems/evscaperoom/objects.html#Rotatable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object that you can lift up and look at from different angles</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.rotate_flag">
<span class="sig-name descname"><span class="pre">rotate_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'rotatable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.rotate_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.start_rotatable">
<span class="sig-name descname"><span class="pre">start_rotatable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.start_rotatable" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.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/full_systems/evscaperoom/objects.html#Rotatable.at_object_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_object_creation" title="Link to this definition"></a></dt>
<dd><p>Called once when object is first created.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_focus_rotate">
<span class="sig-name descname"><span class="pre">at_focus_rotate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Rotatable.at_focus_rotate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_focus_rotate" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_focus_turn">
<span class="sig-name descname"><span class="pre">at_focus_turn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_focus_turn" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_rotate">
<span class="sig-name descname"><span class="pre">at_rotate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Rotatable.at_rotate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_rotate" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_cannot_rotate">
<span class="sig-name descname"><span class="pre">at_cannot_rotate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Rotatable.at_cannot_rotate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_cannot_rotate" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.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.full_systems.evscaperoom.objects.Rotatable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Rotatable.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.full_systems.evscaperoom.objects.Rotatable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Rotatable.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.full_systems.evscaperoom.objects.Rotatable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Rotatable.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">'Rotatable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.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.full_systems.evscaperoom.objects.Openable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Openable</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/full_systems/evscaperoom/objects.html#Openable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object that you can open/close. It’s lockable with
a flag.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.unlock_flag">
<span class="sig-name descname"><span class="pre">unlock_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'unlocked'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.unlock_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.open_flag">
<span class="sig-name descname"><span class="pre">open_flag</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.full_systems.evscaperoom.objects.Openable.open_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.start_open">
<span class="sig-name descname"><span class="pre">start_open</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.start_open" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.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/full_systems/evscaperoom/objects.html#Openable.at_object_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_object_creation" title="Link to this definition"></a></dt>
<dd><p>Called once when object is first created.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.at_focus_open">
<span class="sig-name descname"><span class="pre">at_focus_open</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Openable.at_focus_open"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_focus_open" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.at_focus_close">
<span class="sig-name descname"><span class="pre">at_focus_close</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Openable.at_focus_close"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_focus_close" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.at_open">
<span class="sig-name descname"><span class="pre">at_open</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Openable.at_open"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_open" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.at_already_open">
<span class="sig-name descname"><span class="pre">at_already_open</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Openable.at_already_open"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_already_open" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.at_locked">
<span class="sig-name descname"><span class="pre">at_locked</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Openable.at_locked"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_locked" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.at_close">
<span class="sig-name descname"><span class="pre">at_close</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Openable.at_close"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_close" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.at_already_closed">
<span class="sig-name descname"><span class="pre">at_already_closed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Openable.at_already_closed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_already_closed" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.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.full_systems.evscaperoom.objects.Openable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Openable.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.full_systems.evscaperoom.objects.Openable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Openable.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.full_systems.evscaperoom.objects.Openable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Openable.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">'Openable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.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.full_systems.evscaperoom.objects.Readable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Readable</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/full_systems/evscaperoom/objects.html#Readable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object that you can read from. This is controlled
from a flag.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Readable.read_flag">
<span class="sig-name descname"><span class="pre">read_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'readable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.read_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Readable.start_readable">
<span class="sig-name descname"><span class="pre">start_readable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.start_readable" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Readable.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/full_systems/evscaperoom/objects.html#Readable.at_object_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.at_object_creation" title="Link to this definition"></a></dt>
<dd><p>Called once when object is first created.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Readable.at_focus_read">
<span class="sig-name descname"><span class="pre">at_focus_read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Readable.at_focus_read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.at_focus_read" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Readable.at_read">
<span class="sig-name descname"><span class="pre">at_read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <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/full_systems/evscaperoom/objects.html#Readable.at_read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.at_read" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Readable.at_cannot_read">
<span class="sig-name descname"><span class="pre">at_cannot_read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <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/full_systems/evscaperoom/objects.html#Readable.at_cannot_read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.at_cannot_read" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Readable.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.full_systems.evscaperoom.objects.Readable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Readable.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.full_systems.evscaperoom.objects.Readable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Readable.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.full_systems.evscaperoom.objects.Readable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Readable.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">'Readable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.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.full_systems.evscaperoom.objects.IndexReadable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">IndexReadable</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/full_systems/evscaperoom/objects.html#IndexReadable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable" title="evennia.contrib.full_systems.evscaperoom.objects.Readable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Readable</span></code></a></p>
<p>Any object for which you need to specify a key/index to get a given result
back. For example a lexicon or book where you enter a topic or a page
number to see what’s to be read on that page.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.index">
<span class="sig-name descname"><span class="pre">index</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'page</span> <span class="pre">two':</span> <span class="pre">'page2',</span> <span class="pre">'page1':</span> <span class="pre">'This</span> <span class="pre">is</span> <span class="pre">page1',</span> <span class="pre">'page2':</span> <span class="pre">'This</span> <span class="pre">is</span> <span class="pre">page2'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.index" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_focus_read">
<span class="sig-name descname"><span class="pre">at_focus_read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#IndexReadable.at_focus_read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_focus_read" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.get_cmd_signatures">
<span class="sig-name descname"><span class="pre">get_cmd_signatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#IndexReadable.get_cmd_signatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.get_cmd_signatures" title="Link to this definition"></a></dt>
<dd><p>This allows the object to return more detailed call signs
for each of their at_focus_* methods. This is useful for
things like detailed arguments (only ‘move’ but ‘move left/right’)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>callsigns (list, None)</em> –</p>
<dl class="simple">
<dt>List of strings to inject into the</dt><dd><p>available action list produced by <strong>self.get_help</strong>. If <strong>None</strong>,
automatically find actions based on the method names.</p>
</dd>
<dt>custom_helpstr (str): This should be the help text for</dt><dd><p>the command with a marker <strong>{callsigns}</strong> for where to
inject the list of callsigns.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_cannot_read">
<span class="sig-name descname"><span class="pre">at_cannot_read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <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/full_systems/evscaperoom/objects.html#IndexReadable.at_cannot_read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_cannot_read" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_read">
<span class="sig-name descname"><span class="pre">at_read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entry</span></span></em>, <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/full_systems/evscaperoom/objects.html#IndexReadable.at_read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_read" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.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.full_systems.evscaperoom.objects.IndexReadable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.Readable.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.full_systems.evscaperoom.objects.IndexReadable.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.full_systems.evscaperoom.objects.IndexReadable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.Readable.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.full_systems.evscaperoom.objects.IndexReadable.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.full_systems.evscaperoom.objects.IndexReadable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.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">'IndexReadable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.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.full_systems.evscaperoom.objects.Movable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Movable</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/full_systems/evscaperoom/objects.html#Movable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object that can be moved from one place to another
or in one direction or another.</p>
<p>Once moved to a given position, the object’s state will
change.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.move_positions">
<span class="sig-name descname"><span class="pre">move_positions</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'left':</span> <span class="pre">'at_left',</span> <span class="pre">'right':</span> <span class="pre">'at_right'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.move_positions" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.start_position">
<span class="sig-name descname"><span class="pre">start_position</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'left'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.start_position" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.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/full_systems/evscaperoom/objects.html#Movable.at_object_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_object_creation" title="Link to this definition"></a></dt>
<dd><p>Called once when object is first created.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.get_cmd_signatures">
<span class="sig-name descname"><span class="pre">get_cmd_signatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Movable.get_cmd_signatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.get_cmd_signatures" title="Link to this definition"></a></dt>
<dd><p>This allows the object to return more detailed call signs
for each of their at_focus_* methods. This is useful for
things like detailed arguments (only ‘move’ but ‘move left/right’)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>callsigns (list, None)</em> –</p>
<dl class="simple">
<dt>List of strings to inject into the</dt><dd><p>available action list produced by <strong>self.get_help</strong>. If <strong>None</strong>,
automatically find actions based on the method names.</p>
</dd>
<dt>custom_helpstr (str): This should be the help text for</dt><dd><p>the command with a marker <strong>{callsigns}</strong> for where to
inject the list of callsigns.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_move">
<span class="sig-name descname"><span class="pre">at_focus_move</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Movable.at_focus_move"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_move" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_shove">
<span class="sig-name descname"><span class="pre">at_focus_shove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_shove" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_push">
<span class="sig-name descname"><span class="pre">at_focus_push</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_push" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.at_cannot_move">
<span class="sig-name descname"><span class="pre">at_cannot_move</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Movable.at_cannot_move"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_cannot_move" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.at_already_moved">
<span class="sig-name descname"><span class="pre">at_already_moved</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">position</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Movable.at_already_moved"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_already_moved" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.at_left">
<span class="sig-name descname"><span class="pre">at_left</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Movable.at_left"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_left" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.at_right">
<span class="sig-name descname"><span class="pre">at_right</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Movable.at_right"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_right" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.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.full_systems.evscaperoom.objects.Movable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Movable.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.full_systems.evscaperoom.objects.Movable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Movable.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.full_systems.evscaperoom.objects.Movable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Movable.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">'Movable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.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.full_systems.evscaperoom.objects.BaseConsumable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">BaseConsumable</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/full_systems/evscaperoom/objects.html#BaseConsumable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object that is consumable in some way. This acts as an
abstract parent.</p>
<p>This sets a flag that
is unique for each person consuming, allowing it to e.g. only
be consumed once (don’t support multi-uses here, that’s left for
a custom object if needed).</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.consume_flag">
<span class="sig-name descname"><span class="pre">consume_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'consume'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.consume_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.one_consume_only">
<span class="sig-name descname"><span class="pre">one_consume_only</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.one_consume_only" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.handle_consume">
<span class="sig-name descname"><span class="pre">handle_consume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</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/full_systems/evscaperoom/objects.html#BaseConsumable.handle_consume"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.handle_consume" title="Link to this definition"></a></dt>
<dd><p>Wrap this by the at_focus method</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.has_consumed">
<span class="sig-name descname"><span class="pre">has_consumed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">setflag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#BaseConsumable.has_consumed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.has_consumed" title="Link to this definition"></a></dt>
<dd><p>Check if caller already consumed at least once</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.at_consume">
<span class="sig-name descname"><span class="pre">at_consume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#BaseConsumable.at_consume"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.at_consume" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.at_already_consumed">
<span class="sig-name descname"><span class="pre">at_already_consumed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#BaseConsumable.at_already_consumed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.at_already_consumed" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.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.full_systems.evscaperoom.objects.BaseConsumable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.BaseConsumable.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.full_systems.evscaperoom.objects.BaseConsumable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.BaseConsumable.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.full_systems.evscaperoom.objects.BaseConsumable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.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">'BaseConsumable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.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.full_systems.evscaperoom.objects.Edible">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Edible</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/full_systems/evscaperoom/objects.html#Edible"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable" title="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseConsumable</span></code></a></p>
<p>Any object specifically possible to eat.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Edible.consume_flag">
<span class="sig-name descname"><span class="pre">consume_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'eat'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.consume_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Edible.at_focus_eat">
<span class="sig-name descname"><span class="pre">at_focus_eat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Edible.at_focus_eat"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.at_focus_eat" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Edible.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.full_systems.evscaperoom.objects.Edible.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.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.full_systems.evscaperoom.objects.Edible.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.full_systems.evscaperoom.objects.Edible.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.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.full_systems.evscaperoom.objects.Edible.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.full_systems.evscaperoom.objects.Edible'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Edible.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">'Edible'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.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.full_systems.evscaperoom.objects.Drinkable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Drinkable</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/full_systems/evscaperoom/objects.html#Drinkable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable" title="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseConsumable</span></code></a></p>
<p>Any object specifically possible to drink.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Drinkable.consume_flag">
<span class="sig-name descname"><span class="pre">consume_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'drink'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.consume_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_focus_drink">
<span class="sig-name descname"><span class="pre">at_focus_drink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Drinkable.at_focus_drink"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_focus_drink" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_focus_sip">
<span class="sig-name descname"><span class="pre">at_focus_sip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Drinkable.at_focus_sip"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_focus_sip" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_consume">
<span class="sig-name descname"><span class="pre">at_consume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Drinkable.at_consume"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_consume" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_already_consumed">
<span class="sig-name descname"><span class="pre">at_already_consumed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Drinkable.at_already_consumed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_already_consumed" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Drinkable.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.full_systems.evscaperoom.objects.Drinkable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.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.full_systems.evscaperoom.objects.Drinkable.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.full_systems.evscaperoom.objects.Drinkable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.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.full_systems.evscaperoom.objects.Drinkable.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.full_systems.evscaperoom.objects.Drinkable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Drinkable.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">'Drinkable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.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.full_systems.evscaperoom.objects.BaseApplicable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">BaseApplicable</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/full_systems/evscaperoom/objects.html#BaseApplicable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object that can be applied/inserted/used on another object in some way.
This acts an an abstract base class.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.target_flag">
<span class="sig-name descname"><span class="pre">target_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'applicable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.target_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.handle_apply">
<span class="sig-name descname"><span class="pre">handle_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</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/full_systems/evscaperoom/objects.html#BaseApplicable.handle_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.handle_apply" title="Link to this definition"></a></dt>
<dd><p>Wrap this with the at_focus methods in the child classes</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.at_apply">
<span class="sig-name descname"><span class="pre">at_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#BaseApplicable.at_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.at_apply" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.at_cannot_apply">
<span class="sig-name descname"><span class="pre">at_cannot_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#BaseApplicable.at_cannot_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.at_cannot_apply" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.BaseApplicable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.BaseApplicable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.BaseApplicable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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">'BaseApplicable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.Usable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Usable</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/full_systems/evscaperoom/objects.html#Usable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApplicable</span></code></a></p>
<p>Any object that can be used with another object.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Usable.target_flag">
<span class="sig-name descname"><span class="pre">target_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'usable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.target_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Usable.at_focus_use">
<span class="sig-name descname"><span class="pre">at_focus_use</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Usable.at_focus_use"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.at_focus_use" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Usable.at_apply">
<span class="sig-name descname"><span class="pre">at_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Usable.at_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.at_apply" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Usable.at_cannot_apply">
<span class="sig-name descname"><span class="pre">at_cannot_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Usable.at_cannot_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.at_cannot_apply" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Usable.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.full_systems.evscaperoom.objects.Usable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.Usable.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.full_systems.evscaperoom.objects.Usable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.Usable.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.full_systems.evscaperoom.objects.Usable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Usable.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">'Usable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.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.full_systems.evscaperoom.objects.Insertable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Insertable</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/full_systems/evscaperoom/objects.html#Insertable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApplicable</span></code></a></p>
<p>Any object that can be inserted into another object.</p>
<p>This would cover a key, for example.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Insertable.target_flag">
<span class="sig-name descname"><span class="pre">target_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'insertable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.target_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_focus_insert">
<span class="sig-name descname"><span class="pre">at_focus_insert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Insertable.at_focus_insert"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_focus_insert" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_apply">
<span class="sig-name descname"><span class="pre">at_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Insertable.at_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_apply" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Insertable.get_cmd_signatures">
<span class="sig-name descname"><span class="pre">get_cmd_signatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Insertable.get_cmd_signatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.get_cmd_signatures" title="Link to this definition"></a></dt>
<dd><p>This allows the object to return more detailed call signs
for each of their at_focus_* methods. This is useful for
things like detailed arguments (only ‘move’ but ‘move left/right’)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>callsigns (list, None)</em> –</p>
<dl class="simple">
<dt>List of strings to inject into the</dt><dd><p>available action list produced by <strong>self.get_help</strong>. If <strong>None</strong>,
automatically find actions based on the method names.</p>
</dd>
<dt>custom_helpstr (str): This should be the help text for</dt><dd><p>the command with a marker <strong>{callsigns}</strong> for where to
inject the list of callsigns.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_cannot_apply">
<span class="sig-name descname"><span class="pre">at_cannot_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Insertable.at_cannot_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_cannot_apply" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Insertable.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.full_systems.evscaperoom.objects.Insertable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.Insertable.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.full_systems.evscaperoom.objects.Insertable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.Insertable.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.full_systems.evscaperoom.objects.Insertable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Insertable.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">'Insertable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.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.full_systems.evscaperoom.objects.Combinable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Combinable</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/full_systems/evscaperoom/objects.html#Combinable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApplicable</span></code></a></p>
<p>Any object that combines with another object to create
a new one.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.target_flag">
<span class="sig-name descname"><span class="pre">target_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'combinable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.target_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.new_create_dict">
<span class="sig-name descname"><span class="pre">new_create_dict</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">['combined'],</span> <span class="pre">'key':</span> <span class="pre">'sword',</span> <span class="pre">'typeclass':</span> <span class="pre">'evscaperoom.objects.Combinable'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.new_create_dict" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.destroy_components">
<span class="sig-name descname"><span class="pre">destroy_components</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.destroy_components" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_focus_combine">
<span class="sig-name descname"><span class="pre">at_focus_combine</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Combinable.at_focus_combine"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_focus_combine" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.get_cmd_signatures">
<span class="sig-name descname"><span class="pre">get_cmd_signatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Combinable.get_cmd_signatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.get_cmd_signatures" title="Link to this definition"></a></dt>
<dd><p>This allows the object to return more detailed call signs
for each of their at_focus_* methods. This is useful for
things like detailed arguments (only ‘move’ but ‘move left/right’)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>callsigns (list, None)</em> –</p>
<dl class="simple">
<dt>List of strings to inject into the</dt><dd><p>available action list produced by <strong>self.get_help</strong>. If <strong>None</strong>,
automatically find actions based on the method names.</p>
</dd>
<dt>custom_helpstr (str): This should be the help text for</dt><dd><p>the command with a marker <strong>{callsigns}</strong> for where to
inject the list of callsigns.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_cannot_apply">
<span class="sig-name descname"><span class="pre">at_cannot_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Combinable.at_cannot_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_cannot_apply" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_apply">
<span class="sig-name descname"><span class="pre">at_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">other_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Combinable.at_apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_apply" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.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.full_systems.evscaperoom.objects.Combinable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.Combinable.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.full_systems.evscaperoom.objects.Combinable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.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.full_systems.evscaperoom.objects.Combinable.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.full_systems.evscaperoom.objects.Combinable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Combinable.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">'Combinable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.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.full_systems.evscaperoom.objects.Mixable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Mixable</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/full_systems/evscaperoom/objects.html#Mixable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object into which you can mix ingredients (such as when
mixing a potion). This offers no actions on its own, instead
the ingredients should be ‘used’ with this object in order
mix, calling at_mix when they do.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.mixer_flag">
<span class="sig-name descname"><span class="pre">mixer_flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mixer'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.mixer_flag" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.ingredient_recipe">
<span class="sig-name descname"><span class="pre">ingredient_recipe</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['ingredient1',</span> <span class="pre">'ingredient2',</span> <span class="pre">'ingredient3']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.ingredient_recipe" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.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/full_systems/evscaperoom/objects.html#Mixable.at_object_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_object_creation" title="Link to this definition"></a></dt>
<dd><p>Called once when object is first created.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.check_mixture">
<span class="sig-name descname"><span class="pre">check_mixture</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Mixable.check_mixture"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.check_mixture" title="Link to this definition"></a></dt>
<dd><p>check so mixture is correct, returning True/False.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.handle_mix">
<span class="sig-name descname"><span class="pre">handle_mix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingredient</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/full_systems/evscaperoom/objects.html#Mixable.handle_mix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.handle_mix" title="Link to this definition"></a></dt>
<dd><p>Add ingredient object to mixture.</p>
<p>Called by the mixing ingredient. We assume the ingredient has already
checked to make sure they allow themselves to be mixed into an object
with this mixer_flag.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix">
<span class="sig-name descname"><span class="pre">at_mix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingredient</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/full_systems/evscaperoom/objects.html#Mixable.at_mix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix_failure">
<span class="sig-name descname"><span class="pre">at_mix_failure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingredient</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/full_systems/evscaperoom/objects.html#Mixable.at_mix_failure"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix_failure" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix_success">
<span class="sig-name descname"><span class="pre">at_mix_success</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingredient</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/full_systems/evscaperoom/objects.html#Mixable.at_mix_success"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix_success" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.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.full_systems.evscaperoom.objects.Mixable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Mixable.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.full_systems.evscaperoom.objects.Mixable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.Mixable.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.full_systems.evscaperoom.objects.Mixable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Mixable.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">'Mixable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.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.full_systems.evscaperoom.objects.HasButtons">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">HasButtons</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/full_systems/evscaperoom/objects.html#HasButtons"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object with buttons to push/press</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.buttons">
<span class="sig-name descname"><span class="pre">buttons</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'green':</span> <span class="pre">'at_green_button',</span> <span class="pre">'green</span> <span class="pre">button':</span> <span class="pre">'at_green_button',</span> <span class="pre">'red':</span> <span class="pre">'at_red_button',</span> <span class="pre">'red</span> <span class="pre">button':</span> <span class="pre">'at_red_button'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.buttons" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.get_cmd_signatures">
<span class="sig-name descname"><span class="pre">get_cmd_signatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#HasButtons.get_cmd_signatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.get_cmd_signatures" title="Link to this definition"></a></dt>
<dd><p>This allows the object to return more detailed call signs
for each of their at_focus_* methods. This is useful for
things like detailed arguments (only ‘move’ but ‘move left/right’)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>callsigns (list, None)</em> –</p>
<dl class="simple">
<dt>List of strings to inject into the</dt><dd><p>available action list produced by <strong>self.get_help</strong>. If <strong>None</strong>,
automatically find actions based on the method names.</p>
</dd>
<dt>custom_helpstr (str): This should be the help text for</dt><dd><p>the command with a marker <strong>{callsigns}</strong> for where to
inject the list of callsigns.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_focus_press">
<span class="sig-name descname"><span class="pre">at_focus_press</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#HasButtons.at_focus_press"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_focus_press" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_focus_push">
<span class="sig-name descname"><span class="pre">at_focus_push</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_focus_push" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_nomatch">
<span class="sig-name descname"><span class="pre">at_nomatch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#HasButtons.at_nomatch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_nomatch" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_green_button">
<span class="sig-name descname"><span class="pre">at_green_button</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#HasButtons.at_green_button"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_green_button" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_red_button">
<span class="sig-name descname"><span class="pre">at_red_button</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#HasButtons.at_red_button"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_red_button" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.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.full_systems.evscaperoom.objects.HasButtons.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.HasButtons.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.full_systems.evscaperoom.objects.HasButtons.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.HasButtons.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.full_systems.evscaperoom.objects.HasButtons'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.HasButtons.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">'HasButtons'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.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.full_systems.evscaperoom.objects.CodeInput">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">CodeInput</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/full_systems/evscaperoom/objects.html#CodeInput"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object where you can enter a code of some sort
to have an effect happen.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.code">
<span class="sig-name descname"><span class="pre">code</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PASSWORD'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.code" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.code_hint">
<span class="sig-name descname"><span class="pre">code_hint</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'eight</span> <span class="pre">letters</span> <span class="pre">A-Z'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.code_hint" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.case_insensitive">
<span class="sig-name descname"><span class="pre">case_insensitive</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.case_insensitive" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.infinitely_locked">
<span class="sig-name descname"><span class="pre">infinitely_locked</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.infinitely_locked" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_focus_code">
<span class="sig-name descname"><span class="pre">at_focus_code</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#CodeInput.at_focus_code"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_focus_code" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.get_cmd_signatures">
<span class="sig-name descname"><span class="pre">get_cmd_signatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#CodeInput.get_cmd_signatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.get_cmd_signatures" title="Link to this definition"></a></dt>
<dd><p>This allows the object to return more detailed call signs
for each of their at_focus_* methods. This is useful for
things like detailed arguments (only ‘move’ but ‘move left/right’)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>callsigns (list, None)</em> –</p>
<dl class="simple">
<dt>List of strings to inject into the</dt><dd><p>available action list produced by <strong>self.get_help</strong>. If <strong>None</strong>,
automatically find actions based on the method names.</p>
</dd>
<dt>custom_helpstr (str): This should be the help text for</dt><dd><p>the command with a marker <strong>{callsigns}</strong> for where to
inject the list of callsigns.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_no_code">
<span class="sig-name descname"><span class="pre">at_no_code</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#CodeInput.at_no_code"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_no_code" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_code_correct">
<span class="sig-name descname"><span class="pre">at_code_correct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code_tried</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#CodeInput.at_code_correct"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_code_correct" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_code_incorrect">
<span class="sig-name descname"><span class="pre">at_code_incorrect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code_tried</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#CodeInput.at_code_incorrect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_code_incorrect" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.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.full_systems.evscaperoom.objects.CodeInput.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.CodeInput.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.full_systems.evscaperoom.objects.CodeInput.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.CodeInput.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.full_systems.evscaperoom.objects.CodeInput'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.CodeInput.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">'CodeInput'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.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.full_systems.evscaperoom.objects.BasePositionable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">BasePositionable</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/full_systems/evscaperoom/objects.html#BasePositionable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a></p>
<p>Any object a character can be positioned on. This is meant as an
abstract parent.</p>
<p>This is a little special since a char can only have one position at a
time and must therefore be aware of the other ‘positional’ actions
any object may support (otherwise you may end up sitting/standing/etc on
more than one object at once!)</p>
<p>We set a Attribute (obj, position) on the caller to indicate that
they have a position on an object. This is necessary so as to not have
the caller sit on more than one sittable object at a time, for example. The
‘positions’ Attribute on this object holds a mapping of who is sitting
lying etc on this object. We don’t add a limit to how many chars could
have a position on an object - it’s not realistic, but this goes with the
philosophy that one character should not be able to block others if they go
inactive etc.</p>
<p>This state is also tied to the general ‘stand’ command, which should return
the player to the normal standing state regardless of if they focus on this
object or not.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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/full_systems/evscaperoom/objects.html#BasePositionable.at_object_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_object_creation" title="Link to this definition"></a></dt>
<dd><p>Called once when object is first created.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.handle_position">
<span class="sig-name descname"><span class="pre">handle_position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_pos</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/full_systems/evscaperoom/objects.html#BasePositionable.handle_position"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.handle_position" title="Link to this definition"></a></dt>
<dd><p>Wrap this with the <a href="#id1"><span class="problematic" id="id2">at_focus_</span></a> method of the child class.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_cannot_position">
<span class="sig-name descname"><span class="pre">at_cannot_position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">position</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">old_obj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">old_pos</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#BasePositionable.at_cannot_position"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_cannot_position" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_again_position">
<span class="sig-name descname"><span class="pre">at_again_position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">position</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#BasePositionable.at_again_position"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_again_position" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_position">
<span class="sig-name descname"><span class="pre">at_position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">position</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#BasePositionable.at_position"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_position" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.BasePositionable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.BasePositionable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.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.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.BasePositionable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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">'BasePositionable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Sittable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Sittable</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/full_systems/evscaperoom/objects.html#Sittable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BasePositionable</span></code></a></p>
<p>Any object you can sit on.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Sittable.at_focus_sit">
<span class="sig-name descname"><span class="pre">at_focus_sit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Sittable.at_focus_sit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.at_focus_sit" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Sittable.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.full_systems.evscaperoom.objects.Sittable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Sittable.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.full_systems.evscaperoom.objects.Sittable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Sittable.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.full_systems.evscaperoom.objects.Sittable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Sittable.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">'Sittable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.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.full_systems.evscaperoom.objects.Liable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Liable</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/full_systems/evscaperoom/objects.html#Liable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BasePositionable</span></code></a></p>
<p>Any object you can lie down on.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Liable.at_focus_lie">
<span class="sig-name descname"><span class="pre">at_focus_lie</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Liable.at_focus_lie"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.at_focus_lie" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Liable.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.full_systems.evscaperoom.objects.Liable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Liable.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.full_systems.evscaperoom.objects.Liable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Liable.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.full_systems.evscaperoom.objects.Liable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Liable.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">'Liable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.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.full_systems.evscaperoom.objects.Kneelable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Kneelable</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/full_systems/evscaperoom/objects.html#Kneelable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BasePositionable</span></code></a></p>
<p>Any object you can kneel on.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Kneelable.at_focus_kneel">
<span class="sig-name descname"><span class="pre">at_focus_kneel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Kneelable.at_focus_kneel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.at_focus_kneel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Kneelable.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.full_systems.evscaperoom.objects.Kneelable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Kneelable.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.full_systems.evscaperoom.objects.Kneelable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Kneelable.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.full_systems.evscaperoom.objects.Kneelable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Kneelable.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">'Kneelable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.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.full_systems.evscaperoom.objects.Climbable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Climbable</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/full_systems/evscaperoom/objects.html#Climbable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable"><code class="xref py py-class docutils literal notranslate"><span class="pre">BasePositionable</span></code></a></p>
<p>Any object you can climb up to stand on. We name this
‘climb’ so as to not collide with the general ‘stand’
command, which resets your position.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Climbable.at_focus_climb">
<span class="sig-name descname"><span class="pre">at_focus_climb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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/full_systems/evscaperoom/objects.html#Climbable.at_focus_climb"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.at_focus_climb" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Climbable.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.full_systems.evscaperoom.objects.Climbable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Climbable.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.full_systems.evscaperoom.objects.Climbable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.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.full_systems.evscaperoom.objects.Climbable.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.full_systems.evscaperoom.objects.Climbable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Climbable.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">'Climbable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.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.full_systems.evscaperoom.objects.Positionable">
<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.full_systems.evscaperoom.objects.</span></span><span class="sig-name descname"><span class="pre">Positionable</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/full_systems/evscaperoom/objects.html#Positionable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable" title="evennia.contrib.full_systems.evscaperoom.objects.Sittable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sittable</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable" title="evennia.contrib.full_systems.evscaperoom.objects.Liable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Liable</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable" title="evennia.contrib.full_systems.evscaperoom.objects.Kneelable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kneelable</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable" title="evennia.contrib.full_systems.evscaperoom.objects.Climbable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Climbable</span></code></a></p>
<p>An object on which you can position yourself in one of the
supported ways (sit, lie, kneel or climb)</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Positionable.get_cmd_signatures">
<span class="sig-name descname"><span class="pre">get_cmd_signatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/objects.html#Positionable.get_cmd_signatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable.get_cmd_signatures" title="Link to this definition"></a></dt>
<dd><p>This allows the object to return more detailed call signs
for each of their at_focus_* methods. This is useful for
things like detailed arguments (only ‘move’ but ‘move left/right’)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>callsigns (list, None)</em> –</p>
<dl class="simple">
<dt>List of strings to inject into the</dt><dd><p>available action list produced by <strong>self.get_help</strong>. If <strong>None</strong>,
automatically find actions based on the method names.</p>
</dd>
<dt>custom_helpstr (str): This should be the help text for</dt><dd><p>the command with a marker <strong>{callsigns}</strong> for where to
inject the list of callsigns.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Positionable.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.full_systems.evscaperoom.objects.Positionable.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.Sittable.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoesNotExist</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.Liable.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoesNotExist</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.Kneelable.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoesNotExist</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.Climbable.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.full_systems.evscaperoom.objects.Positionable.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.full_systems.evscaperoom.objects.Positionable.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.Sittable.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.Liable.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.Kneelable.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a>, <a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.Climbable.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.full_systems.evscaperoom.objects.Positionable.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.full_systems.evscaperoom.objects.Positionable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.objects.Positionable.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">'Positionable'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable.typename" 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.full_systems.evscaperoom.objects</a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.action_prepositions"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.action_prepositions</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.position_prep_map"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.position_prep_map</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_object_creation"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.at_object_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.tagcategory"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.tagcategory</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.room"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.room</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.roomstate"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.roomstate</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.next_state"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.next_state()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_flag"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.set_flag()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.unset_flag"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.unset_flag()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.check_flag"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.check_flag()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_character_flag"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.set_character_flag()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.unset_character_flag"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.unset_character_flag()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.check_character_flag"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.check_character_flag()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_room"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.msg_room()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_char"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.msg_char()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.msg_system"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.msg_system()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_position"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.get_position()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.set_position"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.set_position()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_focus"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.at_focus()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_unfocus"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.at_unfocus()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.at_speech"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.at_speech()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.parse"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.parse()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_cmd_signatures"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.get_cmd_signatures()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_short_desc"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.get_short_desc()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.get_help"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.get_help()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.return_appearance"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.return_appearance()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.path"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.typename"><code class="docutils literal notranslate"><span class="pre">EvscaperoomObject.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable"><code class="docutils literal notranslate"><span class="pre">Feelable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable.at_focus_feel"><code class="docutils literal notranslate"><span class="pre">Feelable.at_focus_feel()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Feelable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Feelable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable.path"><code class="docutils literal notranslate"><span class="pre">Feelable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Feelable.typename"><code class="docutils literal notranslate"><span class="pre">Feelable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable"><code class="docutils literal notranslate"><span class="pre">Listenable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable.at_focus_listen"><code class="docutils literal notranslate"><span class="pre">Listenable.at_focus_listen()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Listenable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Listenable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable.path"><code class="docutils literal notranslate"><span class="pre">Listenable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Listenable.typename"><code class="docutils literal notranslate"><span class="pre">Listenable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable"><code class="docutils literal notranslate"><span class="pre">Smellable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable.at_focus_smell"><code class="docutils literal notranslate"><span class="pre">Smellable.at_focus_smell()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Smellable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Smellable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable.path"><code class="docutils literal notranslate"><span class="pre">Smellable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Smellable.typename"><code class="docutils literal notranslate"><span class="pre">Smellable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable"><code class="docutils literal notranslate"><span class="pre">Rotatable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.rotate_flag"><code class="docutils literal notranslate"><span class="pre">Rotatable.rotate_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.start_rotatable"><code class="docutils literal notranslate"><span class="pre">Rotatable.start_rotatable</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_object_creation"><code class="docutils literal notranslate"><span class="pre">Rotatable.at_object_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_focus_rotate"><code class="docutils literal notranslate"><span class="pre">Rotatable.at_focus_rotate()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_focus_turn"><code class="docutils literal notranslate"><span class="pre">Rotatable.at_focus_turn()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_rotate"><code class="docutils literal notranslate"><span class="pre">Rotatable.at_rotate()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.at_cannot_rotate"><code class="docutils literal notranslate"><span class="pre">Rotatable.at_cannot_rotate()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Rotatable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Rotatable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.path"><code class="docutils literal notranslate"><span class="pre">Rotatable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Rotatable.typename"><code class="docutils literal notranslate"><span class="pre">Rotatable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable"><code class="docutils literal notranslate"><span class="pre">Openable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.unlock_flag"><code class="docutils literal notranslate"><span class="pre">Openable.unlock_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.open_flag"><code class="docutils literal notranslate"><span class="pre">Openable.open_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.start_open"><code class="docutils literal notranslate"><span class="pre">Openable.start_open</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_object_creation"><code class="docutils literal notranslate"><span class="pre">Openable.at_object_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_focus_open"><code class="docutils literal notranslate"><span class="pre">Openable.at_focus_open()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_focus_close"><code class="docutils literal notranslate"><span class="pre">Openable.at_focus_close()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_open"><code class="docutils literal notranslate"><span class="pre">Openable.at_open()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_already_open"><code class="docutils literal notranslate"><span class="pre">Openable.at_already_open()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_locked"><code class="docutils literal notranslate"><span class="pre">Openable.at_locked()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_close"><code class="docutils literal notranslate"><span class="pre">Openable.at_close()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.at_already_closed"><code class="docutils literal notranslate"><span class="pre">Openable.at_already_closed()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Openable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Openable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.path"><code class="docutils literal notranslate"><span class="pre">Openable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Openable.typename"><code class="docutils literal notranslate"><span class="pre">Openable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable"><code class="docutils literal notranslate"><span class="pre">Readable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.read_flag"><code class="docutils literal notranslate"><span class="pre">Readable.read_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.start_readable"><code class="docutils literal notranslate"><span class="pre">Readable.start_readable</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.at_object_creation"><code class="docutils literal notranslate"><span class="pre">Readable.at_object_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.at_focus_read"><code class="docutils literal notranslate"><span class="pre">Readable.at_focus_read()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.at_read"><code class="docutils literal notranslate"><span class="pre">Readable.at_read()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.at_cannot_read"><code class="docutils literal notranslate"><span class="pre">Readable.at_cannot_read()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Readable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Readable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.path"><code class="docutils literal notranslate"><span class="pre">Readable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Readable.typename"><code class="docutils literal notranslate"><span class="pre">Readable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable"><code class="docutils literal notranslate"><span class="pre">IndexReadable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.index"><code class="docutils literal notranslate"><span class="pre">IndexReadable.index</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_focus_read"><code class="docutils literal notranslate"><span class="pre">IndexReadable.at_focus_read()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.get_cmd_signatures"><code class="docutils literal notranslate"><span class="pre">IndexReadable.get_cmd_signatures()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_cannot_read"><code class="docutils literal notranslate"><span class="pre">IndexReadable.at_cannot_read()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.at_read"><code class="docutils literal notranslate"><span class="pre">IndexReadable.at_read()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">IndexReadable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">IndexReadable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.path"><code class="docutils literal notranslate"><span class="pre">IndexReadable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.IndexReadable.typename"><code class="docutils literal notranslate"><span class="pre">IndexReadable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable"><code class="docutils literal notranslate"><span class="pre">Movable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.move_positions"><code class="docutils literal notranslate"><span class="pre">Movable.move_positions</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.start_position"><code class="docutils literal notranslate"><span class="pre">Movable.start_position</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_object_creation"><code class="docutils literal notranslate"><span class="pre">Movable.at_object_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.get_cmd_signatures"><code class="docutils literal notranslate"><span class="pre">Movable.get_cmd_signatures()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_move"><code class="docutils literal notranslate"><span class="pre">Movable.at_focus_move()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_shove"><code class="docutils literal notranslate"><span class="pre">Movable.at_focus_shove()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_focus_push"><code class="docutils literal notranslate"><span class="pre">Movable.at_focus_push()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_cannot_move"><code class="docutils literal notranslate"><span class="pre">Movable.at_cannot_move()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_already_moved"><code class="docutils literal notranslate"><span class="pre">Movable.at_already_moved()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_left"><code class="docutils literal notranslate"><span class="pre">Movable.at_left()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.at_right"><code class="docutils literal notranslate"><span class="pre">Movable.at_right()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Movable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Movable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.path"><code class="docutils literal notranslate"><span class="pre">Movable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Movable.typename"><code class="docutils literal notranslate"><span class="pre">Movable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable"><code class="docutils literal notranslate"><span class="pre">BaseConsumable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.consume_flag"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.consume_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.one_consume_only"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.one_consume_only</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.handle_consume"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.handle_consume()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.has_consumed"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.has_consumed()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.at_consume"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.at_consume()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.at_already_consumed"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.at_already_consumed()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.path"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable.typename"><code class="docutils literal notranslate"><span class="pre">BaseConsumable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible"><code class="docutils literal notranslate"><span class="pre">Edible</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.consume_flag"><code class="docutils literal notranslate"><span class="pre">Edible.consume_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.at_focus_eat"><code class="docutils literal notranslate"><span class="pre">Edible.at_focus_eat()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Edible.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Edible.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.path"><code class="docutils literal notranslate"><span class="pre">Edible.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Edible.typename"><code class="docutils literal notranslate"><span class="pre">Edible.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable"><code class="docutils literal notranslate"><span class="pre">Drinkable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.consume_flag"><code class="docutils literal notranslate"><span class="pre">Drinkable.consume_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_focus_drink"><code class="docutils literal notranslate"><span class="pre">Drinkable.at_focus_drink()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_focus_sip"><code class="docutils literal notranslate"><span class="pre">Drinkable.at_focus_sip()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_consume"><code class="docutils literal notranslate"><span class="pre">Drinkable.at_consume()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.at_already_consumed"><code class="docutils literal notranslate"><span class="pre">Drinkable.at_already_consumed()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Drinkable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Drinkable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.path"><code class="docutils literal notranslate"><span class="pre">Drinkable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Drinkable.typename"><code class="docutils literal notranslate"><span class="pre">Drinkable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable"><code class="docutils literal notranslate"><span class="pre">BaseApplicable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.target_flag"><code class="docutils literal notranslate"><span class="pre">BaseApplicable.target_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.handle_apply"><code class="docutils literal notranslate"><span class="pre">BaseApplicable.handle_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.at_apply"><code class="docutils literal notranslate"><span class="pre">BaseApplicable.at_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.at_cannot_apply"><code class="docutils literal notranslate"><span class="pre">BaseApplicable.at_cannot_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">BaseApplicable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">BaseApplicable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.path"><code class="docutils literal notranslate"><span class="pre">BaseApplicable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.typename"><code class="docutils literal notranslate"><span class="pre">BaseApplicable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable"><code class="docutils literal notranslate"><span class="pre">Usable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.target_flag"><code class="docutils literal notranslate"><span class="pre">Usable.target_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.at_focus_use"><code class="docutils literal notranslate"><span class="pre">Usable.at_focus_use()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.at_apply"><code class="docutils literal notranslate"><span class="pre">Usable.at_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.at_cannot_apply"><code class="docutils literal notranslate"><span class="pre">Usable.at_cannot_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Usable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Usable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.path"><code class="docutils literal notranslate"><span class="pre">Usable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Usable.typename"><code class="docutils literal notranslate"><span class="pre">Usable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable"><code class="docutils literal notranslate"><span class="pre">Insertable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.target_flag"><code class="docutils literal notranslate"><span class="pre">Insertable.target_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_focus_insert"><code class="docutils literal notranslate"><span class="pre">Insertable.at_focus_insert()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_apply"><code class="docutils literal notranslate"><span class="pre">Insertable.at_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.get_cmd_signatures"><code class="docutils literal notranslate"><span class="pre">Insertable.get_cmd_signatures()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.at_cannot_apply"><code class="docutils literal notranslate"><span class="pre">Insertable.at_cannot_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Insertable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Insertable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.path"><code class="docutils literal notranslate"><span class="pre">Insertable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Insertable.typename"><code class="docutils literal notranslate"><span class="pre">Insertable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable"><code class="docutils literal notranslate"><span class="pre">Combinable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.target_flag"><code class="docutils literal notranslate"><span class="pre">Combinable.target_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.new_create_dict"><code class="docutils literal notranslate"><span class="pre">Combinable.new_create_dict</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.destroy_components"><code class="docutils literal notranslate"><span class="pre">Combinable.destroy_components</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_focus_combine"><code class="docutils literal notranslate"><span class="pre">Combinable.at_focus_combine()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.get_cmd_signatures"><code class="docutils literal notranslate"><span class="pre">Combinable.get_cmd_signatures()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_cannot_apply"><code class="docutils literal notranslate"><span class="pre">Combinable.at_cannot_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.at_apply"><code class="docutils literal notranslate"><span class="pre">Combinable.at_apply()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Combinable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Combinable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.path"><code class="docutils literal notranslate"><span class="pre">Combinable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Combinable.typename"><code class="docutils literal notranslate"><span class="pre">Combinable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable"><code class="docutils literal notranslate"><span class="pre">Mixable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.mixer_flag"><code class="docutils literal notranslate"><span class="pre">Mixable.mixer_flag</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.ingredient_recipe"><code class="docutils literal notranslate"><span class="pre">Mixable.ingredient_recipe</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_object_creation"><code class="docutils literal notranslate"><span class="pre">Mixable.at_object_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.check_mixture"><code class="docutils literal notranslate"><span class="pre">Mixable.check_mixture()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.handle_mix"><code class="docutils literal notranslate"><span class="pre">Mixable.handle_mix()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix"><code class="docutils literal notranslate"><span class="pre">Mixable.at_mix()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix_failure"><code class="docutils literal notranslate"><span class="pre">Mixable.at_mix_failure()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.at_mix_success"><code class="docutils literal notranslate"><span class="pre">Mixable.at_mix_success()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Mixable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Mixable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.path"><code class="docutils literal notranslate"><span class="pre">Mixable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Mixable.typename"><code class="docutils literal notranslate"><span class="pre">Mixable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons"><code class="docutils literal notranslate"><span class="pre">HasButtons</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.buttons"><code class="docutils literal notranslate"><span class="pre">HasButtons.buttons</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.get_cmd_signatures"><code class="docutils literal notranslate"><span class="pre">HasButtons.get_cmd_signatures()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_focus_press"><code class="docutils literal notranslate"><span class="pre">HasButtons.at_focus_press()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_focus_push"><code class="docutils literal notranslate"><span class="pre">HasButtons.at_focus_push()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_nomatch"><code class="docutils literal notranslate"><span class="pre">HasButtons.at_nomatch()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_green_button"><code class="docutils literal notranslate"><span class="pre">HasButtons.at_green_button()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.at_red_button"><code class="docutils literal notranslate"><span class="pre">HasButtons.at_red_button()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">HasButtons.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">HasButtons.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.path"><code class="docutils literal notranslate"><span class="pre">HasButtons.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.HasButtons.typename"><code class="docutils literal notranslate"><span class="pre">HasButtons.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput"><code class="docutils literal notranslate"><span class="pre">CodeInput</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.code"><code class="docutils literal notranslate"><span class="pre">CodeInput.code</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.code_hint"><code class="docutils literal notranslate"><span class="pre">CodeInput.code_hint</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.case_insensitive"><code class="docutils literal notranslate"><span class="pre">CodeInput.case_insensitive</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.infinitely_locked"><code class="docutils literal notranslate"><span class="pre">CodeInput.infinitely_locked</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_focus_code"><code class="docutils literal notranslate"><span class="pre">CodeInput.at_focus_code()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.get_cmd_signatures"><code class="docutils literal notranslate"><span class="pre">CodeInput.get_cmd_signatures()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_no_code"><code class="docutils literal notranslate"><span class="pre">CodeInput.at_no_code()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_code_correct"><code class="docutils literal notranslate"><span class="pre">CodeInput.at_code_correct()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.at_code_incorrect"><code class="docutils literal notranslate"><span class="pre">CodeInput.at_code_incorrect()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">CodeInput.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">CodeInput.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.path"><code class="docutils literal notranslate"><span class="pre">CodeInput.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.CodeInput.typename"><code class="docutils literal notranslate"><span class="pre">CodeInput.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable"><code class="docutils literal notranslate"><span class="pre">BasePositionable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_object_creation"><code class="docutils literal notranslate"><span class="pre">BasePositionable.at_object_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.handle_position"><code class="docutils literal notranslate"><span class="pre">BasePositionable.handle_position()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_cannot_position"><code class="docutils literal notranslate"><span class="pre">BasePositionable.at_cannot_position()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_again_position"><code class="docutils literal notranslate"><span class="pre">BasePositionable.at_again_position()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.at_position"><code class="docutils literal notranslate"><span class="pre">BasePositionable.at_position()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">BasePositionable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">BasePositionable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.path"><code class="docutils literal notranslate"><span class="pre">BasePositionable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.BasePositionable.typename"><code class="docutils literal notranslate"><span class="pre">BasePositionable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable"><code class="docutils literal notranslate"><span class="pre">Sittable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.at_focus_sit"><code class="docutils literal notranslate"><span class="pre">Sittable.at_focus_sit()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Sittable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Sittable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.path"><code class="docutils literal notranslate"><span class="pre">Sittable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Sittable.typename"><code class="docutils literal notranslate"><span class="pre">Sittable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable"><code class="docutils literal notranslate"><span class="pre">Liable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.at_focus_lie"><code class="docutils literal notranslate"><span class="pre">Liable.at_focus_lie()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Liable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Liable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.path"><code class="docutils literal notranslate"><span class="pre">Liable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Liable.typename"><code class="docutils literal notranslate"><span class="pre">Liable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable"><code class="docutils literal notranslate"><span class="pre">Kneelable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.at_focus_kneel"><code class="docutils literal notranslate"><span class="pre">Kneelable.at_focus_kneel()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Kneelable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Kneelable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.path"><code class="docutils literal notranslate"><span class="pre">Kneelable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Kneelable.typename"><code class="docutils literal notranslate"><span class="pre">Kneelable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable"><code class="docutils literal notranslate"><span class="pre">Climbable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.at_focus_climb"><code class="docutils literal notranslate"><span class="pre">Climbable.at_focus_climb()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Climbable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Climbable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.path"><code class="docutils literal notranslate"><span class="pre">Climbable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Climbable.typename"><code class="docutils literal notranslate"><span class="pre">Climbable.typename</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable"><code class="docutils literal notranslate"><span class="pre">Positionable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable.get_cmd_signatures"><code class="docutils literal notranslate"><span class="pre">Positionable.get_cmd_signatures()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Positionable.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Positionable.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable.path"><code class="docutils literal notranslate"><span class="pre">Positionable.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.objects.Positionable.typename"><code class="docutils literal notranslate"><span class="pre">Positionable.typename</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.full_systems.evscaperoom.menu.html"
title="previous chapter">evennia.contrib.full_systems.evscaperoom.menu</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.full_systems.evscaperoom.room.html"
title="next chapter">evennia.contrib.full_systems.evscaperoom.room</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.full_systems.evscaperoom.objects.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.full_systems.evscaperoom.room.html" title="evennia.contrib.full_systems.evscaperoom.room"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.full_systems.evscaperoom.menu.html" title="evennia.contrib.full_systems.evscaperoom.menu"
>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.full_systems.html" >evennia.contrib.full_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.full_systems.evscaperoom.html" >evennia.contrib.full_systems.evscaperoom</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.objects</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