Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 22:36:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/api/evennia.contrib.html
Griatch 92c6c7ccd2 Updated HTML docs
2021-10-26 22:36:27 +02:00

269 lines
No EOL
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 &#8212; 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>
<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>
<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>
<li class="nav-item nav-item-this"><a href="">evennia.contrib</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib">
<span id="evennia-contrib"></span><h1>evennia.contrib<a class="headerlink" href="#module-evennia.contrib" title="Permalink to this headline"></a></h1>
<p>This sub-package holds Evennia’s contributions - code that may be
useful but are deemed too game-specific to go into the core library.</p>
<p>See README.md for more info.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.barter.html">evennia.contrib.barter</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.building_menu.html">evennia.contrib.building_menu</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.chargen.html">evennia.contrib.chargen</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.clothing.html">evennia.contrib.clothing</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.color_markups.html">evennia.contrib.color_markups</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.custom_gametime.html">evennia.contrib.custom_gametime</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.dice.html">evennia.contrib.dice</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.email_login.html">evennia.contrib.email_login</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.extended_room.html">evennia.contrib.extended_room</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.fieldfill.html">evennia.contrib.fieldfill</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.gendersub.html">evennia.contrib.gendersub</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.health_bar.html">evennia.contrib.health_bar</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.mail.html">evennia.contrib.mail</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.mapbuilder.html">evennia.contrib.mapbuilder</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.menu_login.html">evennia.contrib.menu_login</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.multidescer.html">evennia.contrib.multidescer</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.puzzles.html">evennia.contrib.puzzles</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.random_string_generator.html">evennia.contrib.random_string_generator</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rplanguage.html">evennia.contrib.rplanguage</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.rpsystem.html">evennia.contrib.rpsystem</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.simpledoor.html">evennia.contrib.simpledoor</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.slow_exit.html">evennia.contrib.slow_exit</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.talking_npc.html">evennia.contrib.talking_npc</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.test_traits.html">evennia.contrib.test_traits</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.traits.html">evennia.contrib.traits</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.traits.html#adding-traits-to-a-typeclass">Adding Traits to a typeclass</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.traits.html#traits-with-traithandler">Traits with TraitHandler</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.traits.html#traitproperties">TraitProperties</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.traits.html#using-traits">Using traits</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.traits.html#trait-types">Trait types</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.traits.html#static-trait">Static trait</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.traits.html#counter">Counter</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.traits.html#descs">.descs</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.traits.html#rate">.rate</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.traits.html#percent">.percent()</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.traits.html#gauge">Gauge</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.traits.html#trait">Trait</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.traits.html#expanding-with-your-own-traits">Expanding with your own Traits</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tree_select.html">evennia.contrib.tree_select</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.unixcommand.html">evennia.contrib.unixcommand</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.wilderness.html">evennia.contrib.wilderness</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.awsstorage.html">evennia.contrib.awsstorage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.awsstorage.aws_s3_cdn.html">evennia.contrib.awsstorage.aws_s3_cdn</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.awsstorage.tests.html">evennia.contrib.awsstorage.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.crafting.html">evennia.contrib.crafting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.crafting.crafting.html">evennia.contrib.crafting.crafting</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.crafting.crafting.html#installation">Installation</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.crafting.crafting.html#crafting-in-game">Crafting in game</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.crafting.crafting.html#crafting-in-code">Crafting in code</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.crafting.crafting.html#recipes">Recipes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.crafting.example_recipes.html">evennia.contrib.crafting.example_recipes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.crafting.example_recipes.html#sword-crafting-tree">Sword crafting tree</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.crafting.example_recipes.html#recipes-used-for-spell-casting">Recipes used for spell casting</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.crafting.tests.html">evennia.contrib.crafting.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.html">evennia.contrib.evscaperoom</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.evscaperoom.commands.html">evennia.contrib.evscaperoom.commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.evscaperoom.menu.html">evennia.contrib.evscaperoom.menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.evscaperoom.objects.html">evennia.contrib.evscaperoom.objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.evscaperoom.room.html">evennia.contrib.evscaperoom.room</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.evscaperoom.scripts.html">evennia.contrib.evscaperoom.scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.evscaperoom.state.html">evennia.contrib.evscaperoom.state</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.evscaperoom.tests.html">evennia.contrib.evscaperoom.tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.evscaperoom.utils.html">evennia.contrib.evscaperoom.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.html">evennia.contrib.ingame_python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.callbackhandler.html">evennia.contrib.ingame_python.callbackhandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.commands.html">evennia.contrib.ingame_python.commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.eventfuncs.html">evennia.contrib.ingame_python.eventfuncs</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.scripts.html">evennia.contrib.ingame_python.scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.tests.html">evennia.contrib.ingame_python.tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.typeclasses.html">evennia.contrib.ingame_python.typeclasses</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.utils.html">evennia.contrib.ingame_python.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.security.html">evennia.contrib.security</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.security.auditing.html">evennia.contrib.security.auditing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.security.auditing.outputs.html">evennia.contrib.security.auditing.outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.security.auditing.server.html">evennia.contrib.security.auditing.server</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.security.auditing.tests.html">evennia.contrib.security.auditing.tests</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.turnbattle.html">evennia.contrib.turnbattle</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.turnbattle.tb_basic.html">evennia.contrib.turnbattle.tb_basic</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.turnbattle.tb_equip.html">evennia.contrib.turnbattle.tb_equip</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.turnbattle.tb_items.html">evennia.contrib.turnbattle.tb_items</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.turnbattle.tb_magic.html">evennia.contrib.turnbattle.tb_magic</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.turnbattle.tb_range.html">evennia.contrib.turnbattle.tb_range</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorial_examples.html">evennia.contrib.tutorial_examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_examples.bodyfunctions.html">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_examples.example_batch_code.html">evennia.contrib.tutorial_examples.example_batch_code</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_examples.mirror.html">evennia.contrib.tutorial_examples.mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button.html">evennia.contrib.tutorial_examples.red_button</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button.html#technical">Technical</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_examples.tests.html">evennia.contrib.tutorial_examples.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorial_world.html">evennia.contrib.tutorial_world</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_world.intro_menu.html">evennia.contrib.tutorial_world.intro_menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_world.mob.html">evennia.contrib.tutorial_world.mob</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_world.objects.html">evennia.contrib.tutorial_world.objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_world.rooms.html">evennia.contrib.tutorial_world.rooms</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.xyzgrid.html">evennia.contrib.xyzgrid</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.commands.html">evennia.contrib.xyzgrid.commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.example.html">evennia.contrib.xyzgrid.example</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.launchcmd.html">evennia.contrib.xyzgrid.launchcmd</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.prototypes.html">evennia.contrib.xyzgrid.prototypes</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.tests.html">evennia.contrib.xyzgrid.tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.utils.html">evennia.contrib.xyzgrid.utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.xymap.html">evennia.contrib.xyzgrid.xymap</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.xyzgrid.xymap.html#xymap">XYMap</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.xymap_legend.html">evennia.contrib.xyzgrid.xymap_legend</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.xyzgrid.xymap_legend.html#map-legend-components">Map legend components</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.xyzgrid.html">evennia.contrib.xyzgrid.xyzgrid</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.xyzgrid.xyzroom.html">evennia.contrib.xyzgrid.xyzroom</a></li>
</ul>
</li>
</ul>
</div>
</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>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.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="evennia.contrib.html">1.0-dev (develop branch)</a></li>
<li><a href="../../0.9.5/api/evennia.contrib.html">0.9.5 (v0.9.5 branch)</a></li>
</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>
<li class="nav-item nav-item-this"><a href="">evennia.contrib</a></li>
</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>
Reference in a new issue View git blame Copy permalink