<spanid="evennia-contrib-tutorials-tutorial-world-rooms"></span><h1>evennia.contrib.tutorials.tutorial_world.rooms<aclass="headerlink"href="#module-evennia.contrib.tutorials.tutorial_world.rooms"title="Permalink to this headline">¶</a></h1>
<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>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdTutorial</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdTutorial"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorial"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'tutorial'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorial.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['tut']</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorial.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorial.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorialworld'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorial.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdTutorial.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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 <strong>tutorial_info</strong> and display that.</p>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorial.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'tut', 'category': 'tutorialworld', 'key': 'tutorial', 'no_prefix': ' tut', '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><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorial.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdTutorialSetDetail</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdTutorialSetDetail"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialSetDetail"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '@detail'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialSetDetail.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(Builder)'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialSetDetail.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorialworld'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialSetDetail.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdTutorialSetDetail.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialSetDetail.func"title="Permalink to this definition">¶</a></dt>
<dd><p>All this does is to check if the object has
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialSetDetail.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(Builder)'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialSetDetail.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': '@detail', 'no_prefix': 'detail ', 'tags': '', 'text': '\n sets a detail on a room\n\n Usage:\n @detail <key> = <description>\n @detail <key>;<alias>;... = description\n\n Example:\n @detail walls = The walls are covered in ...\n @detail castle;ruin;tower = The distant ruin ...\n\n This sets a "detail" 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><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialSetDetail.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdTutorialLook</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdTutorialLook"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorialworld'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdTutorialLook.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['l', 'ls']</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'look'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'l ls', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\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 "details" 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><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdTutorialGiveUp</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdTutorialGiveUp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialGiveUp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'give up'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialGiveUp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['abort']</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialGiveUp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdTutorialGiveUp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialGiveUp.func"title="Permalink to this definition">¶</a></dt>
<dd><p>This is the hook function that actually does all the work. It is called
by the cmdhandler right after self.parser() finishes, and so has access
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialGiveUp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialGiveUp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'abort', 'category': 'general', 'key': 'give up', 'no_prefix': ' abort', 'tags': '', 'text': '\n Give up the tutorial-world quest and return to Limbo, the start room of the\n server.\n\n '}</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialGiveUp.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">TutorialRoomCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdsetobj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">key</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialRoomCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoomCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'tutorial_cmdset'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoomCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">priority</code><emclass="property"> = 1</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoomCmdSet.priority"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialRoomCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoomCmdSet.at_cmdset_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoomCmdSet'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoomCmdSet.path"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">TutorialRoom</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialRoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialRoom.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoom.at_object_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">new_arrival</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialRoom.at_object_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="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>
<codeclass="sig-name descname">return_detail</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">detailkey</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialRoom.return_detail"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>detailkey</strong> (<em>str</em>) – The detail being looked at. This is
<codeclass="sig-name descname">set_detail</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">detailkey</span></em>, <emclass="sig-param"><spanclass="n">description</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialRoom.set_detail"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="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
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoom.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoom.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoom.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'TutorialRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialRoom.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">TutorialStartExit</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialStartExit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialStartExit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TutorialStartExit.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialStartExit.at_object_creation"title="Permalink to this definition">¶</a></dt>
<dd><p>Called once, when this object is first created. This is the
normal hook to overload for most object types.</p>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialStartExit.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialStartExit.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.TutorialStartExit'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialStartExit.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'TutorialStartExit'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TutorialStartExit.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">WeatherRoom</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#WeatherRoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.WeatherRoom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#WeatherRoom.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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
<codeclass="sig-name descname">update_weather</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#WeatherRoom.update_weather"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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 <ahref="#id3"><spanclass="problematic"id="id4">*</span></a>args, <ahref="#id5"><spanclass="problematic"id="id6">**</span></a>kwargs
even though we don’t actually use them in this example)</p>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.WeatherRoom.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.WeatherRoom.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.WeatherRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.WeatherRoom.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'WeatherRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.WeatherRoom.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdEvenniaIntro</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdEvenniaIntro"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEvenniaIntro"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'intro'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEvenniaIntro.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdEvenniaIntro.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEvenniaIntro.func"title="Permalink to this definition">¶</a></dt>
<dd><p>This is the actual executing part of the command. It is
called directly after self.parse(). See the docstring of this
module for which object properties are available (beyond those
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEvenniaIntro.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEvenniaIntro.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEvenniaIntro.lock_storage"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdSetEvenniaIntro</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdsetobj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">key</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdSetEvenniaIntro"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdSetEvenniaIntro"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'Evennia Intro StartSet'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdSetEvenniaIntro.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdSetEvenniaIntro.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdSetEvenniaIntro.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
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.CmdSetEvenniaIntro'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdSetEvenniaIntro.path"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">IntroRoom</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#IntroRoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.IntroRoom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#IntroRoom.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.IntroRoom.at_object_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">character</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#IntroRoom.at_object_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.IntroRoom.at_object_receive"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.IntroRoom.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.IntroRoom.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.IntroRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.IntroRoom.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'IntroRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.IntroRoom.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdEast</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdEast"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEast"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'east'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEast.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['e']</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEast.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEast.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorialworld'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEast.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdEast.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEast.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEast.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'e', 'category': 'tutorialworld', 'key': 'east', 'no_prefix': ' e', '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><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdEast.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdWest</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdWest"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdWest"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'west'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdWest.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['w']</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdWest.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdWest.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorialworld'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdWest.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdWest.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdWest.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdWest.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'w', 'category': 'tutorialworld', 'key': 'west', 'no_prefix': ' w', '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><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdWest.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdLookBridge</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdLookBridge"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookBridge"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'look'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookBridge.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['l']</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookBridge.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookBridge.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorialworld'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookBridge.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdLookBridge.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookBridge.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Looking around, including a chance to fall.</p>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookBridge.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l', 'tags': '', 'text': '\n looks around at the bridge.\n\n Tutorial info:\n This command assumes that the room has an Attribute\n "fall_exit", a unique name or dbref to the place they end upp\n if they fall off the bridge.\n '}</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookBridge.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdBridgeHelp</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdBridgeHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'help'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['h', '?']</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorial world'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdBridgeHelp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'h ?', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">BridgeCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdsetobj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">key</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#BridgeCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'Bridge commands'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">priority</code><emclass="property"> = 2</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeCmdSet.priority"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#BridgeCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeCmdSet.at_cmdset_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.BridgeCmdSet'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeCmdSet.path"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">BridgeRoom</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#BridgeRoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeRoom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#BridgeRoom.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeRoom.at_object_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update_weather</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#BridgeRoom.update_weather"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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
<codeclass="sig-name descname">at_object_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">character</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#BridgeRoom.at_object_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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
<codeclass="sig-name descname">at_object_leave</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">character</span></em>, <emclass="sig-param"><spanclass="n">target_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#BridgeRoom.at_object_leave"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeRoom.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeRoom.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.BridgeRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeRoom.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'BridgeRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.BridgeRoom.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdLookDark</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdLookDark"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'look'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorialworld'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdLookDark.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'l feel fiddle search feel around', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l feel fiddle search feel around', '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><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdDarkHelp</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdDarkHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'help'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkHelp.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'tutorialworld'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdDarkHelp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': 'help', 'no_prefix': ' ', 'tags': '', 'text': '\n Help command for the dark state.\n '}</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">CmdDarkNoMatch</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdDarkNoMatch"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkNoMatch"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '__nomatch_command'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkNoMatch.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkNoMatch.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#CmdDarkNoMatch.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkNoMatch.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkNoMatch.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkNoMatch.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkNoMatch.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': '__nomatch_command', 'no_prefix': ' ', 'tags': '', 'text': "\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 "}</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdDarkNoMatch.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">DarkCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdsetobj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">key</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#DarkCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'darkroom_cmdset'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">mergetype</code><emclass="property"> = 'Replace'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkCmdSet.mergetype"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">priority</code><emclass="property"> = 2</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkCmdSet.priority"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#DarkCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkCmdSet.at_cmdset_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.DarkCmdSet'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkCmdSet.path"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">DarkRoom</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#DarkRoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkRoom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#DarkRoom.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkRoom.at_object_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_init</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#DarkRoom.at_init"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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>
<codeclass="sig-name descname">check_light_state</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">exclude</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#DarkRoom.check_light_state"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>exclude</strong> (<em>Object</em>) – An object to not include in the light check.</p>
<codeclass="sig-name descname">at_object_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#DarkRoom.at_object_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkRoom.at_object_receive"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_leave</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">target_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#DarkRoom.at_object_leave"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkRoom.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkRoom.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.DarkRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkRoom.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'DarkRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.DarkRoom.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">TeleportRoom</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TeleportRoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TeleportRoom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TeleportRoom.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TeleportRoom.at_object_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">character</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#TeleportRoom.at_object_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.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
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TeleportRoom.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TeleportRoom.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.TeleportRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TeleportRoom.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'TeleportRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.TeleportRoom.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.rooms.</code><codeclass="sig-name descname">OutroRoom</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#OutroRoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#OutroRoom.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom.at_object_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">character</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#OutroRoom.at_object_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom.at_object_receive"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_leave</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">character</span></em>, <emclass="sig-param"><spanclass="n">destination</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/tutorial_world/rooms.html#OutroRoom.at_object_leave"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom.at_object_leave"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before an object leaves from inside this object</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>moved_obj</strong> (<em>Object</em>) – The object leaving</p></li>
<li><p><strong>target_location</strong> (<em>Object</em>) – Where <strong>moved_obj</strong> is going.</p></li>
<li><p><strong>move_type</strong> (<em>str</em>) – The type of move. “give”, “traverse”, etc.
This is an arbitrary string provided to obj.move_to().
Useful for altering messages or altering logic depending
on the kind of movement.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'OutroRoom'</em><aclass="headerlink"href="#evennia.contrib.tutorials.tutorial_world.rooms.OutroRoom.typename"title="Permalink to this definition">¶</a></dt>
