Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-01 13:37:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/6.x/api/evennia.contrib.tutorials.evadventure.equipment.html
Griatch 9e122e89ca Update with 6.x branch docs
2026-02-15 19:06:04 +01:00

444 lines
No EOL
35 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 lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>evennia.contrib.tutorials.evadventure.equipment &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="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.npcs" href="evennia.contrib.tutorials.evadventure.npcs.html" />
<link rel="prev" title="evennia.contrib.tutorials.evadventure.enums" href="evennia.contrib.tutorials.evadventure.enums.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<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.npcs.html" title="evennia.contrib.tutorials.evadventure.npcs"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.evadventure.enums.html" title="evennia.contrib.tutorials.evadventure.enums"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</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.equipment</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.tutorials.evadventure.equipment">
<span id="evennia-contrib-tutorials-evadventure-equipment"></span><h1>evennia.contrib.tutorials.evadventure.equipment<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.equipment" title="Link to this heading"></a></h1>
<p>Knave has a system of Slots for its inventory.</p>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentError">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.evadventure.equipment.</span></span><span class="sig-name descname"><span class="pre">EquipmentError</span></span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentError" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TypeError</span></code></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.evadventure.equipment.</span></span><span class="sig-name descname"><span class="pre">EquipmentHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>_Knave_ puts a lot of emphasis on the inventory. You have CON_DEFENSE inventory
slots. Some things, like torches can fit multiple in one slot, other (like
big weapons and armor) use more than one slot. The items carried and wielded has a big impact
on character customization - even magic requires carrying a runestone per spell.</p>
<p>The inventory also doubles as a measure of negative effects. Getting soaked in mud
or slime could gunk up some of your inventory slots and make the items there unusuable
until you clean them.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.save_attribute">
<span class="sig-name descname"><span class="pre">save_attribute</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'inventory_slots'</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.save_attribute" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.count_slots">
<span class="sig-name descname"><span class="pre">count_slots</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.count_slots"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.count_slots" title="Link to this definition"></a></dt>
<dd><p>Count slot usage. This is fetched from the .size Attribute of the
object. The size can also be partial slots.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.max_slots">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">max_slots</span></span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.max_slots" title="Link to this definition"></a></dt>
<dd><p>The max amount of equipment slots (‘carrying capacity’) is based on
the constitution defense.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.validate_slot_usage">
<span class="sig-name descname"><span class="pre">validate_slot_usage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.validate_slot_usage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.validate_slot_usage" title="Link to this definition"></a></dt>
<dd><p>Check if obj can fit in equipment, based on its size.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to add.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_current_slot">
<span class="sig-name descname"><span class="pre">get_current_slot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.get_current_slot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_current_slot" title="Link to this definition"></a></dt>
<dd><p>Check which slot-type the given object is in.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to check.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>WieldLocation</em> – A location the object is in. None if the object
is not in the inventory at all.</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.armor">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">armor</span></span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.armor" title="Link to this definition"></a></dt>
<dd><p>Armor provided by actually worn equipment/shield. For body armor
this is a base value, like 12, for shield/helmet, it’s a bonus, like +1.
We treat values and bonuses equal and just add them up. This value
can thus be 0, the ‘unarmored’ default should be handled by the calling
method.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>int</em> –</p>
<dl class="simple">
<dt>Armor from equipment. Note that this is the +bonus of Armor, not the</dt><dd><p>’defense’ (to get that one adds 10).</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.weapon">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">weapon</span></span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.weapon" title="Link to this definition"></a></dt>
<dd><p>Conveniently get the currently active weapon or rune stone.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>obj or None</em> – The weapon. None if unarmored.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_loadout">
<span class="sig-name descname"><span class="pre">display_loadout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.display_loadout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_loadout" title="Link to this definition"></a></dt>
<dd><p>Get a visual representation of your current loadout.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em> – The current loadout.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_backpack">
<span class="sig-name descname"><span class="pre">display_backpack</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.display_backpack"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_backpack" title="Link to this definition"></a></dt>
<dd><p>Get a visual representation of the backpack’s contents.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_slot_usage">
<span class="sig-name descname"><span class="pre">display_slot_usage</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.display_slot_usage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_slot_usage" title="Link to this definition"></a></dt>
<dd><p>Get a slot usage/max string for display.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em> – The usage string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.move">
<span class="sig-name descname"><span class="pre">move</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.move"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.move" title="Link to this definition"></a></dt>
<dd><p>Moves item to the place it things it should be in - this makes use of the object’s wield
slot to decide where it goes. The item is assumed to already be in the backpack.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – Thing to use.</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentError" title="evennia.contrib.tutorials.evadventure.equipment.EquipmentError"><strong>EquipmentError</strong></a> – If there’s no room in inventory. It will contains the details
of the error, suitable to echo to user.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This will cleanly move any ‘colliding’ items to the backpack to
make the use possible (such as moving sword + shield to backpack when wielding
a two-handed weapon). If wanting to warn the user about this, it needs to happen
before this call.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.add" title="Link to this definition"></a></dt>
<dd><p>Put something in the backpack specifically (even if it could be wield/worn).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to add.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This will not change the object’s <strong>.location</strong>, this must be done
by the calling code.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj_or_slot</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.remove"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.remove" title="Link to this definition"></a></dt>
<dd><p>Remove specific object or objects from a slot.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj_or_slot</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a><em> or </em><a class="reference internal" href="evennia.contrib.tutorials.evadventure.enums.html#evennia.contrib.tutorials.evadventure.enums.WieldLocation" title="evennia.contrib.tutorials.evadventure.enums.WieldLocation"><em>WieldLocation</em></a>) – The specific object or
location to empty. If this is WieldLocation.BACKPACK, all items
in the backpack will be emptied and returned!</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>list</em> – A list of 0, 1 or more objects emptied from the inventory.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This will not change the object’s <strong>.location</strong>, this must be done separately
by the calling code.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wieldable_objects_from_backpack">
<span class="sig-name descname"><span class="pre">get_wieldable_objects_from_backpack</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.get_wieldable_objects_from_backpack"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wieldable_objects_from_backpack" title="Link to this definition"></a></dt>
<dd><p>Get all wieldable weapons (or spell runes) from backpack. This is useful in order to
have a list to select from when swapping your wielded loadout.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>list</em> – A list of objects with a suitable <strong>inventory_use_slot</strong>. We don’t check
quality, so this may include broken items (we may want to visually show them
in the list after all).</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wearable_objects_from_backpack">
<span class="sig-name descname"><span class="pre">get_wearable_objects_from_backpack</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.get_wearable_objects_from_backpack"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wearable_objects_from_backpack" title="Link to this definition"></a></dt>
<dd><p>Get all wearable items (armor or helmets) from backpack. This is useful in order to
have a list to select from when swapping your worn loadout.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>list</em> – A list of objects with a suitable <strong>inventory_use_slot</strong>. We don’t check
quality, so this may include broken items (we may want to visually show them
in the list after all).</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_usable_objects_from_backpack">
<span class="sig-name descname"><span class="pre">get_usable_objects_from_backpack</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.get_usable_objects_from_backpack"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_usable_objects_from_backpack" title="Link to this definition"></a></dt>
<dd><p>Get all ‘usable’ items (like potions) from backpack. This is useful for getting a
list to select from.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>list</em> – A list of objects that are usable.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.all">
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">only_objs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.all"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.all" title="Link to this definition"></a></dt>
<dd><p>Get all objects in inventory, regardless of location.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>only_objs</strong> (<em>bool</em>) – Only return a flat list of objects, not tuples.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>list</em> – A list of item tuples <strong>[(item, WieldLocation),…]</strong>
starting with the wielded ones, backpack content last. If <strong>only_objs</strong> is set,
this will just be a flat list of objects.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.tutorials.evadventure.equipment</a><ul>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentError"><code class="docutils literal notranslate"><span class="pre">EquipmentError</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.save_attribute"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.save_attribute</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.__init__"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.__init__()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.count_slots"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.count_slots()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.max_slots"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.max_slots</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.validate_slot_usage"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.validate_slot_usage()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_current_slot"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.get_current_slot()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.armor"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.armor</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.weapon"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.weapon</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_loadout"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.display_loadout()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_backpack"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.display_backpack()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_slot_usage"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.display_slot_usage()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.move"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.move()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.add"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.add()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.remove"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.remove()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wieldable_objects_from_backpack"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.get_wieldable_objects_from_backpack()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wearable_objects_from_backpack"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.get_wearable_objects_from_backpack()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_usable_objects_from_backpack"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.get_usable_objects_from_backpack()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.all"><code class="docutils literal notranslate"><span class="pre">EquipmentHandler.all()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.enums.html"
title="previous chapter">evennia.contrib.tutorials.evadventure.enums</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.npcs.html"
title="next chapter">evennia.contrib.tutorials.evadventure.npcs</a></p>
</div>
<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.equipment.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="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/6.x/index.html">v6.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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.npcs.html" title="evennia.contrib.tutorials.evadventure.npcs"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.evadventure.enums.html" title="evennia.contrib.tutorials.evadventure.enums"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</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.equipment</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink