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/" / >
< title > Red Button example — 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" / >
< link rel = "next" title = "Talkative NPC example" href = "Contrib-Talking-Npc.html" / >
< link rel = "prev" title = "TutorialMirror" href = "Contrib-Mirror.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 = "right" >
< a href = "Contrib-Talking-Npc.html" title = "Talkative NPC example"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Mirror.html" title = "TutorialMirror"
accesskey="P">previous< / a > |< / li >
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
< 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 = "" > Red Button example< / a > < / li >
< / ul >
< div class = "develop" > develop branch< / div >
< / div >
< 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 = "#" > Red Button example< / a > < ul >
< li > < a class = "reference internal" href = "#technical" > Technical< / a > < / li >
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "Contrib-Mirror.html"
title="previous chapter">TutorialMirror< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "Contrib-Talking-Npc.html"
title="next chapter">Talkative NPC example< / a > < / p >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Contribs/Contrib-Red-Button.md.txt"
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 >
< 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 >
< h3 > Versions< / h3 >
< ul >
< li > < a href = "Contrib-Red-Button.html" > 1.0-dev (develop branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
< ul >
< li > < a href = "../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
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 = "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 >
< / div >
< p > Note that you must drop the button before you can see its messages! It’ s
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 button’ s 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 >
< / 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-Talking-Npc.html" title = "Talkative NPC example"
>next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Mirror.html" title = "TutorialMirror"
>previous< / a > |< / li >
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Red Button example< / a > < / li >
< / ul >
< div class = "develop" > develop branch< / div >
< / div >
< div class = "footer" role = "contentinfo" >
2022-11-15 19:52:44 +00:00
© Copyright 2022, 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 >