Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-18 06:09:06 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
evennia/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.room.html

332 lines
28 KiB
HTML
Raw Normal View History

Updated HTML docs
2020-11-28 23:23:09 +01:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
Updated HTML docs
2021-05-16 00:06:01 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Updated HTML docs
2022-01-08 16:38:41 +01:00
<title>evennia.contrib.full_systems.evscaperoom.room &#8212; Evennia 1.0-dev documentation</title>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
Updated HTML docs
2022-02-06 18:34:09 +00:00
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.contrib.full_systems.evscaperoom.scripts" href="evennia.contrib.full_systems.evscaperoom.scripts.html" />
<link rel="prev" title="evennia.contrib.full_systems.evscaperoom.objects" href="evennia.contrib.full_systems.evscaperoom.objects.html" />
Updated HTML docs
2020-11-28 23:23:09 +01:00
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<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>
Updated HTML docs
2022-02-06 18:34:09 +00:00
<li class="right" >
<a href="evennia.contrib.full_systems.evscaperoom.scripts.html" title="evennia.contrib.full_systems.evscaperoom.scripts"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.full_systems.evscaperoom.objects.html" title="evennia.contrib.full_systems.evscaperoom.objects"
accesskey="P">previous</a> |</li>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
Updated HTML docs
2022-02-06 18:34:09 +00:00
<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>
Updated HTML docs
2022-01-08 16:38:41 +01:00
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.room</a></li>
Updated HTML docs
2020-11-28 23:23:09 +01:00
</ul>
Updated HTML docs
2021-06-23 18:58:26 +02:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-11-28 23:23:09 +01:00
</div>
<div class="document">
Updated HTML docs
2022-10-23 09:04:07 +00:00
Updated HTML docs
2020-11-28 23:23:09 +01:00
<div class="documentwrapper">
Updated HTML docs
2022-10-23 09:04:07 +00:00
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div 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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.full_systems.evscaperoom.objects.html"
title="previous chapter">evennia.contrib.full_systems.evscaperoom.objects</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.full_systems.evscaperoom.scripts.html"
title="next chapter">evennia.contrib.full_systems.evscaperoom.scripts</a></p>
<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.room.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/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>Versions</h3>
<ul>
<li><a href="evennia.contrib.full_systems.evscaperoom.room.html">1.0-dev (develop branch)</a></li>
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<div class="bodywrapper">
<div class="body" role="main">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<section id="module-evennia.contrib.full_systems.evscaperoom.room">
<span id="evennia-contrib-full-systems-evscaperoom-room"></span><h1>evennia.contrib.full_systems.evscaperoom.room<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.room" title="Permalink to this headline"></a></h1>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<p>Room class and mechanics for the Evscaperoom.</p>
<p>This is a special room class that not only depicts the evscaperoom itself, it
also acts as a central store for the room state, score etc. When deleting this,
that particular escaperoom challenge should be gone.</p>
<dl class="py class">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.room.</code><code class="sig-name descname">EvscapeRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html#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">evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom" title="evennia.objects.objects.DefaultRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom</span></code></a></p>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<p>The room to escape from.</p>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_creation">
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_creation" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Called once, when the room is first created.</p>
</dd></dl>
<dl class="py attribute">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.statehandler">
<code class="sig-name descname">statehandler</code><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.statehandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.statehandler" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd></dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.state">
<em class="property">property </em><code class="sig-name descname">state</code><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.state" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd></dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.log">
<code class="sig-name descname">log</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.log" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Log to a file specificially for this room.</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.score">
<code class="sig-name descname">score</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">new_score</span></em>, <em class="sig-param"><span class="n">reason</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.score"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.score" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>We don’t score individually but for everyone in room together.
You can only be scored for a given reason once.</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.progress">
<code class="sig-name descname">progress</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">new_progress</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.progress" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Progress is what we set it to be (0-100%)</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.achievement">
<code class="sig-name descname">achievement</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">achievement</span></em>, <em class="sig-param"><span class="n">subtext</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.achievement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.achievement" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Give the caller a personal achievment. You will only
ever get one of the same type</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>caller</strong> (<em>Object</em>) – The receiver of the achievement.</p></li>
<li><p><strong>achievement</strong> (<em>str</em>) – The title/name of the achievement.</p></li>
<li><p><strong>subtext</strong> (<em>str</em><em>, </em><em>optional</em>) – Eventual subtext/explanation
of the achievement.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.get_all_characters">
<code class="sig-name descname">get_all_characters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.get_all_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.get_all_characters" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Get the player characters in the room.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>chars (Queryset)</em> – The characters.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.set_flag">
<code class="sig-name descname">set_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.set_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.set_flag" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Set flag on object</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.unset_flag">
<code class="sig-name descname">unset_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.unset_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.unset_flag" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Unset flag on object</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.check_flag">
<code class="sig-name descname">check_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.check_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.check_flag" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Check if flag is set on this object</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.check_perm">
<code class="sig-name descname">check_perm</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">permission</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.check_perm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.check_perm" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd></dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_character">
<code class="sig-name descname">tag_character</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">tag</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.tag_character"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_character" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Tag a given character in this room.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>character</strong> (<em>Character</em>) – Player character to tag.</p></li>
<li><p><strong>tag</strong> (<em>str</em>) – Tag to set.</p></li>
<li><p><strong>category</strong> (<em>str</em><em>, </em><em>optional</em>) – Tag-category. If unset, use room’s
tagcategory.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_all_characters">
<code class="sig-name descname">tag_all_characters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">tag</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.tag_all_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_all_characters" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Set a given tag on all players in the room.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<li><p><strong>room</strong> (<a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom" title="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom"><em>EvscapeRoom</em></a>) – The room to escape from.</p></li>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<li><p><strong>tag</strong> (<em>str</em>) – The tag to set.</p></li>
<li><p><strong>category</strong> (<em>str</em><em>, </em><em>optional</em>) – If unset, will use the room’s tagcategory.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.character_cleanup">
<code class="sig-name descname">character_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">char</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.character_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.character_cleanup" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Clean all custom tags/attrs on a character.</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.character_exit">
<code class="sig-name descname">character_exit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">char</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.character_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.character_exit" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Have a character exit the room - return them to the room menu.</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_receive">
Updated HTML docs
2022-07-24 06:52:16 +00:00
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">moved_obj</span></em>, <em class="sig-param"><span class="n">source_location</span></em>, <em class="sig-param"><span class="n">move_type</span><span class="o">=</span><span class="default_value">'move'</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_receive" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Called when an object arrives in the room. This can be used to
sum up the situation, set tags etc.</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_leave">
Updated HTML docs
2022-07-24 06:52:16 +00:00
<code class="sig-name descname">at_object_leave</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">moved_obj</span></em>, <em class="sig-param"><span class="n">target_location</span></em>, <em class="sig-param"><span class="n">move_type</span><span class="o">=</span><span class="default_value">'move'</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.at_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_leave" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Called when an object leaves the room; if this is a Character we need
to clean them up and move them to the menu state.</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.delete" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd><p>Delete this room and all items related to it. Only move the players.</p>
</dd></dl>
<dl class="py method">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.return_appearance">
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.return_appearance" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<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">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html#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">evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.DoesNotExist" title="evennia.objects.objects.DefaultRoom.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom.DoesNotExist</span></code></a></p>
Updated HTML docs
2020-11-28 23:23:09 +01:00
</dd></dl>
<dl class="py exception">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html#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">evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.MultipleObjectsReturned" title="evennia.objects.objects.DefaultRoom.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom.MultipleObjectsReturned</span></code></a></p>
Updated HTML docs
2020-11-28 23:23:09 +01:00
</dd></dl>
<dl class="py attribute">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom'</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.path" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd></dd></dl>
<dl class="py attribute">
Updated HTML docs
2022-01-08 16:38:41 +01:00
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'EvscapeRoom'</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.typename" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<dd></dd></dl>
</dd></dl>
Updated HTML docs
2021-05-16 00:06:01 +02:00
</section>
Updated HTML docs
2020-11-28 23:23:09 +01:00
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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>
Updated HTML docs
2022-02-06 18:34:09 +00:00
<li class="right" >
<a href="evennia.contrib.full_systems.evscaperoom.scripts.html" title="evennia.contrib.full_systems.evscaperoom.scripts"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.full_systems.evscaperoom.objects.html" title="evennia.contrib.full_systems.evscaperoom.objects"
>previous</a> |</li>
Updated HTML docs
2020-11-28 23:23:09 +01:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
Updated HTML docs
2022-02-06 18:34:09 +00:00
<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>
Updated HTML docs
2022-01-08 16:38:41 +01:00
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.room</a></li>
Updated HTML docs
2020-11-28 23:23:09 +01:00
</ul>
Updated HTML docs
2021-06-23 18:58:26 +02:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-11-28 23:23:09 +01:00
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink