Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-25 09:16:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/api/evennia.contrib.tutorial_world.html

2643 lines
211 KiB
HTML
Raw Normal View History

Updated HTML docs
2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>evennia.contrib.tutorial_world package &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-evennia.contrib.tutorial_world">
<span id="evennia-contrib-tutorial-world-package"></span><h1>evennia.contrib.tutorial_world package<a class="headerlink" href="#module-evennia.contrib.tutorial_world" title="Permalink to this headline"></a></h1>
<p>This package holds the demo game of Evennia.</p>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-evennia.contrib.tutorial_world.mob">
<span id="evennia-contrib-tutorial-world-mob-module"></span><h2>evennia.contrib.tutorial_world.mob module<a class="headerlink" href="#module-evennia.contrib.tutorial_world.mob" title="Permalink to this headline"></a></h2>
<p>This module implements a simple mobile object with
a very rudimentary AI as well as an aggressive enemy
object based on that mobile class.</p>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.mob.</code><code class="sig-name descname">CmdMobOnOff</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#CmdMobOnOff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Activates/deactivates Mob</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>mobon &lt;mob&gt;
moboff &lt;mob&gt;</p>
</dd>
</dl>
<p>This turns the mob from active (alive) mode
to inactive (dead) mode. It is used during
building to activate the mob once it’s
prepared.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('moboff', 'mobon')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'moboff', 'mobon'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['moboff']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#CmdMobOnOff.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff.func" title="Permalink to this definition"></a></dt>
<dd><p>Uses the mob’s set_alive/set_dead methods
to turn on/off the mob.”</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff.key">
<code class="sig-name descname">key</code><em class="property"> = 'mobon'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:superuser()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:superuser()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'moboff', 'category': 'general', 'key': 'mobon', 'tags': '', 'text': &quot;\n Activates/deactivates Mob\n\n Usage:\n mobon &lt;mob&gt;\n moboff &lt;mob&gt;\n\n This turns the mob from active (alive) mode\n to inactive (dead) mode. It is used during\n building to activate the mob once it's\n prepared.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.mob.Mob">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.mob.</code><code class="sig-name descname">Mob</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.TutorialObject</span></code></a></p>
<p>This is a state-machine AI mobile. It has several states which are
controlled from setting various Attributes. All default to True:</p>
<blockquote>
<div><dl class="simple">
<dt>patrolling: if set, the mob will move randomly</dt><dd><p>from room to room, but preferring to not return
the way it came. If unset, the mob will remain
stationary (idling) until attacked.</p>
</dd>
<dt>aggressive: if set, will attack Characters in</dt><dd><p>the same room using whatever Weapon it
carries (see tutorial_world.objects.TutorialWeapon).
if unset, the mob will never engage in combat
no matter what.</p>
</dd>
<dt>hunting: if set, the mob will pursue enemies trying</dt><dd><p>to flee from it, so it can enter combat. If unset,
it will return to patrolling/idling if fled from.</p>
</dd>
</dl>
<p>immortal: If set, the mob cannot take any damage.
irregular_echoes: list of strings the mob generates at irregular intervals.
desc_alive: the physical description while alive
desc_dead: the physical descripion while dead
send_defeated_to: unique key/alias for location to send defeated enemies to
defeat_msg: message to echo to defeated opponent
defeat_msg_room: message to echo to room. Accepts %s as the name of the defeated.
hit_msg: message to echo when this mob is hit. Accepts %s for the mob’s key.
weapon_ineffective_msg: message to echo for useless attacks
death_msg: message to echo to room when this mob dies.
patrolling_pace: how many seconds per tick, when patrolling
aggressive_pace: -“- attacking
hunting_pace: -“- hunting
death_pace: -“- returning to life when dead</p>
<dl class="simple">
<dt>field ‘home’ - the home location should set to someplace inside</dt><dd><p>the patrolling area. The mob will use this if it should
happen to roam into a room with no exits.</p>
</dd>
</dl>
</div></blockquote>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.mob.Mob.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.mob.Mob.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob._find_target">
<code class="sig-name descname">_find_target</code><span class="sig-paren">(</span><em class="sig-param">location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob._find_target"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob._find_target" title="Permalink to this definition"></a></dt>
<dd><p>Scan the given location for suitable targets (this is defined
as Characters) to attack. Will ignore superusers.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>location</strong> (<em>Object</em>) – the room to scan.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The first suitable target found.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.Mob._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for Mob&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob._set_ticker">
<code class="sig-name descname">_set_ticker</code><span class="sig-paren">(</span><em class="sig-param">interval</em>, <em class="sig-param">hook_key</em>, <em class="sig-param">stop=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob._set_ticker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob._set_ticker" title="Permalink to this definition"></a></dt>
<dd><p>Set how often the given hook key should
be “ticked”.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>interval</strong> (<em>int</em><em> or </em><em>None</em>) – The number of seconds
between ticks</p></li>
<li><p><strong>hook_key</strong> (<em>str</em><em> or </em><em>None</em>) – The name of the method
(on this mob) to call every interval
seconds.</p></li>
<li><p><strong>stop</strong> (<em>bool</em><em>, </em><em>optional</em>) – Just stop the
last ticker without starting a new one.
With this set, the interval and hook_key
arguments are unused.</p></li>
</ul>
</dd>
</dl>
<p>In order to only have one ticker
running at a time, we make sure to store the
previous ticker subscription so that we can
easily find and stop it before setting a
new one. The tickerhandler is persistent so
we need to remember this across reloads.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.at_hit">
<code class="sig-name descname">at_hit</code><span class="sig-paren">(</span><em class="sig-param">weapon</em>, <em class="sig-param">attacker</em>, <em class="sig-param">damage</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.at_hit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.at_hit" title="Permalink to this definition"></a></dt>
<dd><p>Someone landed a hit on us. Check our status
and start attacking if not already doing so.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.at_init">
<code class="sig-name descname">at_init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.at_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.at_init" title="Permalink to this definition"></a></dt>
<dd><p>When initialized from cache (after a server reboot), set up
the AI state.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.at_new_arrival">
<code class="sig-name descname">at_new_arrival</code><span class="sig-paren">(</span><em class="sig-param">new_character</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.at_new_arrival"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.at_new_arrival" title="Permalink to this definition"></a></dt>
<dd><p>This is triggered whenever a new character enters the room.
This is called by the TutorialRoom the mob stands in and
allows it to be aware of changes immediately without needing
to poll for them all the time. For example, the mob can react
right away, also when patrolling on a very slow ticker.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.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/tutorial_world/mob.html#Mob.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called the first time the object is created.
We set up the base properties and flags here.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.do_attack">
<code class="sig-name descname">do_attack</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.do_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.do_attack" title="Permalink to this definition"></a></dt>
<dd><p>Called regularly when in attacking mode. In attacking mode
the mob will bring its weapons to bear on any targets
in the room.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.do_hunting">
<code class="sig-name descname">do_hunting</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.do_hunting"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.do_hunting" title="Permalink to this definition"></a></dt>
<dd><p>Called regularly when in hunting mode. In hunting mode the mob
scans adjacent rooms for enemies and moves towards them to
attack if possible.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.do_patrol">
<code class="sig-name descname">do_patrol</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.do_patrol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.do_patrol" title="Permalink to this definition"></a></dt>
<dd><p>Called repeatedly during patrolling mode. In this mode, the
mob scans its surroundings and randomly chooses a viable exit.
One should lock exits with the traverse:has_account() lock in
order to block the mob from moving outside its area while
allowing account-controlled characters to move normally.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.Mob.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.mob.Mob'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.set_alive">
<code class="sig-name descname">set_alive</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.set_alive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.set_alive" title="Permalink to this definition"></a></dt>
<dd><p>Set the mob to “alive” mode. This effectively
resurrects it from the dead state.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.set_dead">
<code class="sig-name descname">set_dead</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.set_dead"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.set_dead" title="Permalink to this definition"></a></dt>
<dd><p>Set the mob to “dead” mode. This turns it off
and makes sure it can take no more damage.
It also starts a ticker for when it will return.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.start_attacking">
<code class="sig-name descname">start_attacking</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.start_attacking"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.start_attacking" title="Permalink to this definition"></a></dt>
<dd><p>Start the attacking state</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.start_hunting">
<code class="sig-name descname">start_hunting</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.start_hunting"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.start_hunting" title="Permalink to this definition"></a></dt>
<dd><p>Start the hunting state</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.start_idle">
<code class="sig-name descname">start_idle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.start_idle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.start_idle" title="Permalink to this definition"></a></dt>
<dd><p>Starts just standing around. This will kill
the ticker and do nothing more.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.Mob.start_patrolling">
<code class="sig-name descname">start_patrolling</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#Mob.start_patrolling"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.start_patrolling" title="Permalink to this definition"></a></dt>
<dd><p>Start the patrolling state by
registering us with the ticker-handler
at a leasurely pace.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.Mob.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'Mob'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.Mob.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.mob.MobCmdSet">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.mob.</code><code class="sig-name descname">MobCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#MobCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.MobCmdSet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Holds the admin command controlling the mob</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.mob.MobCmdSet.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/mob.html#MobCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.MobCmdSet.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>Hook method - this should be overloaded in the inheriting
class, and should take care of populating the cmdset by use of
self.add().</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.MobCmdSet.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.mob.MobCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.MobCmdSet.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-evennia.contrib.tutorial_world.objects">
<span id="evennia-contrib-tutorial-world-objects-module"></span><h2>evennia.contrib.tutorial_world.objects module<a class="headerlink" href="#module-evennia.contrib.tutorial_world.objects" title="Permalink to this headline"></a></h2>
<p>TutorialWorld - basic objects - Griatch 2011</p>
<p>This module holds all “dead” object definitions for
the tutorial world. Object-commands and -cmdsets
are also defined here, together with the object.</p>
<p>Objects:</p>
<p>TutorialObject</p>
<p>TutorialReadable
TutorialClimbable
Obelisk
LightSource
CrumblingWall
TutorialWeapon
TutorialWeaponRack</p>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Attack the enemy. Commands:</p>
<blockquote>
<div><p>stab &lt;enemy&gt;
slash &lt;enemy&gt;
parry</p>
</div></blockquote>
<p>stab - (thrust) makes a lot of damage but is harder to hit with.
slash - is easier to land, but does not make as much damage.
parry - forgoes your attack but will make you harder to hit on next</p>
<blockquote>
<div><p>enemy attack.</p>
</div></blockquote>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('kill', 'chop', 'hit', 'thrust', 'pierce', 'stab', 'fight', 'parry', 'defend', 'attack', 'slash')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'attack', 'chop', 'defend', 'fight', 'hit', 'kill', 'parry', 'pierce', 'slash', 'stab', 'thrust'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.aliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">aliases</code><em class="property"> = ['kill', 'hit', 'thrust', 'chop', 'pierce', 'stab', 'fight', 'parry', 'defend', 'slash']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the stab</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.key">
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.search_index_entry">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'kill hit thrust chop pierce stab fight parry defend slash', 'category': 'tutorialworld', 'key': 'attack', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab &lt;enemy&gt;\n slash &lt;enemy&gt;\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdClimb</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdClimb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Climb an object</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>climb &lt;object&gt;</p>
</dd>
</dl>
<p>This allows you to climb.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('climb',)</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'climb'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdClimb.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements function</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb.key">
<code class="sig-name descname">key</code><em class="property"> = 'climb'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdClimb.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': 'climb', 'tags': '', 'text': '\n Climb an object\n\n Usage:\n climb &lt;object&gt;\n\n This allows you to climb.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdClimb.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdGetWeapon</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdGetWeapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<dl class="simple">
<dt>Usage:</dt><dd><p>get weapon</p>
</dd>
</dl>
<p>This will try to obtain a weapon from the container.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('get weapon',)</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'get weapon'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdGetWeapon.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon.func" title="Permalink to this definition"></a></dt>
<dd><p>Get a weapon from the container. It will
itself handle all messages.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon.key">
<code class="sig-name descname">key</code><em class="property"> = 'get weapon'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdGetWeapon.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': 'get weapon', 'tags': '', 'text': '\n Usage:\n get weapon\n\n This will try to obtain a weapon from the container.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdGetWeapon.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdLight</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdLight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Creates light where there was none. Something to burn.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('burn', 'light', 'on')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'burn', 'light', 'on'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.aliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">aliases</code><em class="property"> = ['burn', 'light']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdLight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the light command. Since this command is designed
to sit on a “lightable” object, we operate only on self.obj.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.key">
<code class="sig-name descname">key</code><em class="property"> = 'on'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:holds()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:holds()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.search_index_entry">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdPressButton</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdPressButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Presses a button.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('button', 'press button', 'press', 'push button')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'button', 'press', 'press button', 'push button'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.aliases">
Updated HTML docs
2020-06-13 12:29:54 +02:00
<code class="sig-name descname">aliases</code><em class="property"> = ['button', 'press button', 'push button']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdPressButton.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the command</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.key">
<code class="sig-name descname">key</code><em class="property"> = 'press'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:objattr(button_exposed) and objlocattr(is_lit)'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:objattr(button_exposed) and objlocattr(is_lit)'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.search_index_entry">
Updated HTML docs
2020-06-13 12:29:54 +02:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'button press button push button', 'category': 'tutorialworld', 'key': 'press', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdRead</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdRead"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<dl class="simple">
<dt>Usage:</dt><dd><p>read [obj]</p>
</dd>
</dl>
<p>Read some text of a readable object.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('read',)</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'read'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdRead.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the read command. This simply looks for an
Attribute “readable_text” on the object and displays that.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead.key">
<code class="sig-name descname">key</code><em class="property"> = 'read'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdRead.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': 'read', 'tags': '', 'text': '\n Usage:\n read [obj]\n\n Read some text of a readable object.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdRead.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetClimbable">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdSetClimbable</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetClimbable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetClimbable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Climbing cmdset</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetClimbable.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetClimbable.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetClimbable.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>populate set</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetClimbable.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.CmdSetClimbable'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetClimbable.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdSetCrumblingWall</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetCrumblingWall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Group the commands for crumblingWall</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetCrumblingWall.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>called when object is first created.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall.key">
<code class="sig-name descname">key</code><em class="property"> = 'crumblingwall_cmdset'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall.priority">
<code class="sig-name descname">priority</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetCrumblingWall.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetLight">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdSetLight</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetLight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetLight" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>CmdSet for the lightsource commands</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetLight.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetLight.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetLight.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>called at cmdset creation</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetLight.key">
<code class="sig-name descname">key</code><em class="property"> = 'lightsource_cmdset'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetLight.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetLight.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.CmdSetLight'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetLight.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetLight.priority">
<code class="sig-name descname">priority</code><em class="property"> = 3</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetLight.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetReadable">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdSetReadable</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetReadable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetReadable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>A CmdSet for readables.</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetReadable.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetReadable.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetReadable.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when the cmdset is created.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetReadable.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.CmdSetReadable'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetReadable.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetWeapon">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdSetWeapon</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetWeapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetWeapon" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Holds the attack command.</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetWeapon.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetWeapon.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetWeapon.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>called at first object creation.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetWeapon.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.CmdSetWeapon'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetWeapon.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetWeaponRack">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdSetWeaponRack</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetWeaponRack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetWeaponRack" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>The cmdset for the rack.</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetWeaponRack.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdSetWeaponRack.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetWeaponRack.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called at first creation of cmdset</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetWeaponRack.key">
<code class="sig-name descname">key</code><em class="property"> = 'weaponrack_cmdset'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetWeaponRack.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdSetWeaponRack.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.CmdSetWeaponRack'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdSetWeaponRack.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CmdShiftRoot</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdShiftRoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Shifts roots around.</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>shift blue root left/right
shift red root left/right
shift yellow root up/down
shift green root up/down</p>
</dd>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('pull', 'push', 'shift', 'shiftroot', 'move')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'move', 'pull', 'push', 'shift', 'shiftroot'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.aliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">aliases</code><em class="property"> = ['move', 'shiftroot', 'push', 'pull']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdShiftRoot.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.func" title="Permalink to this definition"></a></dt>
<dd><dl class="simple">
<dt>Implement the command.</dt><dd><p>blue/red - vertical roots
yellow/green - horizontal roots</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.key">
<code class="sig-name descname">key</code><em class="property"> = 'shift'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:locattr(is_lit)'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:locattr(is_lit)'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.parse">
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CmdShiftRoot.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.parse" title="Permalink to this definition"></a></dt>
<dd><p>Custom parser; split input by spaces for simplicity.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.search_index_entry">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'move shiftroot push pull', 'category': 'tutorialworld', 'key': 'shift', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">CrumblingWall</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CrumblingWall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.TutorialObject</span></code></a>, <a class="reference internal" href="evennia.objects.html#evennia.objects.objects.DefaultExit" title="evennia.objects.objects.DefaultExit"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit</span></code></a></p>
<p>This is a custom Exit.</p>
<p>The CrumblingWall can be examined in various ways, but only if a
lit light source is in the room. The traversal itself is blocked
by a traverse: lock on the exit that only allows passage if a
certain attribute is set on the trying account.</p>
<dl class="simple">
<dt>Important attribute</dt><dd><dl class="simple">
<dt>destination - this property must be set to make this a valid exit</dt><dd><p>whenever the button is pushed (this hides it as an exit
until it actually is)</p>
</dd>
</dl>
</dd>
</dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.DoesNotExist</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.MultipleObjectsReturned</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for CrumblingWall&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall._translate_position">
<code class="sig-name descname">_translate_position</code><span class="sig-paren">(</span><em class="sig-param">root</em>, <em class="sig-param">ipos</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CrumblingWall._translate_position"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall._translate_position" title="Permalink to this definition"></a></dt>
<dd><p>Translates the position into words</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.at_after_traverse">
<code class="sig-name descname">at_after_traverse</code><span class="sig-paren">(</span><em class="sig-param">traverser</em>, <em class="sig-param">source_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CrumblingWall.at_after_traverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.at_after_traverse" title="Permalink to this definition"></a></dt>
<dd><p>This is called after we traversed this exit. Cleans up and resets
the puzzle.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.at_failed_traverse">
<code class="sig-name descname">at_failed_traverse</code><span class="sig-paren">(</span><em class="sig-param">traverser</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CrumblingWall.at_failed_traverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.at_failed_traverse" title="Permalink to this definition"></a></dt>
<dd><p>This is called if the account fails to pass the Exit.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.at_init">
<code class="sig-name descname">at_init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CrumblingWall.at_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.at_init" title="Permalink to this definition"></a></dt>
<dd><p>Called when object is recalled from cache.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.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/tutorial_world/objects.html#CrumblingWall.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>called when the object is first created.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.open_wall">
<code class="sig-name descname">open_wall</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CrumblingWall.open_wall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.open_wall" title="Permalink to this definition"></a></dt>
<dd><p>This method is called by the push button command once the puzzle
is solved. It opens the wall and sets a timer for it to reset
itself.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.CrumblingWall'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.reset">
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CrumblingWall.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.reset" title="Permalink to this definition"></a></dt>
<dd><p>Called by tutorial world runner, or whenever someone successfully
traversed the Exit.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.return_appearance">
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param">caller</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#CrumblingWall.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.return_appearance" title="Permalink to this definition"></a></dt>
<dd><p>This is called when someone looks at the wall. We need to echo the
current root positions.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CrumblingWall.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'CrumblingWall'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CrumblingWall.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.LightSource">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">LightSource</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#LightSource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.TutorialObject</span></code></a></p>
<p>This implements a light source object.</p>
<p>When burned out, the object will be deleted.</p>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.LightSource.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.LightSource.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.LightSource._burnout">
<code class="sig-name descname">_burnout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#LightSource._burnout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource._burnout" title="Permalink to this definition"></a></dt>
<dd><p>This is called when this light source burns out. We make no
use of the return value.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.LightSource._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for LightSource&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.LightSource.at_init">
<code class="sig-name descname">at_init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#LightSource.at_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource.at_init" title="Permalink to this definition"></a></dt>
<dd><p>If this is called with the Attribute is_giving_light already
set, we know that the timer got killed by a server
reload/reboot before it had time to finish. So we kill it here
instead. This is the price we pay for the simplicity of the
non-persistent delay() method.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.LightSource.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/tutorial_world/objects.html#LightSource.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when object is first created.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.LightSource.light">
<code class="sig-name descname">light</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#LightSource.light"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource.light" title="Permalink to this definition"></a></dt>
<dd><p>Light this object - this is called by Light command.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.LightSource.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.LightSource'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.LightSource.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'LightSource'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.LightSource.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.Obelisk">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">Obelisk</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#Obelisk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.Obelisk" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.TutorialObject</span></code></a></p>
<p>This object changes its description randomly, and which is shown
determines which order “clue id” is stored on the Character for
future puzzles.</p>
<dl class="simple">
<dt>Important Attribute:</dt><dd><dl class="simple">
<dt>puzzle_descs (list): list of descriptions. One of these is</dt><dd><p>picked randomly when this object is looked at and its index
in the list is used as a key for to solve the puzzle.</p>
</dd>
</dl>
</dd>
</dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.Obelisk.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.Obelisk.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.Obelisk.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.Obelisk.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.Obelisk._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for Obelisk&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.Obelisk._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.Obelisk.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/tutorial_world/objects.html#Obelisk.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.Obelisk.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when object is created.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.Obelisk.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.Obelisk'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.Obelisk.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.Obelisk.return_appearance">
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param">caller</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#Obelisk.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.Obelisk.return_appearance" title="Permalink to this definition"></a></dt>
<dd><p>This hook is called by the look command to get the description
of the object. We overload it with our own version.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.Obelisk.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'Obelisk'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.Obelisk.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.TutorialClimbable">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">TutorialClimbable</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#TutorialClimbable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialClimbable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.TutorialObject</span></code></a></p>
<p>A climbable object. All that is special about it is that it has
the “climb” command available on it.</p>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialClimbable.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialClimbable.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialClimbable.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialClimbable.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialClimbable._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for TutorialClimbable&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialClimbable._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.TutorialClimbable.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/tutorial_world/objects.html#TutorialClimbable.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialClimbable.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called at initial creation only</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialClimbable.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.TutorialClimbable'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialClimbable.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialClimbable.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialClimbable'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialClimbable.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.TutorialObject">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">TutorialObject</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#TutorialObject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
<p>This is the baseclass for all objects in the tutorial.</p>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialObject.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialObject.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialObject.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialObject._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for TutorialObject&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialObject._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.TutorialObject.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/tutorial_world/objects.html#TutorialObject.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialObject.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when the object is first created.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialObject.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.TutorialObject'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialObject.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.TutorialObject.reset">
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#TutorialObject.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialObject.reset" title="Permalink to this definition"></a></dt>
<dd><p>Resets the object, whatever that may mean.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialObject.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialObject'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialObject.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.TutorialReadable">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">TutorialReadable</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#TutorialReadable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialReadable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.TutorialObject</span></code></a></p>
<p>This simple object defines some attributes and</p>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialReadable.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialReadable.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialReadable.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialReadable.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialReadable._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for TutorialReadable&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialReadable._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.TutorialReadable.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/tutorial_world/objects.html#TutorialReadable.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialReadable.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when object is created. We make sure to set the needed
Attribute and add the readable cmdset.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialReadable.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.TutorialReadable'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialReadable.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialReadable.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialReadable'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialReadable.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeapon">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">TutorialWeapon</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#TutorialWeapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeapon" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.TutorialObject</span></code></a></p>
<p>This defines a bladed weapon.</p>
<dl>
<dt>Important attributes (set at creation):</dt><dd><p>hit - chance to hit (0-1)
parry - chance to parry (0-1)
damage - base damage given (modified by hit success and</p>
<blockquote>
<div><p>type of attack) (0-10)</p>
</div></blockquote>
</dd>
</dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeapon.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeapon.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeapon.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeapon.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeapon._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for TutorialWeapon&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeapon._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeapon.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/tutorial_world/objects.html#TutorialWeapon.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeapon.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called at first creation of the object</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeapon.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.TutorialWeapon'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeapon.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeapon.reset">
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#TutorialWeapon.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeapon.reset" title="Permalink to this definition"></a></dt>
<dd><p>When reset, the weapon is simply deleted, unless it has a place
to return to.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeapon.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialWeapon'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeapon.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeaponRack">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.objects.</code><code class="sig-name descname">TutorialWeaponRack</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#TutorialWeaponRack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeaponRack" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.TutorialObject</span></code></a></p>
<p>This object represents a weapon store. When people use the
“get weapon” command on this rack, it will produce one
random weapon from among those registered to exist
on it. This will also set a property on the character
to make sure they can’t get more than one at a time.</p>
<dl class="simple">
<dt>Attributes to set on this object:</dt><dd><dl class="simple">
<dt>available_weapons: list of prototype-keys from</dt><dd><p>WEAPON_PROTOTYPES, the weapons available in this rack.</p>
</dd>
<dt>no_more_weapons_msg - error message to return to accounts</dt><dd><p>who already got one weapon from the rack and tries to
grab another one.</p>
</dd>
</dl>
</dd>
</dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeaponRack.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeaponRack.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeaponRack.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeaponRack.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeaponRack._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for TutorialWeaponRack&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeaponRack._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeaponRack.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/tutorial_world/objects.html#TutorialWeaponRack.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeaponRack.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>called at creation</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeaponRack.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.objects.TutorialWeaponRack'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeaponRack.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeaponRack.produce_weapon">
<code class="sig-name descname">produce_weapon</code><span class="sig-paren">(</span><em class="sig-param">caller</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/objects.html#TutorialWeaponRack.produce_weapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeaponRack.produce_weapon" title="Permalink to this definition"></a></dt>
<dd><p>This will produce a new weapon from the rack,
assuming the caller hasn’t already gotten one. When
doing so, the caller will get Tagged with the id
of this rack, to make sure they cannot keep
pulling weapons from it indefinitely.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.TutorialWeaponRack.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialWeaponRack'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.TutorialWeaponRack.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-evennia.contrib.tutorial_world.rooms">
<span id="evennia-contrib-tutorial-world-rooms-module"></span><h2>evennia.contrib.tutorial_world.rooms module<a class="headerlink" href="#module-evennia.contrib.tutorial_world.rooms" title="Permalink to this headline"></a></h2>
<p>Room Typeclasses for the TutorialWorld.</p>
<p>This defines special types of Rooms available in the tutorial. To keep
everything in one place we define them together with the custom
commands needed to control them. Those commands could also have been
in a separate module (e.g. if they could have been re-used elsewhere.)</p>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeCmdSet">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">BridgeCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#BridgeCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeCmdSet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>This groups the bridge commands. We will store it on the room.</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeCmdSet.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#BridgeCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeCmdSet.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called at first cmdset creation</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeCmdSet.key">
<code class="sig-name descname">key</code><em class="property"> = 'Bridge commands'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeCmdSet.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeCmdSet.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.BridgeCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeCmdSet.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeCmdSet.priority">
<code class="sig-name descname">priority</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeCmdSet.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">BridgeRoom</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#BridgeRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom" title="evennia.contrib.tutorial_world.rooms.WeatherRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.WeatherRoom</span></code></a></p>
<p>The bridge room implements an unsafe bridge. It also enters the player into
a state where they get new commands so as to try to cross the bridge.</p>
<blockquote>
<div><p>We want this to result in the account getting a special set of
commands related to crossing the bridge. The result is that it
will take several steps to cross it, despite it being represented
by only a single room.</p>
<p>We divide the bridge into steps:</p>
<blockquote>
<div><dl class="simple">
<dt>self.db.west_exit - - | - - self.db.east_exit</dt><dd><p>0 1 2 3 4</p>
</dd>
</dl>
</div></blockquote>
<p>The position is handled by a variable stored on the character
when entering and giving special move commands will
increase/decrease the counter until the bridge is crossed.</p>
<p>We also has self.db.fall_exit, which points to a gathering
location to end up if we happen to fall off the bridge (used by
the CmdLookBridge command).</p>
</div></blockquote>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for BridgeRoom&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom.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/tutorial_world/rooms.html#BridgeRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Setups the room</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom.at_object_leave">
<code class="sig-name descname">at_object_leave</code><span class="sig-paren">(</span><em class="sig-param">character</em>, <em class="sig-param">target_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#BridgeRoom.at_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom.at_object_leave" title="Permalink to this definition"></a></dt>
<dd><p>This is triggered when the player leaves the bridge room.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom.at_object_receive">
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param">character</em>, <em class="sig-param">source_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#BridgeRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom.at_object_receive" title="Permalink to this definition"></a></dt>
<dd><p>This hook is called by the engine whenever the player is moved
into this room.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.BridgeRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'BridgeRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.BridgeRoom.update_weather">
<code class="sig-name descname">update_weather</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#BridgeRoom.update_weather"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.BridgeRoom.update_weather" title="Permalink to this definition"></a></dt>
<dd><p>This is called at irregular intervals and makes the passage
over the bridge a little more interesting.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdBridgeHelp</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdBridgeHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Overwritten help command while on the bridge.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('help', '?', 'h')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'?', 'h', 'help'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.aliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.aliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdBridgeHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the command.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorial world'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.key">
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.search_index_entry">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdBridgeHelp.search_index_entry" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdDarkHelp</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdDarkHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Help command for the dark state.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('help',)</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'help'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdDarkHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp.func" title="Permalink to this definition"></a></dt>
<dd><p>Replace the the help command with a not-so-useful help</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp.key">
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkHelp.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': 'help', 'tags': '', 'text': '\n Help command for the dark state.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkHelp.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdDarkNoMatch</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdDarkNoMatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>This is a system command. Commands with special keys are used to
override special sitations in the game. The CMD_NOMATCH is used
when the given command is not found in the current command set (it
replaces Evennia’s default behavior or offering command
suggestions)</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__nomatch_command',)</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'__nomatch_command'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdDarkNoMatch.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the command.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.key">
<code class="sig-name descname">key</code><em class="property"> = '__nomatch_command'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': '__nomatch_command', 'tags': '', 'text': &quot;\n This is a system command. Commands with special keys are used to\n override special sitations in the game. The CMD_NOMATCH is used\n when the given command is not found in the current command set (it\n replaces Evennia's default behavior or offering command\n suggestions)\n &quot;}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdDarkNoMatch.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdEast</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdEast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Go eastwards across the bridge.</p>
<dl>
<dt>Tutorial info:</dt><dd><blockquote>
<div><p>This command relies on the caller having two Attributes
(assigned by the room when entering):</p>
<blockquote>
<div><ul class="simple">
<li><p>east_exit: a unique name or dbref to the room to go to
when exiting east.</p></li>
<li><p>west_exit: a unique name or dbref to the room to go to
when exiting west.</p></li>
</ul>
</div></blockquote>
</div></blockquote>
<dl class="simple">
<dt>The room must also have the following Attributes</dt><dd><ul class="simple">
<li><p>tutorial_bridge_posistion: the current position on
on the bridge, 0 - 4.</p></li>
</ul>
</dd>
</dl>
</dd>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('east', 'e')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'e', 'east'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['e']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdEast.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast.func" title="Permalink to this definition"></a></dt>
<dd><p>move one step eastwards</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast.key">
<code class="sig-name descname">key</code><em class="property"> = 'east'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'e', 'category': 'tutorialworld', 'key': 'east', 'tags': '', 'text': '\n Go eastwards across the bridge.\n\n Tutorial info:\n This command relies on the caller having two Attributes\n (assigned by the room when entering):\n - east_exit: a unique name or dbref to the room to go to\n when exiting east.\n - west_exit: a unique name or dbref to the room to go to\n when exiting west.\n The room must also have the following Attributes\n - tutorial_bridge_posistion: the current position on\n on the bridge, 0 - 4.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdLookBridge</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdLookBridge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>looks around at the bridge.</p>
<dl class="simple">
<dt>Tutorial info:</dt><dd><p>This command assumes that the room has an Attribute
“fall_exit”, a unique name or dbref to the place they end upp
if they fall off the bridge.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'l')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'l', 'look'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['l']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdLookBridge.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge.func" title="Permalink to this definition"></a></dt>
<dd><p>Looking around, including a chance to fall.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge.key">
<code class="sig-name descname">key</code><em class="property"> = 'look'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n looks around at the bridge.\n\n Tutorial info:\n This command assumes that the room has an Attribute\n &quot;fall_exit&quot;, a unique name or dbref to the place they end upp\n if they fall off the bridge.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdLookDark</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdLookDark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Look around in darkness</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>look</p>
</dd>
</dl>
<p>Look around in the darkness, trying
to find something.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'feel around', 'fiddle', 'l', 'search', 'feel')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'feel', 'feel around', 'fiddle', 'l', 'look', 'search'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.aliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">aliases</code><em class="property"> = ['feel around', 'fiddle', 'l', 'search', 'feel']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdLookDark.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement the command.</p>
<p>This works both as a look and a search command; there is a
random chance of eventually finding a light source.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.key">
<code class="sig-name descname">key</code><em class="property"> = 'look'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.search_index_entry">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel around fiddle l search feel', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdTutorial</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdTutorial"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Get help during the tutorial</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>tutorial [obj]</p>
</dd>
</dl>
<p>This command allows you to get behind-the-scenes info
about an object or the current location.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial._keyaliases">
Updated HTML docs
2020-06-13 00:42:51 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tut', 'tutorial')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'tut', 'tutorial'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['tut']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdTutorial.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial.func" title="Permalink to this definition"></a></dt>
<dd><p>All we do is to scan the current location for an Attribute
called <cite>tutorial_info</cite> and display that.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial.key">
<code class="sig-name descname">key</code><em class="property"> = 'tutorial'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorial.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'tut', 'category': 'tutorialworld', 'key': 'tutorial', 'tags': '', 'text': '\n Get help during the tutorial\n\n Usage:\n tutorial [obj]\n\n This command allows you to get behind-the-scenes info\n about an object or the current location.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorial.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdTutorialLook</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdTutorialLook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.html#evennia.commands.default.general.CmdLook" title="evennia.commands.default.general.CmdLook"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.general.CmdLook</span></code></a></p>
<p>looks at the room and on details</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>look &lt;obj&gt;
look &lt;room detail&gt;
look <a href="#id1"><span class="problematic" id="id2">*</span></a>&lt;account&gt;</p>
</dd>
</dl>
<p>Observes your location, details at your location or objects
in your vicinity.</p>
<p>Tutorial: This is a child of the default Look command, that also
allows us to look at “details” in the room. These details are
things to examine and offers some extra description without
actually having to be actual database objects. It uses the
return_detail() hook on TutorialRooms for this.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'ls', 'l')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'l', 'look', 'ls'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook.aliases">
Updated HTML docs
2020-06-13 12:23:41 +02:00
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.aliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdTutorialLook.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.func" title="Permalink to this definition"></a></dt>
<dd><p>Handle the looking. This is a copy of the default look
code except for adding in the details.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook.key">
<code class="sig-name descname">key</code><em class="property"> = 'look'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook.search_index_entry">
Updated HTML docs
2020-06-13 12:23:41 +02:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look &lt;obj&gt;\n look &lt;room detail&gt;\n look *&lt;account&gt;\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at &quot;details&quot; in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.search_index_entry" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdTutorialSetDetail</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdTutorialSetDetail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>sets a detail on a room</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>&#64;detail &lt;key&gt; = &lt;description&gt;
&#64;detail &lt;key&gt;;&lt;alias&gt;;… = description</p>
</dd>
</dl>
<p class="rubric">Example</p>
<p>&#64;detail walls = The walls are covered in …
&#64;detail castle;ruin;tower = The distant ruin …</p>
<p>This sets a “detail” on the object this command is defined on
(TutorialRoom for this tutorial). This detail can be accessed with
the TutorialRoomLook command sitting on TutorialRoom objects (details
are set as a simple dictionary on the room). This is a Builder command.</p>
<p>We custom parse the key for the ;-separator in order to create
multiple aliases to the detail all at once.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;detail',)</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'&#64;detail'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdTutorialSetDetail.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.func" title="Permalink to this definition"></a></dt>
<dd><p>All this does is to check if the object has
the set_detail method and uses it.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.key">
<code class="sig-name descname">key</code><em class="property"> = '&#64;detail'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': '&#64;detail', 'tags': '', 'text': '\n sets a detail on a room\n\n Usage:\n &#64;detail &lt;key&gt; = &lt;description&gt;\n &#64;detail &lt;key&gt;;&lt;alias&gt;;... = description\n\n Example:\n &#64;detail walls = The walls are covered in ...\n &#64;detail castle;ruin;tower = The distant ruin ...\n\n This sets a &quot;detail&quot; on the object this command is defined on\n (TutorialRoom for this tutorial). This detail can be accessed with\n the TutorialRoomLook command sitting on TutorialRoom objects (details\n are set as a simple dictionary on the room). This is a Builder command.\n\n We custom parse the key for the ;-separator in order to create\n multiple aliases to the detail all at once.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialSetDetail.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">CmdWest</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdWest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
<p>Go westwards across the bridge.</p>
<dl>
<dt>Tutorial info:</dt><dd><p>This command relies on the caller having two Attributes
(assigned by the room when entering):</p>
<blockquote>
<div><ul class="simple">
<li><p>east_exit: a unique name or dbref to the room to go to
when exiting east.</p></li>
<li><p>west_exit: a unique name or dbref to the room to go to
when exiting west.</p></li>
</ul>
</div></blockquote>
<dl class="simple">
<dt>The room must also have the following property:</dt><dd><ul class="simple">
<li><p>tutorial_bridge_posistion: the current position on
on the bridge, 0 - 4.</p></li>
</ul>
</dd>
</dl>
</dd>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest._keyaliases">
Updated HTML docs
2020-06-13 12:44:15 +02:00
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('w', 'west')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest._keyaliases" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest._matchset">
<code class="sig-name descname">_matchset</code><em class="property"> = {'w', 'west'}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest._matchset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['w']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#CmdWest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest.func" title="Permalink to this definition"></a></dt>
<dd><p>move one step westwards</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'tutorialworld'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest.key">
<code class="sig-name descname">key</code><em class="property"> = 'west'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'w', 'category': 'tutorialworld', 'key': 'west', 'tags': '', 'text': '\n Go westwards across the bridge.\n\n Tutorial info:\n This command relies on the caller having two Attributes\n (assigned by the room when entering):\n - east_exit: a unique name or dbref to the room to go to\n when exiting east.\n - west_exit: a unique name or dbref to the room to go to\n when exiting west.\n The room must also have the following property:\n - tutorial_bridge_posistion: the current position on\n on the bridge, 0 - 4.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.DarkCmdSet">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">DarkCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkCmdSet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Groups the commands of the dark room together. We also import the
default say command here so that players can still talk in the
darkness.</p>
<p>We give the cmdset the mergetype “Replace” to make sure it
completely replaces whichever command set it is merged onto
(usually the default cmdset)</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.DarkCmdSet.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkCmdSet.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>populate the cmdset.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.DarkCmdSet.key">
<code class="sig-name descname">key</code><em class="property"> = 'darkroom_cmdset'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkCmdSet.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.DarkCmdSet.mergetype">
<code class="sig-name descname">mergetype</code><em class="property"> = 'Replace'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkCmdSet.mergetype" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.DarkCmdSet.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.DarkCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkCmdSet.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.DarkCmdSet.priority">
<code class="sig-name descname">priority</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkCmdSet.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">DarkRoom</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom" title="evennia.contrib.tutorial_world.rooms.TutorialRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.TutorialRoom</span></code></a></p>
<p>A dark room. This tries to start the DarkState script on all
objects entering. The script is responsible for making sure it is
valid (that is, that there is no light source shining in the room).</p>
<p>The is_lit Attribute is used to define if the room is currently lit
or not, so as to properly echo state changes.</p>
<p>Since this room (in the tutorial) is meant as a sort of catch-all,
we also make sure to heal characters ending up here, since they
may have been beaten up by the ghostly apparition at this point.</p>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom._carries_light">
<code class="sig-name descname">_carries_light</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkRoom._carries_light"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom._carries_light" title="Permalink to this definition"></a></dt>
<dd><p>Checks if the given object carries anything that gives light.</p>
<p>Note that we do NOT look for a specific LightSource typeclass,
but for the Attribute is_giving_light - this makes it easy to
later add other types of light-giving items. We also accept
if there is a light-giving object in the room overall (like if
a splinter was dropped in the room)</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom._heal">
<code class="sig-name descname">_heal</code><span class="sig-paren">(</span><em class="sig-param">character</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkRoom._heal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom._heal" title="Permalink to this definition"></a></dt>
<dd><p>Heal a character.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for DarkRoom&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.at_init">
<code class="sig-name descname">at_init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkRoom.at_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.at_init" title="Permalink to this definition"></a></dt>
<dd><p>Called when room is first recached (such as after a reload)</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.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/tutorial_world/rooms.html#DarkRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when object is first created.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.at_object_leave">
<code class="sig-name descname">at_object_leave</code><span class="sig-paren">(</span><em class="sig-param">obj</em>, <em class="sig-param">target_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkRoom.at_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.at_object_leave" title="Permalink to this definition"></a></dt>
<dd><p>In case people leave with the light, we make sure to clear the
DarkCmdSet if necessary. This also works if they are
teleported away.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.at_object_receive">
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param">obj</em>, <em class="sig-param">source_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.at_object_receive" title="Permalink to this definition"></a></dt>
<dd><p>Called when an object enters the room.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.check_light_state">
<code class="sig-name descname">check_light_state</code><span class="sig-paren">(</span><em class="sig-param">exclude=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#DarkRoom.check_light_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.check_light_state" title="Permalink to this definition"></a></dt>
<dd><p>This method checks if there are any light sources in the room.
If there isn’t it makes sure to add the dark cmdset to all
characters in the room. It is called whenever characters enter
the room and also by the Light sources when they turn on.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>exclude</strong> (<em>Object</em>) – An object to not include in the light check.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.DarkRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.DarkRoom.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'DarkRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.DarkRoom.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.IntroRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">IntroRoom</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#IntroRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.IntroRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom" title="evennia.contrib.tutorial_world.rooms.TutorialRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.TutorialRoom</span></code></a></p>
<p>Intro room</p>
<dl class="simple">
<dt>properties to customize:</dt><dd><p>char_health - integer &gt; 0 (default 20)</p>
</dd>
</dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.IntroRoom.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.IntroRoom.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.IntroRoom.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.IntroRoom.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.IntroRoom._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for IntroRoom&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.IntroRoom._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.IntroRoom.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/tutorial_world/rooms.html#IntroRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.IntroRoom.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when the room is first created.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.IntroRoom.at_object_receive">
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param">character</em>, <em class="sig-param">source_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#IntroRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.IntroRoom.at_object_receive" title="Permalink to this definition"></a></dt>
<dd><p>Assign properties on characters</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.IntroRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.IntroRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.IntroRoom.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.IntroRoom.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'IntroRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.IntroRoom.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.OutroRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">OutroRoom</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#OutroRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.OutroRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom" title="evennia.contrib.tutorial_world.rooms.TutorialRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.TutorialRoom</span></code></a></p>
<p>Outro room.</p>
<p>Called when exiting the tutorial, cleans the
character of tutorial-related attributes.</p>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.OutroRoom.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.OutroRoom.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.OutroRoom.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.OutroRoom.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.OutroRoom._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for OutroRoom&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.OutroRoom._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.OutroRoom.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/tutorial_world/rooms.html#OutroRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.OutroRoom.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when the room is first created.</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.OutroRoom.at_object_receive">
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param">character</em>, <em class="sig-param">source_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#OutroRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.OutroRoom.at_object_receive" title="Permalink to this definition"></a></dt>
<dd><p>Do cleanup.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.OutroRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.OutroRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.OutroRoom.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.OutroRoom.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'OutroRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.OutroRoom.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.TeleportRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">TeleportRoom</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#TeleportRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TeleportRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom" title="evennia.contrib.tutorial_world.rooms.TutorialRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.TutorialRoom</span></code></a></p>
<p>Teleporter - puzzle room.</p>
<dl class="simple">
<dt>Important attributes (set at creation):</dt><dd><p>puzzle_key - which attr to look for on character
puzzle_value - what char.db.puzzle_key must be set to
success_teleport_to - where to teleport in case if success
success_teleport_msg - message to echo while teleporting to success
failure_teleport_to - where to teleport to in case of failure
failure_teleport_msg - message to echo while teleporting to failure</p>
</dd>
</dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.TeleportRoom.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TeleportRoom.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.TeleportRoom.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TeleportRoom.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TeleportRoom._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for TeleportRoom&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TeleportRoom._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.TeleportRoom.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/tutorial_world/rooms.html#TeleportRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TeleportRoom.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called at first creation</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.TeleportRoom.at_object_receive">
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param">character</em>, <em class="sig-param">source_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#TeleportRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TeleportRoom.at_object_receive" title="Permalink to this definition"></a></dt>
<dd><p>This hook is called by the engine whenever the player is moved into
this room.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TeleportRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.TeleportRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TeleportRoom.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TeleportRoom.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TeleportRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TeleportRoom.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">TutorialRoom</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#TutorialRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.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>
<p>This is the base room type for all rooms in the tutorial world.
It defines a cmdset on itself for reading tutorial info about the location.</p>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for TutorialRoom&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom.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/tutorial_world/rooms.html#TutorialRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when room is first created</p>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom.at_object_receive">
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param">new_arrival</em>, <em class="sig-param">source_location</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#TutorialRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom.at_object_receive" title="Permalink to this definition"></a></dt>
<dd><p>When an object enter a tutorial room we tell other objects in
the room about it by trying to call a hook on them. The Mob object
uses this to cheaply get notified of enemies without having
to constantly scan for them.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_arrival</strong> (<em>Object</em>) – the object that just entered this room.</p></li>
<li><p><strong>source_location</strong> (<em>Object</em>) – the previous location of new_arrival.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.TutorialRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom.return_detail">
<code class="sig-name descname">return_detail</code><span class="sig-paren">(</span><em class="sig-param">detailkey</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#TutorialRoom.return_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom.return_detail" title="Permalink to this definition"></a></dt>
<dd><p>This looks for an Attribute “obj_details” and possibly
returns the value of it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>detailkey</strong> (<em>str</em>) – The detail being looked at. This is
case-insensitive.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom.set_detail">
<code class="sig-name descname">set_detail</code><span class="sig-paren">(</span><em class="sig-param">detailkey</em>, <em class="sig-param">description</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#TutorialRoom.set_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom.set_detail" title="Permalink to this definition"></a></dt>
<dd><p>This sets a new detail, using an Attribute “details”.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>detailkey</strong> (<em>str</em>) – The detail identifier to add (for
aliases you need to add multiple keys to the
same description). Case-insensitive.</p></li>
<li><p><strong>description</strong> (<em>str</em>) – The text to return when looking
at the given detailkey.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoom.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">TutorialRoomCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#TutorialRoomCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Implements the simple tutorial cmdset. This will overload the look
command in the default CharacterCmdSet since it has a higher
priority (ChracterCmdSet has prio 0)</p>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#TutorialRoomCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>add the tutorial-room commands</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet.key">
<code class="sig-name descname">key</code><em class="property"> = 'tutorial_cmdset'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet.priority">
<code class="sig-name descname">priority</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.TutorialRoomCmdSet.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="evennia.contrib.tutorial_world.rooms.WeatherRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_world.rooms.</code><code class="sig-name descname">WeatherRoom</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#WeatherRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorial_world.rooms.TutorialRoom" title="evennia.contrib.tutorial_world.rooms.TutorialRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.TutorialRoom</span></code></a></p>
<p>This should probably better be called a rainy room…</p>
<p>This sets up an outdoor room typeclass. At irregular intervals,
the effects of weather will show in the room. Outdoor rooms should
inherit from this.</p>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.WeatherRoom.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.DoesNotExist</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="evennia.contrib.tutorial_world.rooms.WeatherRoom.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_world.rooms.MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.WeatherRoom._meta">
<code class="sig-name descname">_meta</code><em class="property"> = &lt;Options for WeatherRoom&gt;</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom._meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.WeatherRoom.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/tutorial_world/rooms.html#WeatherRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>Called when object is first created.
We set up a ticker to update this room regularly.</p>
<p>Note that we could in principle also use a Script to manage
the ticking of the room; the TickerHandler works fine for
simple things like this though.</p>
</dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.WeatherRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_world.rooms.WeatherRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.WeatherRoom.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'WeatherRoom'</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="evennia.contrib.tutorial_world.rooms.WeatherRoom.update_weather">
<code class="sig-name descname">update_weather</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_world/rooms.html#WeatherRoom.update_weather"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.WeatherRoom.update_weather" title="Permalink to this definition"></a></dt>
<dd><p>Called by the tickerhandler at regular intervals. Even so, we
only update 20% of the time, picking a random weather message
when we do. The tickerhandler requires that this hook accepts
any arguments and keyword arguments (hence the <a href="#id3"><span class="problematic" id="id4">*</span></a>args, <a href="#id5"><span class="problematic" id="id6">**</span></a>kwargs
even though we don’t actually use them in this example)</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<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>
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.tutorial_world package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-evennia.contrib.tutorial_world.mob">evennia.contrib.tutorial_world.mob module</a></li>
<li><a class="reference internal" href="#module-evennia.contrib.tutorial_world.objects">evennia.contrib.tutorial_world.objects module</a></li>
<li><a class="reference internal" href="#module-evennia.contrib.tutorial_world.rooms">evennia.contrib.tutorial_world.rooms module</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.tutorial_world.rst.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div>
<h3>Versions</h3>
<ul>
<li><a href="evennia.contrib.tutorial_world.html">1.0-dev (develop branch)</a></li>
Updated HTML docs
2020-06-13 12:23:41 +02:00
<li><a href="../../0.9.1/api/evennia.contrib.tutorial_world.html">0.9.1 (master branch)</a></li>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2020, The Evennia developer community.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/api/evennia.contrib.tutorial_world.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
Reference in a new issue Copy permalink