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/" / >
2023-10-19 20:22:27 +00:00
< title > Slow Exit — Evennia 2.x documentation< / title >
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 = "Wilderness system" href = "Contrib-Wilderness.html" / >
< link rel = "prev" title = "SimpleDoor" href = "Contrib-Simpledoor.html" / >
< / head > < body >
2023-10-19 20:22:27 +00:00
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 = "Contrib-Wilderness.html" title = "Wilderness system"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Simpledoor.html" title = "SimpleDoor"
accesskey="P">previous< / a > |< / li >
2023-10-19 20:22:27 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" accesskey = "U" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Slow Exit< / a > < / li >
< / ul >
2023-06-10 08:53:19 +00:00
< / div >
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 >
< h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul >
< li > < a class = "reference internal" href = "#" > Slow Exit< / a > < ul >
< li > < a class = "reference internal" href = "#installation" > Installation:< / a > < / li >
< li > < a class = "reference internal" href = "#notes" > Notes:< / a > < / li >
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "Contrib-Simpledoor.html"
title="previous chapter">SimpleDoor< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "Contrib-Wilderness.html"
title="next chapter">Wilderness system< / a > < / p >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Contribs/Contrib-Slow-Exit.md.txt"
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / div > < h3 > Links< / h3 >
< ul >
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 >
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 >
2023-10-19 20:22:27 +00:00
< h3 > Doc Versions< / h3 >
2022-11-14 22:43:45 +01:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "Contrib-Slow-Exit.html" > 2.x (main branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
< ul >
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 >
2022-11-15 20:29:38 +00:00
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section class = "tex2jax_ignore mathjax_ignore" id = "slow-exit" >
< h1 > Slow Exit< a class = "headerlink" href = "#slow-exit" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Contribution by Griatch 2014< / p >
< p > An example of an Exit-type that delays its traversal. This simulates
slow movement, common in many games. The contrib also
contains two commands, < code class = "docutils literal notranslate" > < span class = "pre" > setspeed< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > stop< / span > < / code > for changing the movement speed
and abort an ongoing traversal, respectively.< / p >
< section id = "installation" >
< h2 > Installation:< a class = "headerlink" href = "#installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > To try out an exit of this type, you could connect two existing rooms
using something like this:< / p >
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > @open north:contrib.grid.slow_exit.SlowExit = < destination>
< / pre > < / div >
< / div >
< p > To make this your new default exit, modify < code class = "docutils literal notranslate" > < span class = "pre" > mygame/typeclasses/exits.py< / span > < / code >
to import this module and change the default < code class = "docutils literal notranslate" > < span class = "pre" > Exit< / span > < / code > class to inherit
from < code class = "docutils literal notranslate" > < span class = "pre" > SlowExit< / span > < / code > instead.< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # in mygame/typeclasses/exits.py< / span >
< span class = "kn" > from< / span > < span class = "nn" > evennia.contrib.grid.slowexit< / span > < span class = "kn" > import< / span > < span class = "n" > SlowExit< / span >
< span class = "k" > class< / span > < span class = "nc" > Exit< / span > < span class = "p" > (< / span > < span class = "n" > SlowExit< / span > < span class = "p" > ):< / span >
< span class = "c1" > # ...< / span >
< / pre > < / div >
< / div >
< p > To get the ability to change your speed and abort your movement, import< / p >
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # in mygame/commands/default_cmdsets.py< / span >
< span class = "kn" > from< / span > < span class = "nn" > evennia.contrib.grid< / span > < span class = "kn" > import< / span > < span class = "n" > slow_exit< / span > < span class = "o" > < ---< / span >
< span class = "k" > class< / span > < span class = "nc" > CharacterCmdSet< / span > < span class = "p" > (< / span > < span class = "n" > default_cmds< / span > < span class = "o" > .< / span > < span class = "n" > CharacterCmdSet< / span > < span class = "p" > ):< / span >
< span class = "c1" > # ...< / span >
< span class = "k" > def< / span > < span class = "nf" > at_cmdset_creation< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "c1" > # ...< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > slow_exit< / span > < span class = "o" > .< / span > < span class = "n" > SlowDoorCmdSet< / span > < span class = "p" > )< / span > < span class = "o" > < ---< / span >
< / pre > < / div >
< / div >
< p > simply import and add CmdSetSpeed and CmdStop from this module to your
default cmdset (see tutorials on how to do this if you are unsure).< / p >
< p > To try out an exit of this type, you could connect two existing rooms using
something like this:< / p >
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > @open north:contrib.grid.slow_exit.SlowExit = < destination>
< / pre > < / div >
< / div >
< / section >
< section id = "notes" >
< h2 > Notes:< a class = "headerlink" href = "#notes" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > This implementation is efficient but not persistent; so incomplete
movement will be lost in a server reload. This is acceptable for most
game types - to simulate longer travel times (more than the couple of
seconds assumed here), a more persistent variant using Scripts or the
TickerHandler might be better.< / p >
< hr class = "docutils" / >
< p > < small > This document page is generated from < code class = "docutils literal notranslate" > < span class = "pre" > evennia/contrib/grid/slow_exit/README.md< / span > < / code > . Changes to this
file will be overwritten, so edit that file rather than this one.< / small > < / p >
< / section >
< / 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 = "Contrib-Wilderness.html" title = "Wilderness system"
>next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Simpledoor.html" title = "SimpleDoor"
>previous< / a > |< / li >
2023-10-19 20:22:27 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Slow Exit< / a > < / li >
< / ul >
< / div >
2023-10-19 20:22:27 +00:00
2022-11-14 22:43:45 +01:00
< div class = "footer" role = "contentinfo" >
2023-10-19 20:22:27 +00:00
© Copyright 2023, The Evennia developer community.
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 >
