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

329 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.tutorials.evadventure.enums &#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.tutorials.evadventure.equipment" href="evennia.contrib.tutorials.evadventure.equipment.html" />
<link rel="prev" title="evennia.contrib.tutorials.evadventure.dungeon" href="evennia.contrib.tutorials.evadventure.dungeon.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.tutorials.evadventure.equipment.html" title="evennia.contrib.tutorials.evadventure.equipment"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.evadventure.dungeon.html" title="evennia.contrib.tutorials.evadventure.dungeon"
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" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.enums</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.tutorials.evadventure.dungeon.html"
title="previous chapter">evennia.contrib.tutorials.evadventure.dungeon</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.equipment.html"
title="next chapter">evennia.contrib.tutorials.evadventure.equipment</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.tutorials.evadventure.enums.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.tutorials.evadventure.enums.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.tutorials.evadventure.enums">
<span id="evennia-contrib-tutorials-evadventure-enums"></span><h1>evennia.contrib.tutorials.evadventure.enums<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.enums" title="Permalink to this headline"></a></h1>
<p>Enums are constants representing different things in EvAdventure. The advantage
of using an Enum over, say, a string is that if you make a typo using an unknown
enum, Python will give you an error while a typo in a string may go through silently.</p>
<p>It’s used as a direct reference:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">enums</span> <span class="kn">import</span> <span class="n">Ability</span>
<span class="k">if</span> <span class="n">abi</span> <span class="ow">is</span> <span class="n">Ability</span><span class="o">.</span><span class="n">STR</span><span class="p">:</span>
<span class="c1"># ...</span>
</pre></div>
</div>
<p>To get the <strong>value</strong> of an enum (must always be hashable, useful for Attribute lookups), use
<strong>Ability.STR.value</strong> (which would return ‘strength’ in our case).</p>
<hr class="docutils" />
<dl class="py class">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.enums.</code><code class="sig-name descname">Ability</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/enums.html#Ability"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>The six base abilities (defense is always bonus + 10)</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.STR">
<code class="sig-name descname">STR</code><em class="property"> = 'strength'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.STR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.DEX">
<code class="sig-name descname">DEX</code><em class="property"> = 'dexterity'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.DEX" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.CON">
<code class="sig-name descname">CON</code><em class="property"> = 'constitution'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.CON" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.INT">
<code class="sig-name descname">INT</code><em class="property"> = 'intelligence'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.INT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.WIS">
<code class="sig-name descname">WIS</code><em class="property"> = 'wisdom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.WIS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.CHA">
<code class="sig-name descname">CHA</code><em class="property"> = 'charisma'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.CHA" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.ARMOR">
<code class="sig-name descname">ARMOR</code><em class="property"> = 'armor'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.ARMOR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.CRITICAL_FAILURE">
<code class="sig-name descname">CRITICAL_FAILURE</code><em class="property"> = 'critical_failure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.CRITICAL_FAILURE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.CRITICAL_SUCCESS">
<code class="sig-name descname">CRITICAL_SUCCESS</code><em class="property"> = 'critical_success'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.CRITICAL_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_HOSTILE">
<code class="sig-name descname">ALLEGIANCE_HOSTILE</code><em class="property"> = 'hostile'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_HOSTILE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_NEUTRAL">
<code class="sig-name descname">ALLEGIANCE_NEUTRAL</code><em class="property"> = 'neutral'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_NEUTRAL" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_FRIENDLY">
<code class="sig-name descname">ALLEGIANCE_FRIENDLY</code><em class="property"> = 'friendly'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_FRIENDLY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.enums.</code><code class="sig-name descname">WieldLocation</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/enums.html#WieldLocation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>Wield (or wear) locations.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.BACKPACK">
<code class="sig-name descname">BACKPACK</code><em class="property"> = 'backpack'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.BACKPACK" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.WEAPON_HAND">
<code class="sig-name descname">WEAPON_HAND</code><em class="property"> = 'weapon_hand'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.WEAPON_HAND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.SHIELD_HAND">
<code class="sig-name descname">SHIELD_HAND</code><em class="property"> = 'shield_hand'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.SHIELD_HAND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.TWO_HANDS">
<code class="sig-name descname">TWO_HANDS</code><em class="property"> = 'two_handed_weapons'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.TWO_HANDS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.BODY">
<code class="sig-name descname">BODY</code><em class="property"> = 'body'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.BODY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.HEAD">
<code class="sig-name descname">HEAD</code><em class="property"> = 'head'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.HEAD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.enums.</code><code class="sig-name descname">ObjType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/enums.html#ObjType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>Object types</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.WEAPON">
<code class="sig-name descname">WEAPON</code><em class="property"> = 'weapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.WEAPON" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.ARMOR">
<code class="sig-name descname">ARMOR</code><em class="property"> = 'armor'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.ARMOR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.SHIELD">
<code class="sig-name descname">SHIELD</code><em class="property"> = 'shield'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.SHIELD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.HELMET">
<code class="sig-name descname">HELMET</code><em class="property"> = 'helmet'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.HELMET" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.CONSUMABLE">
<code class="sig-name descname">CONSUMABLE</code><em class="property"> = 'consumable'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.CONSUMABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.GEAR">
<code class="sig-name descname">GEAR</code><em class="property"> = 'gear'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.GEAR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.THROWABLE">
<code class="sig-name descname">THROWABLE</code><em class="property"> = 'throwable'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.THROWABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.MAGIC">
<code class="sig-name descname">MAGIC</code><em class="property"> = 'magic'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.MAGIC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.QUEST">
<code class="sig-name descname">QUEST</code><em class="property"> = 'quest'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.QUEST" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.TREASURE">
<code class="sig-name descname">TREASURE</code><em class="property"> = 'treasure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.TREASURE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</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.tutorials.evadventure.equipment.html" title="evennia.contrib.tutorials.evadventure.equipment"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.evadventure.dungeon.html" title="evennia.contrib.tutorials.evadventure.dungeon"
>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-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.enums</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