evennia/docs/1.0-dev/Contribs/Contrib-Red-Button.html

151 lines
6.9 KiB
HTML
Raw Normal View History

2021-07-23 00:25:23 +02: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/" />
2022-01-08 16:38:41 +01:00
<title>Red Button example &#8212; Evennia 1.0-dev documentation</title>
2021-07-23 00:25:23 +02: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>
2021-10-26 21:41:11 +02:00
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
2021-07-23 00:25:23 +02:00
<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>
2022-01-08 16:38:41 +01:00
<li class="nav-item nav-item-this"><a href="">Red Button example</a></li>
2021-07-23 00:25:23 +02:00
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
2022-01-08 16:38:41 +01:00
<section class="tex2jax_ignore mathjax_ignore" id="red-button-example">
<h1>Red Button example<a class="headerlink" href="#red-button-example" title="Permalink to this headline"></a></h1>
<p>Contribution by Griatch, 2011</p>
<p>A red button that you can press to have an effect. This is a more advanced example
object with its own functionality and state tracking.</p>
<p>Create the button with</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>create/drop button:tutorials.red_button.RedButton
</pre></div>
2021-07-23 00:25:23 +02:00
</div>
2022-01-08 16:38:41 +01:00
<p>Note that you must drop the button before you can see its messages! Its
imperative that you press the red button. You know you want to.</p>
<p>Use <code class="docutils literal notranslate"><span class="pre">del</span> <span class="pre">button</span></code> to destroy/stop the button when you are done playing.</p>
<section id="technical">
<h2>Technical<a class="headerlink" href="#technical" title="Permalink to this headline"></a></h2>
<p>The buttons functionality is controlled by CmdSets that gets added and removed
depending on the state the button is in.</p>
<ul class="simple">
<li><p>Lid-closed state: In this state the button is covered by a glass cover and
trying to push it will fail. You can nudge, smash or open the lid.</p></li>
<li><p>Lid-open state: In this state the lid is open but will close again after a
certain time. Using push now will press the button and trigger the
Blind-state.</p></li>
<li><p>Blind-state: In this mode you are blinded by a bright flash. This will affect
your normal commands like look and help until the blindness wears off after
a certain time.</p></li>
</ul>
<p>Timers are handled by persistent delays on the button. These are examples of
<code class="docutils literal notranslate"><span class="pre">evennia.utils.utils.delay</span></code> calls that wait a certain time before calling a
method - such as when closing the lid and un-blinding a character.</p>
<hr class="docutils" />
<p><small>This document page is generated from <code class="docutils literal notranslate"><span class="pre">evennia/contrib/tutorials/red_button/README.md</span></code>. Changes to this
file will be overwritten, so edit that file rather than this one.</small></p>
</section>
2021-07-23 00:25:23 +02:00
</section>
<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>
2022-01-08 16:38:41 +01:00
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Red Button example</a><ul>
<li><a class="reference internal" href="#technical">Technical</a></li>
</ul>
</li>
</ul>
2021-07-23 00:25:23 +02:00
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
2022-01-08 16:38:41 +01:00
<li><a href="../_sources/Contribs/Contrib-Red-Button.md.txt"
2021-07-23 00:25:23 +02:00
rel="nofollow">Show Page Source</a></li>
</ul>
</div><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>
2021-08-06 00:47:51 +02:00
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
2021-08-06 00:53:44 +02:00
<a href="https://evennia.blogspot.com/">Blog</a>
2021-07-23 00:25:23 +02:00
</li>
</ul>
<h3>Versions</h3>
<ul>
2022-01-08 16:38:41 +01:00
<li><a href="Contrib-Red-Button.html">1.0-dev (develop branch)</a></li>
2021-07-23 00:25:23 +02:00
</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>
2022-01-08 16:38:41 +01:00
<li class="nav-item nav-item-this"><a href="">Red Button example</a></li>
2021-07-23 00:25:23 +02:00
</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>