2023-06-10 08:55:41 +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/" / >
2023-10-19 20:22:27 +00:00
< title > Cooldowns — Evennia 2.x documentation< / title >
2023-06-10 08:55:41 +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 >
< 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 = "Crafting system" href = "Contrib-Crafting.html" / >
2023-10-19 20:22:27 +00:00
< link rel = "prev" title = "Containers" href = "Contrib-Containers.html" / >
2023-06-10 08:55:41 +02:00
< / head > < body >
2023-10-19 20:22:27 +00:00
2023-06-10 08:55:41 +02: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-Crafting.html" title = "Crafting system"
accesskey="N">next< / a > |< / li >
< li class = "right" >
2023-10-19 20:22:27 +00:00
< a href = "Contrib-Containers.html" title = "Containers"
2023-06-10 08:55:41 +02: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-06-10 08:55:41 +02: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 = "" > Cooldowns< / a > < / li >
< / ul >
< / 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 = "#" > Cooldowns< / a > < ul >
< li > < a class = "reference internal" href = "#installation" > Installation< / a > < / li >
< li > < a class = "reference internal" href = "#example" > Example< / a > < / li >
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
2023-10-19 20:22:27 +00:00
< p class = "topless" > < a href = "Contrib-Containers.html"
title="previous chapter">Containers< / a > < / p >
2023-06-10 08:55:41 +02:00
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "Contrib-Crafting.html"
title="next chapter">Crafting 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-Cooldowns.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 >
2023-06-10 08:55:41 +02: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 >
2023-10-19 19:49:53 +00:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "Contrib-Cooldowns.html" > 2.x (main branch)< / a > < / li >
2023-10-19 19:49:53 +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 >
2023-10-19 19:49:53 +00:00
< / ul >
2023-06-10 08:55:41 +02:00
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section class = "tex2jax_ignore mathjax_ignore" id = "cooldowns" >
< h1 > Cooldowns< a class = "headerlink" href = "#cooldowns" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Contribution by owllex, 2021< / p >
< p > Cooldowns are used to model rate-limited actions, like how often a
character can perform a given action; until a certain time has passed their
command can not be used again. This contrib provides a simple cooldown
handler that can be attached to any typeclass. A cooldown is a lightweight persistent
asynchronous timer that you can query to see if a certain time has yet passed.< / p >
< p > Cooldowns are completely asynchronous and must be queried to know their
state. They do not fire callbacks, so are not a good fit for use cases
where something needs to happen on a specific schedule (use delay or
a TickerHandler for that instead).< / p >
< p > See also the evennia < a class = "reference internal" href = "../Howtos/Howto-Command-Cooldown.html" > < span class = "doc std std-doc" > howto< / span > < / a > for more information
about the concept.< / p >
< section id = "installation" >
< h2 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > To use, simply add the following property to the typeclass definition of any
object type that you want to support cooldowns. It will expose a new < code class = "docutils literal notranslate" > < span class = "pre" > cooldowns< / span > < / code >
property that persists data to the object’
on your base < code class = "docutils literal notranslate" > < span class = "pre" > Object< / span > < / code > typeclass to enable cooldown tracking on every kind of
object, or just put it on your < code class = "docutils literal notranslate" > < span class = "pre" > Character< / span > < / code > typeclass.< / p >
< p > By default the CooldownHandler will use the < code class = "docutils literal notranslate" > < span class = "pre" > cooldowns< / span > < / code > property, but you can
customize this if desired by passing a different value for the < code class = "docutils literal notranslate" > < span class = "pre" > db_attribute< / span > < / code >
parameter.< / p >
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > from< / span > < span class = "nn" > evennia.contrib.game_systems.cooldowns< / span > < span class = "kn" > import< / span > < span class = "n" > CooldownHandler< / span >
< span class = "kn" > from< / span > < span class = "nn" > evennia.utils.utils< / span > < span class = "kn" > import< / span > < span class = "n" > lazy_property< / span >
< span class = "nd" > @lazy_property< / span >
< span class = "k" > def< / span > < span class = "nf" > cooldowns< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "k" > return< / span > < span class = "n" > CooldownHandler< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > db_attribute< / span > < span class = "o" > =< / span > < span class = "s2" > " cooldowns" < / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
< / section >
< section id = "example" >
< h2 > Example< a class = "headerlink" href = "#example" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Assuming you’
cooldown to limit how often you can perform a command. The following code
snippet will limit the use of a Power Attack command to once every 10 seconds
per character.< / p >
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "k" > class< / span > < span class = "nc" > PowerAttack< / span > < span class = "p" > (< / span > < span class = "n" > Command< / span > < span class = "p" > ):< / span >
< 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 = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > caller< / span > < span class = "o" > .< / span > < span class = "n" > cooldowns< / span > < span class = "o" > .< / span > < span class = "n" > ready< / span > < span class = "p" > (< / span > < span class = "s2" > " power attack" < / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > do_power_attack< / 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" > cooldowns< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "s2" > " power attack" < / span > < span class = "p" > ,< / span > < span class = "mi" > 10< / 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" > " That' s not ready yet!" < / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
< hr class = "docutils" / >
< p > < small > This document page is generated from < code class = "docutils literal notranslate" > < span class = "pre" > evennia/contrib/game_systems/cooldowns/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-Crafting.html" title = "Crafting system"
>next< / a > |< / li >
< li class = "right" >
2023-10-19 20:22:27 +00:00
< a href = "Contrib-Containers.html" title = "Containers"
2023-06-10 08:55:41 +02: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-06-10 08:55:41 +02: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 = "" > Cooldowns< / a > < / li >
< / ul >
< / div >
2023-10-19 20:22:27 +00:00
2023-06-10 08:55:41 +02:00
< div class = "footer" role = "contentinfo" >
2023-10-19 20:22:27 +00:00
© Copyright 2023, The Evennia developer community.
2023-06-10 08:55:41 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
< / div >
< / body >
< / html >
