Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 06:16:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/2.x/api/evennia.contrib.rpg.html
Evennia docbuilder action e535f5782a Updated HTML docs.
2023-10-19 20:22:27 +00:00

243 lines
No EOL
14 KiB
HTML
Raw Blame History

<!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>evennia.contrib.rpg &#8212; Evennia 2.x 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="evennia.contrib.rpg.buffs" href="evennia.contrib.rpg.buffs.html" />
<link rel="prev" title="evennia.contrib.grid.xyzgrid.xyzroom" href="evennia.contrib.grid.xyzgrid.xyzroom.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="evennia.contrib.rpg.buffs.html" title="evennia.contrib.rpg.buffs"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.grid.xyzgrid.xyzroom.html" title="evennia.contrib.grid.xyzgrid.xyzroom"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" accesskey="U">evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.rpg</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>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.grid.xyzgrid.xyzroom.html"
title="previous chapter">evennia.contrib.grid.xyzgrid.xyzroom</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.rpg.buffs.html"
title="next chapter">evennia.contrib.rpg.buffs</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.rpg.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<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>
<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>Doc Versions</h3>
<ul>
<li><a href="evennia.contrib.rpg.html">2.x (main branch)</a></li>
<ul>
<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>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.rpg">
<span id="evennia-contrib-rpg"></span><h1>evennia.contrib.rpg<a class="headerlink" href="#module-evennia.contrib.rpg" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rpg.buffs.html">evennia.contrib.rpg.buffs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.buffs.buff.html">evennia.contrib.rpg.buffs.buff</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.buffs.buff.html#installation">Installation</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.buffs.buff.html#using-the-handler">Using the Handler</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.buffs.buff.html#applying-a-buff">Applying a Buff</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.buffs.buff.html#modify">Modify</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.buffs.buff.html#trigger">Trigger</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.buffs.buff.html#tick">Tick</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.buffs.buff.html#buffs">Buffs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.buffs.samplebuffs.html">evennia.contrib.rpg.buffs.samplebuffs</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.buffs.tests.html">evennia.contrib.rpg.buffs.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rpg.character_creator.html">evennia.contrib.rpg.character_creator</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.character_creator.character_creator.html">evennia.contrib.rpg.character_creator.character_creator</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.character_creator.character_creator.html#features">Features</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.character_creator.character_creator.html#usage">Usage</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.character_creator.example_menu.html">evennia.contrib.rpg.character_creator.example_menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.character_creator.tests.html">evennia.contrib.rpg.character_creator.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rpg.dice.html">evennia.contrib.rpg.dice</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.dice.dice.html">evennia.contrib.rpg.dice.dice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.dice.dice.html#dice">Dice</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.dice.dice.html#installation">Installation:</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.dice.dice.html#usage">Usage:</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.dice.tests.html">evennia.contrib.rpg.dice.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rpg.health_bar.html">evennia.contrib.rpg.health_bar</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.health_bar.health_bar.html">evennia.contrib.rpg.health_bar.health_bar</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.health_bar.tests.html">evennia.contrib.rpg.health_bar.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rpg.llm.html">evennia.contrib.rpg.llm</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.llm.llm_client.html">evennia.contrib.rpg.llm.llm_client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.llm.llm_client.html#optional-evennia-settings-if-not-given-these-defaults-are-used">Optional Evennia settings (if not given, these defaults are used)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.llm.llm_npc.html">evennia.contrib.rpg.llm.llm_npc</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.llm.tests.html">evennia.contrib.rpg.llm.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.html">evennia.contrib.rpg.rpsystem</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.rplanguage.html">evennia.contrib.rpg.rpsystem.rplanguage</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.rplanguage.html#usage">Usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.rplanguage.html#custom-languages">Custom languages</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.rplanguage.html#example">Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.rpsystem.html">evennia.contrib.rpg.rpsystem.rpsystem</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.tests.html">evennia.contrib.rpg.rpsystem.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rpg.traits.html">evennia.contrib.rpg.traits</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.traits.tests.html">evennia.contrib.rpg.traits.tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html">evennia.contrib.rpg.traits.traits</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#installation">Installation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#traits-with-traithandler">Traits with TraitHandler</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#traitproperties">TraitProperties</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#using-traits">Using traits</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#trait-types">Trait types</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#static-trait">Static trait</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#counter">Counter</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#descs">.descs</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#rate">.rate</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#percent">.percent()</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#gauge">Gauge</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#trait">Trait</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#expanding-with-your-own-traits">Expanding with your own Traits</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</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="evennia.contrib.rpg.buffs.html" title="evennia.contrib.rpg.buffs"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.grid.xyzgrid.xyzroom.html" title="evennia.contrib.grid.xyzgrid.xyzroom"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.rpg</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink