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 > Adding Weather messages to a Room — 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" / >
2022-11-23 20:20:36 +00:00
< link rel = "next" title = "Adding room coordinates to your game" href = "Tutorial-Coordinates.html" / >
< link rel = "prev" title = "Changing game calendar and time speed" href = "Howto-Game-Time.html" / >
2022-11-14 22:43:45 +01:00
< / 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" >
2022-11-23 20:20:36 +00:00
< a href = "Tutorial-Coordinates.html" title = "Adding room coordinates to your game"
2022-11-14 22:43:45 +01:00
accesskey="N">next< / a > |< / li >
< li class = "right" >
2022-11-23 20:20:36 +00:00
< a href = "Howto-Game-Time.html" title = "Changing game calendar and time speed"
2022-11-14 22:43:45 +01:00
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 >
2023-12-20 18:20:52 +01:00
< li class = "nav-item nav-item-1" > < a href = "Howtos-Overview.html" accesskey = "U" > Tutorials and Howto’ < / a > » < / li >
2022-11-23 20:20:36 +00:00
< li class = "nav-item nav-item-this" > < a href = "" > Adding Weather messages to a Room< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
2023-12-20 18:20:52 +01: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 >
< h4 > Previous topic< / h4 >
2022-11-23 20:20:36 +00:00
< p class = "topless" > < a href = "Howto-Game-Time.html"
title="previous chapter">Changing game calendar and time speed< / a > < / p >
2022-11-14 22:43:45 +01:00
< h4 > Next topic< / h4 >
2022-11-20 23:39:28 +00:00
< p class = "topless" > < a href = "Tutorial-Coordinates.html"
2022-11-23 20:20:36 +00:00
title="next chapter">Adding room coordinates to your game< / a > < / p >
2022-11-14 22:43:45 +01:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
2022-11-23 20:20:36 +00:00
< li > < a href = "../_sources/Howtos/Tutorial-Weather-Effects.md.txt"
2022-11-14 22:43:45 +01:00
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 >
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2022-11-23 20:20:36 +00:00
< section class = "tex2jax_ignore mathjax_ignore" id = "adding-weather-messages-to-a-room" >
< h1 > Adding Weather messages to a Room< a class = "headerlink" href = "#adding-weather-messages-to-a-room" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > This tutorial will have us create a simple weather system for our MUD. The way we want to use this is to have all outdoor rooms echo weather-related messages to the room at regular and semi-random intervals. Things like “Clouds gather above”, “It starts to rain” and so on.< / p >
< p > One could imagine every outdoor room in the game having a script running on themselves that fires regularly. For this particular example it is however more efficient to do it another way, namely by using a “ticker-subscription” model.< / p >
< p > The principle is simple: Instead of having each Object individually track the time, they instead subscribe to be called by a global ticker who handles time keeping. Not only does this centralize and organize much of the code in one place, it also has less computing overhead.< / p >
< p > Evennia’ < a class = "reference internal" href = "../Components/TickerHandler.html" > < span class = "doc std std-doc" > TickerHandler< / span > < / a > specifically offers such a subscription model. We will use it for our weather system.< / p >
< p > We will create a new WeatherRoom typeclass that is aware of the day-night cycle.< / p >
< div class = "highlight-python notranslate" > < div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span class = "normal" > 1< / span >
< span class = "normal" > 2< / span >
< span class = "normal" > 3< / span >
< span class = "normal" > 4< / span >
< span class = "normal" > 5< / span >
< span class = "normal" > 6< / span >
< span class = "normal" > 7< / span >
< span class = "normal" > 8< / span >
< span class = "normal" > 9< / span >
< span class = "normal" > 10< / span >
< span class = "normal" > 11< / span >
< span class = "normal" > 12< / span >
< span class = "normal" > 13< / span >
< span class = "normal" > 14< / span >
< span class = "normal" > 15< / span >
< span class = "normal" > 16< / span >
< span class = "normal" > 17< / span >
< span class = "normal" > 18< / span >
< span class = "normal" > 19< / span >
< span class = "normal" > 20< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > random< / span >
2022-11-14 22:43:45 +01:00
< span class = "kn" > from< / span > < span class = "nn" > evennia< / span > < span class = "kn" > import< / span > < span class = "n" > DefaultRoom< / span > < span class = "p" > ,< / span > < span class = "n" > TICKER_HANDLER< / span >
< span class = "n" > ECHOES< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " The sky is clear." < / span > < span class = "p" > ,< / span >
< span class = "s2" > " Clouds gather overhead." < / span > < span class = "p" > ,< / span >
< span class = "s2" > " It' s starting to drizzle." < / span > < span class = "p" > ,< / span >
< span class = "s2" > " A breeze of wind is felt." < / span > < span class = "p" > ,< / span >
< span class = "s2" > " The wind is picking up" < / span > < span class = "p" > ]< / span > < span class = "c1" > # etc < / span >
< span class = "k" > class< / span > < span class = "nc" > WeatherRoom< / span > < span class = "p" > (< / span > < span class = "n" > DefaultRoom< / span > < span class = "p" > ):< / span >
< span class = "s2" > " This room is ticked at regular intervals" < / span >
< span class = "k" > def< / span > < span class = "nf" > at_object_creation< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "s2" > " called only when the object is first created" < / span >
< span class = "n" > TICKER_HANDLER< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "mi" > 60< / span > < span class = "o" > *< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > at_weather_update< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > at_weather_update< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "s2" > " ticked at regular intervals" < / span >
< span class = "n" > echo< / span > < span class = "o" > =< / span > < span class = "n" > random< / span > < span class = "o" > .< / span > < span class = "n" > choice< / span > < span class = "p" > (< / span > < span class = "n" > ECHOES< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > msg_contents< / span > < span class = "p" > (< / span > < span class = "n" > echo< / span > < span class = "p" > )< / span >
2022-11-23 20:20:36 +00:00
< / pre > < / div > < / td > < / tr > < / table > < / div >
2022-11-14 22:43:45 +01:00
< / div >
< p > In the < code class = "docutils literal notranslate" > < span class = "pre" > at_object_creation< / span > < / code > method, we simply added ourselves to the TickerHandler and tell it to
call < code class = "docutils literal notranslate" > < span class = "pre" > at_weather_update< / span > < / code > every hour (< code class = "docutils literal notranslate" > < span class = "pre" > 60*60< / span > < / code > seconds). During testing you might want to play with a
shorter time duration.< / p >
< p > For this to work we also create a custom hook < code class = "docutils literal notranslate" > < span class = "pre" > at_weather_update(*args,< / span > < span class = "pre" > **kwargs)< / span > < / code > , which is the
call sign required by TickerHandler hooks.< / p >
< p > Henceforth the room will inform everyone inside it when the weather changes. This particular example
is of course very simplistic - the weather echoes are just randomly chosen and don’
weather came before it. Expanding it to be more realistic is a useful exercise.< / p >
< / 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" >
2022-11-23 20:20:36 +00:00
< a href = "Tutorial-Coordinates.html" title = "Adding room coordinates to your game"
2022-11-14 22:43:45 +01:00
>next< / a > |< / li >
< li class = "right" >
2022-11-23 20:20:36 +00:00
< a href = "Howto-Game-Time.html" title = "Changing game calendar and time speed"
2022-11-14 22:43:45 +01:00
>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 >
2023-12-20 18:20:52 +01:00
< li class = "nav-item nav-item-1" > < a href = "Howtos-Overview.html" > Tutorials and Howto’ < / a > » < / li >
2022-11-23 20:20:36 +00:00
< li class = "nav-item nav-item-this" > < a href = "" > Adding Weather messages to a Room< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< 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 >
