Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-18 22:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/2.x/api/evennia.contrib.tutorials.tutorial_world.objects.html

1061 lines
96 KiB
HTML
Raw Normal View History

Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<title>evennia.contrib.tutorials.tutorial_world.objects &#8212; Evennia 2.x documentation</title>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.contrib.tutorials.tutorial_world.rooms" href="evennia.contrib.tutorials.tutorial_world.rooms.html" />
<link rel="prev" title="evennia.contrib.tutorials.tutorial_world.mob" href="evennia.contrib.tutorials.tutorial_world.mob.html" />
</head><body>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.rooms.html" title="evennia.contrib.tutorials.tutorial_world.rooms"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.mob.html" title="evennia.contrib.tutorials.tutorial_world.mob"
accesskey="P">previous</a> |</li>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.tutorial_world.html" accesskey="U">evennia.contrib.tutorials.tutorial_world</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.tutorial_world.objects</a></li>
</ul>
Updated HTML docs.
2023-06-10 08:53:19 +00:00
</div>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.tutorials.tutorial_world.mob.html"
title="previous chapter">evennia.contrib.tutorials.tutorial_world.mob</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.tutorials.tutorial_world.rooms.html"
title="next chapter">evennia.contrib.tutorials.tutorial_world.rooms</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.tutorials.tutorial_world.objects.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<h3>Doc Versions</h3>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="evennia.contrib.tutorials.tutorial_world.objects.html">2.x (main branch)</a></li>
Updated HTML docs.
2022-11-15 20:29:38 +00:00
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
Updated HTML docs.
2022-11-15 20:29:38 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.tutorials.tutorial_world.objects">
<span id="evennia-contrib-tutorials-tutorial-world-objects"></span><h1>evennia.contrib.tutorials.tutorial_world.objects<a class="headerlink" href="#module-evennia.contrib.tutorials.tutorial_world.objects" title="Permalink to this headline"></a></h1>
<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="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">TutorialObject</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#TutorialObject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
<p>This is the baseclass for all objects in the tutorial.</p>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#TutorialObject.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#TutorialObject.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.DoesNotExist" title="evennia.objects.objects.DefaultObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.MultipleObjectsReturned" title="evennia.objects.objects.DefaultObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.TutorialObject'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialObject'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdRead">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdRead</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdRead"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdRead" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdRead.key">
<code class="sig-name descname">key</code><em class="property"> = 'read'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdRead.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdRead.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdRead.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdRead.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdRead.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdRead.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdRead.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdRead.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdRead.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': 'read', 'no_prefix': ' ', 'tags': '', 'text': '\n Usage:\n read [obj]\n\n Read some text of a readable object.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdRead.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetReadable">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdSetReadable</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdSetReadable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetReadable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>A CmdSet for readables.</p>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdSetReadable.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetReadable.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.CmdSetReadable'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetReadable.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">TutorialReadable</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#TutorialReadable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject</span></code></a></p>
<p>This simple object defines some attributes and</p>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#TutorialReadable.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialReadable'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialReadable.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdClimb">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdClimb</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdClimb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdClimb" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdClimb.key">
<code class="sig-name descname">key</code><em class="property"> = 'climb'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdClimb.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdClimb.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdClimb.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdClimb.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdClimb.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdClimb.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdClimb.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdClimb.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdClimb.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdClimb.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'tutorialworld', 'key': 'climb', 'no_prefix': ' ', '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.tutorials.tutorial_world.objects.CmdClimb.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetClimbable">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdSetClimbable</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdSetClimbable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetClimbable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Climbing cmdset</p>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdSetClimbable.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetClimbable.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>populate set</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetClimbable.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.CmdSetClimbable'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetClimbable.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">TutorialClimbable</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#TutorialClimbable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#TutorialClimbable.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialClimbable'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialClimbable.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.Obelisk">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">Obelisk</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#Obelisk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.Obelisk" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#Obelisk.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.Obelisk.return_appearance">
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#Obelisk.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.Obelisk.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.Obelisk.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.Obelisk.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.Obelisk.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.Obelisk.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.Obelisk'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.Obelisk.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.Obelisk.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'Obelisk'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.Obelisk.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdLight</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdLight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight.key">
<code class="sig-name descname">key</code><em class="property"> = 'on'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight.aliases">
Updated HTML docs.
2023-11-02 20:02:56 +00:00
<code class="sig-name descname">aliases</code><em class="property"> = ['burn', 'light']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition"></a></dt>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:holds()'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdLight.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdLight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdLight.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight.search_index_entry">
Updated HTML docs.
2023-11-02 20:02:56 +00:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' burn light', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition"></a></dt>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdSetLight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdSetLight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>CmdSet for the lightsource commands</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight.key">
<code class="sig-name descname">key</code><em class="property"> = 'lightsource_cmdset'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight.priority">
<code class="sig-name descname">priority</code><em class="property"> = 3</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdSetLight.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetLight.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.LightSource">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">LightSource</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#LightSource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.LightSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#LightSource.at_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#LightSource.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#LightSource.light"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.LightSource.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.LightSource.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.LightSource.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.LightSource.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.LightSource.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.LightSource'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.LightSource.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.LightSource.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'LightSource'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.LightSource.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdShiftRoot</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdShiftRoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.key">
<code class="sig-name descname">key</code><em class="property"> = 'shift'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases">
Updated HTML docs.
2023-11-02 20:02:56 +00:00
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'pull', 'shiftroot', 'move']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition"></a></dt>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdShiftRoot.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdShiftRoot.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdShiftRoot.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdShiftRoot.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdShiftRoot.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry">
Updated HTML docs.
2023-11-02 20:02:56 +00:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push pull shiftroot move', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' push pull shiftroot move', '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.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition"></a></dt>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdPressButton</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdPressButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.key">
<code class="sig-name descname">key</code><em class="property"> = 'press'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases">
Updated HTML docs.
2023-11-02 20:02:56 +00:00
<code class="sig-name descname">aliases</code><em class="property"> = ['push button', 'button', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition"></a></dt>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdPressButton.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdPressButton.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdPressButton.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the command</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdPressButton.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry">
Updated HTML docs.
2023-11-02 20:02:56 +00:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push button button press button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' push button button press button', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition"></a></dt>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdSetCrumblingWall</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdSetCrumblingWall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Group the commands for crumblingWall</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall.key">
<code class="sig-name descname">key</code><em class="property"> = 'crumblingwall_cmdset'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall.priority">
<code class="sig-name descname">priority</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdSetCrumblingWall.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetCrumblingWall.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CrumblingWall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CrumblingWall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit" title="evennia.objects.objects.DefaultExit"><code class="xref py py-class docutils literal notranslate"><span class="pre">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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CrumblingWall.at_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CrumblingWall.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CrumblingWall.open_wall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.return_appearance">
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CrumblingWall.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.at_post_traverse">
<code class="sig-name descname">at_post_traverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">traverser</span></em>, <em class="sig-param"><span class="n">source_location</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CrumblingWall.at_post_traverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.at_post_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="py method">
<dt id="evennia.contrib.tutorials.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"><span class="n">traverser</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CrumblingWall.at_failed_traverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CrumblingWall.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit.DoesNotExist" title="evennia.objects.objects.DefaultExit.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit.MultipleObjectsReturned" title="evennia.objects.objects.DefaultExit.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'CrumblingWall'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CrumblingWall.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.key">
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases">
Updated HTML docs.
2023-11-02 20:02:56 +00:00
<code class="sig-name descname">aliases</code><em class="property"> = ['chop', 'parry', 'thrust', 'bash', 'hit', 'pierce', 'slash', 'kill', 'defend', 'stab', 'fight']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition"></a></dt>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdAttack.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the stab</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdAttack.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry">
Updated HTML docs.
2023-11-02 20:02:56 +00:00
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chop parry thrust bash hit pierce slash kill defend stab fight', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' chop parry thrust bash hit pierce slash kill defend stab fight', '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.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition"></a></dt>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeapon">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdSetWeapon</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdSetWeapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeapon" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Holds the attack command.</p>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdSetWeapon.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeapon.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeapon.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">TutorialWeapon</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#TutorialWeapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#TutorialWeapon.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#TutorialWeapon.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialWeapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeapon.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdGetWeapon">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdGetWeapon</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdGetWeapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdGetWeapon" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdGetWeapon.key">
<code class="sig-name descname">key</code><em class="property"> = 'get weapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdGetWeapon.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdGetWeapon.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdGetWeapon.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdGetWeapon.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdGetWeapon.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdGetWeapon.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdGetWeapon.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.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.tutorials.tutorial_world.objects.CmdGetWeapon.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.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', 'no_prefix': ' ', '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.tutorials.tutorial_world.objects.CmdGetWeapon.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeaponRack">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">CmdSetWeaponRack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#CmdSetWeaponRack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeaponRack" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>The cmdset for the rack.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeaponRack.key">
<code class="sig-name descname">key</code><em class="property"> = 'weaponrack_cmdset'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeaponRack.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#CmdSetWeaponRack.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeaponRack.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeaponRack'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdSetWeaponRack.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.objects.</code><code class="sig-name descname">TutorialWeaponRack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#TutorialWeaponRack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.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="py method">
<dt id="evennia.contrib.tutorials.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/tutorials/tutorial_world/objects.html#TutorialWeaponRack.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.at_object_creation" title="Permalink to this definition"></a></dt>
<dd><p>called at creation</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.produce_weapon">
<code class="sig-name descname">produce_weapon</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/objects.html#TutorialWeaponRack.produce_weapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.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="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.tutorial_world.objects.TutorialObject.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'TutorialWeaponRack'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.TutorialWeaponRack.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.rooms.html" title="evennia.contrib.tutorials.tutorial_world.rooms"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.mob.html" title="evennia.contrib.tutorials.tutorial_world.mob"
>previous</a> |</li>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.tutorial_world.html" >evennia.contrib.tutorials.tutorial_world</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.tutorial_world.objects</a></li>
</ul>
</div>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<div class="footer" role="contentinfo">
Updated HTML docs.
2023-10-19 20:22:27 +00:00
&#169; Copyright 2023, The Evennia developer community.
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink