Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-01 21:47:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/_modules/evennia/contrib/slow_exit.html
Griatch 86c930be7a Updated HTML docs
2021-06-23 18:58:26 +02:00

249 lines
No EOL
20 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.contrib.slow_exit &#8212; Evennia 1.0-dev documentation</title>
<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" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.slow_exit</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.contrib.slow_exit</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Slow Exit typeclass</span>
<span class="sd">Contribution - Griatch 2014</span>
<span class="sd">This is an example of an Exit-type that delays its traversal.This</span>
<span class="sd">simulates slow movement, common in many different types of games. The</span>
<span class="sd">contrib also contains two commands, CmdSetSpeed and CmdStop for changing</span>
<span class="sd">the movement speed and abort an ongoing traversal, respectively.</span>
<span class="sd">To try out an exit of this type, you could connect two existing rooms</span>
<span class="sd">using something like this:</span>
<span class="sd">@open north:contrib.slow_exit.SlowExit = &lt;destination&gt;</span>
<span class="sd">Installation:</span>
<span class="sd">To make this your new default exit, modify mygame/typeclasses/exits.py</span>
<span class="sd">to import this module and change the default Exit class to inherit</span>
<span class="sd">from SlowExit instead.</span>
<span class="sd">To get the ability to change your speed and abort your movement,</span>
<span class="sd">simply import and add CmdSetSpeed and CmdStop from this module to your</span>
<span class="sd">default cmdset (see tutorials on how to do this if you are unsure).</span>
<span class="sd">Notes:</span>
<span class="sd">This implementation is efficient but not persistent; so incomplete</span>
<span class="sd">movement will be lost in a server reload. This is acceptable for most</span>
<span class="sd">game types - to simulate longer travel times (more than the couple of</span>
<span class="sd">seconds assumed here), a more persistent variant using Scripts or the</span>
<span class="sd">TickerHandler might be better.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">evennia</span> <span class="kn">import</span> <span class="n">DefaultExit</span><span class="p">,</span> <span class="n">utils</span><span class="p">,</span> <span class="n">Command</span>
<span class="n">MOVE_DELAY</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;stroll&quot;</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span> <span class="s2">&quot;walk&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> <span class="s2">&quot;run&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">&quot;sprint&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">}</span>
<div class="viewcode-block" id="SlowExit"><a class="viewcode-back" href="../../../api/evennia.contrib.slow_exit.html#evennia.contrib.slow_exit.SlowExit">[docs]</a><span class="k">class</span> <span class="nc">SlowExit</span><span class="p">(</span><span class="n">DefaultExit</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This overloads the way moving happens.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="SlowExit.at_traverse"><a class="viewcode-back" href="../../../api/evennia.contrib.slow_exit.html#evennia.contrib.slow_exit.SlowExit.at_traverse">[docs]</a> <span class="k">def</span> <span class="nf">at_traverse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">traversing_object</span><span class="p">,</span> <span class="n">target_location</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Implements the actual traversal, using utils.delay to delay the move_to.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># if the traverser has an Attribute move_speed, use that,</span>
<span class="c1"># otherwise default to &quot;walk&quot; speed</span>
<span class="n">move_speed</span> <span class="o">=</span> <span class="n">traversing_object</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">move_speed</span> <span class="ow">or</span> <span class="s2">&quot;walk&quot;</span>
<span class="n">move_delay</span> <span class="o">=</span> <span class="n">MOVE_DELAY</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">move_speed</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">move_callback</span><span class="p">():</span>
<span class="s2">&quot;This callback will be called by utils.delay after move_delay seconds.&quot;</span>
<span class="n">source_location</span> <span class="o">=</span> <span class="n">traversing_object</span><span class="o">.</span><span class="n">location</span>
<span class="k">if</span> <span class="n">traversing_object</span><span class="o">.</span><span class="n">move_to</span><span class="p">(</span><span class="n">target_location</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">at_after_traverse</span><span class="p">(</span><span class="n">traversing_object</span><span class="p">,</span> <span class="n">source_location</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">err_traverse</span><span class="p">:</span>
<span class="c1"># if exit has a better error message, let&#39;s use it.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">err_traverse</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># No shorthand error message. Call hook.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">at_failed_traverse</span><span class="p">(</span><span class="n">traversing_object</span><span class="p">)</span>
<span class="n">traversing_object</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You start moving </span><span class="si">%s</span><span class="s2"> at a </span><span class="si">%s</span><span class="s2">.&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="n">move_speed</span><span class="p">))</span>
<span class="c1"># create a delayed movement</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">delay</span><span class="p">(</span><span class="n">move_delay</span><span class="p">,</span> <span class="n">move_callback</span><span class="p">)</span>
<span class="c1"># we store the deferred on the character, this will allow us</span>
<span class="c1"># to abort the movement. We must use an ndb here since</span>
<span class="c1"># deferreds cannot be pickled.</span>
<span class="n">traversing_object</span><span class="o">.</span><span class="n">ndb</span><span class="o">.</span><span class="n">currently_moving</span> <span class="o">=</span> <span class="n">t</span></div></div>
<span class="c1">#</span>
<span class="c1"># set speed - command</span>
<span class="c1">#</span>
<span class="n">SPEED_DESCS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;stroll&quot;</span><span class="p">:</span> <span class="s2">&quot;strolling&quot;</span><span class="p">,</span> <span class="s2">&quot;walk&quot;</span><span class="p">:</span> <span class="s2">&quot;walking&quot;</span><span class="p">,</span> <span class="s2">&quot;run&quot;</span><span class="p">:</span> <span class="s2">&quot;running&quot;</span><span class="p">,</span> <span class="s2">&quot;sprint&quot;</span><span class="p">:</span> <span class="s2">&quot;sprinting&quot;</span><span class="p">}</span>
<div class="viewcode-block" id="CmdSetSpeed"><a class="viewcode-back" href="../../../api/evennia.contrib.slow_exit.html#evennia.contrib.slow_exit.CmdSetSpeed">[docs]</a><span class="k">class</span> <span class="nc">CmdSetSpeed</span><span class="p">(</span><span class="n">Command</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> set your movement speed</span>
<span class="sd"> Usage:</span>
<span class="sd"> setspeed stroll|walk|run|sprint</span>
<span class="sd"> This will set your movement speed, determining how long time</span>
<span class="sd"> it takes to traverse exits. If no speed is set, &#39;walk&#39; speed</span>
<span class="sd"> is assumed.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;setspeed&quot;</span>
<div class="viewcode-block" id="CmdSetSpeed.func"><a class="viewcode-back" href="../../../api/evennia.contrib.slow_exit.html#evennia.contrib.slow_exit.CmdSetSpeed.func">[docs]</a> <span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Simply sets an Attribute used by the SlowExit above.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">speed</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="n">speed</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">SPEED_DESCS</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;Usage: setspeed stroll||walk||run||sprint&quot;</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">move_speed</span> <span class="o">==</span> <span class="n">speed</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You are already </span><span class="si">%s</span><span class="s2">.&quot;</span> <span class="o">%</span> <span class="n">SPEED_DESCS</span><span class="p">[</span><span class="n">speed</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">move_speed</span> <span class="o">=</span> <span class="n">speed</span>
<span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You are now </span><span class="si">%s</span><span class="s2">.&quot;</span> <span class="o">%</span> <span class="n">SPEED_DESCS</span><span class="p">[</span><span class="n">speed</span><span class="p">])</span></div></div>
<span class="c1">#</span>
<span class="c1"># stop moving - command</span>
<span class="c1">#</span>
<div class="viewcode-block" id="CmdStop"><a class="viewcode-back" href="../../../api/evennia.contrib.slow_exit.html#evennia.contrib.slow_exit.CmdStop">[docs]</a><span class="k">class</span> <span class="nc">CmdStop</span><span class="p">(</span><span class="n">Command</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> stop moving</span>
<span class="sd"> Usage:</span>
<span class="sd"> stop</span>
<span class="sd"> Stops the current movement, if any.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;stop&quot;</span>
<div class="viewcode-block" id="CmdStop.func"><a class="viewcode-back" href="../../../api/evennia.contrib.slow_exit.html#evennia.contrib.slow_exit.CmdStop.func">[docs]</a> <span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This is a very simple command, using the</span>
<span class="sd"> stored deferred from the exit traversal above.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">currently_moving</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">ndb</span><span class="o">.</span><span class="n">currently_moving</span>
<span class="k">if</span> <span class="n">currently_moving</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">currently_moving</span><span class="o">.</span><span class="n">called</span><span class="p">:</span>
<span class="n">currently_moving</span><span class="o">.</span><span class="n">cancel</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You stop moving.&quot;</span><span class="p">)</span>
<span class="k">for</span> <span class="n">observer</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">location</span><span class="o">.</span><span class="n">contents_get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="p">):</span>
<span class="n">observer</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> stops.&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">get_display_name</span><span class="p">(</span><span class="n">observer</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You are not moving.&quot;</span><span class="p">)</span></div></div>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<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><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="slow_exit.html">1.0-dev (develop branch)</a></li>
<li><a href="../../../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="clearer"></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="nav-item nav-item-0"><a href="../../../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.slow_exit</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink