mirror of
https://github.com/evennia/evennia.git
synced 2026-03-27 02:06:32 +01:00
751 lines
No EOL
52 KiB
HTML
751 lines
No EOL
52 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>evennia.contrib.clothing — 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>
|
||
<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> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.clothing</a></li>
|
||
</ul>
|
||
<div class="develop">develop branch</div>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="module-evennia.contrib.clothing">
|
||
<span id="evennia-contrib-clothing"></span><h1>evennia.contrib.clothing<a class="headerlink" href="#module-evennia.contrib.clothing" title="Permalink to this headline">¶</a></h1>
|
||
<p>Clothing - Provides a typeclass and commands for wearable clothing,
|
||
which is appended to a character’s description when worn.</p>
|
||
<p>Evennia contribution - Tim Ashley Jenkins 2017</p>
|
||
<p>Clothing items, when worn, are added to the character’s description
|
||
in a list. For example, if wearing the following clothing items:</p>
|
||
<blockquote>
|
||
<div><p>a thin and delicate necklace
|
||
a pair of regular ol’ shoes
|
||
one nice hat
|
||
a very pretty dress</p>
|
||
</div></blockquote>
|
||
<p>A character’s description may look like this:</p>
|
||
<blockquote>
|
||
<div><p>Superuser(#1)
|
||
This is User #1.</p>
|
||
<p>Superuser is wearing one nice hat, a thin and delicate necklace,
|
||
a very pretty dress and a pair of regular ol’ shoes.</p>
|
||
</div></blockquote>
|
||
<p>Characters can also specify the style of wear for their clothing - I.E.
|
||
to wear a scarf ‘tied into a tight knot around the neck’ or ‘draped
|
||
loosely across the shoulders’ - to add an easy avenue of customization.
|
||
For example, after entering:</p>
|
||
<blockquote>
|
||
<div><p>wear scarf draped loosely across the shoulders</p>
|
||
</div></blockquote>
|
||
<p>The garment appears like so in the description:</p>
|
||
<blockquote>
|
||
<div><p>Superuser(#1)
|
||
This is User #1.</p>
|
||
<p>Superuser is wearing a fanciful-looking scarf draped loosely
|
||
across the shoulders.</p>
|
||
</div></blockquote>
|
||
<p>Items of clothing can be used to cover other items, and many options
|
||
are provided to define your own clothing types and their limits and
|
||
behaviors. For example, to have undergarments automatically covered
|
||
by outerwear, or to put a limit on the number of each type of item
|
||
that can be worn. The system as-is is fairly freeform - you
|
||
can cover any garment with almost any other, for example - but it
|
||
can easily be made more restrictive, and can even be tied into a
|
||
system for armor or other equipment.</p>
|
||
<p>To install, import this module and have your default character
|
||
inherit from ClothedCharacter in your game’s characters.py file:</p>
|
||
<blockquote>
|
||
<div><p>from evennia.contrib.clothing import ClothedCharacter</p>
|
||
<p>class Character(ClothedCharacter):</p>
|
||
</div></blockquote>
|
||
<p>And then add ClothedCharacterCmdSet in your character set in your
|
||
game’s commands/default_cmdsets.py:</p>
|
||
<blockquote>
|
||
<div><p>from evennia.contrib.clothing import ClothedCharacterCmdSet</p>
|
||
<dl>
|
||
<dt>class CharacterCmdSet(default_cmds.CharacterCmdSet):</dt><dd><p>…
|
||
at_cmdset_creation(self):</p>
|
||
<blockquote>
|
||
<div><p>super().at_cmdset_creation()
|
||
…
|
||
self.add(ClothedCharacterCmdSet) # <– add this</p>
|
||
</div></blockquote>
|
||
</dd>
|
||
</dl>
|
||
</div></blockquote>
|
||
<p>From here, you can use the default builder commands to create clothes
|
||
with which to test the system:</p>
|
||
<blockquote>
|
||
<div><p>@create a pretty shirt : evennia.contrib.clothing.Clothing
|
||
@set shirt/clothing_type = ‘top’
|
||
wear shirt</p>
|
||
</div></blockquote>
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.clothing.order_clothes_list">
|
||
<code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">order_clothes_list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#order_clothes_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.order_clothes_list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Orders a given clothes list by the order specified in CLOTHING_TYPE_ORDER.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>clothes_list</strong> (<em>list</em>) – List of clothing items to put in order</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p><em>ordered_clothes_list (list)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>The same list as passed, but re-ordered</dt><dd><p>according to the hierarchy of clothing types
|
||
specified in CLOTHING_TYPE_ORDER.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.clothing.get_worn_clothes">
|
||
<code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">get_worn_clothes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">exclude_covered</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#get_worn_clothes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.get_worn_clothes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a list of clothes worn by a given character.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – The character to get a list of worn clothes from.</p>
|
||
</dd>
|
||
<dt class="field-even">Keyword Arguments</dt>
|
||
<dd class="field-even"><p><strong>exclude_covered</strong> (<em>bool</em>) – If True, excludes clothes covered by other
|
||
clothing from the returned list.</p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p><p><em>ordered_clothes_list (list)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>A list of clothing items worn by the</dt><dd><p>given character, ordered according to
|
||
the CLOTHING_TYPE_ORDER option specified
|
||
in this module.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.clothing.clothing_type_count">
|
||
<code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">clothing_type_count</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#clothing_type_count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.clothing_type_count" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a dictionary of the number of each clothing type
|
||
in a given list of clothing objects.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>clothes_list</strong> (<em>list</em>) – A list of clothing items from which
|
||
to count the number of clothing types
|
||
represented among them.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p><em>types_count (dict)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>A dictionary of clothing types represented</dt><dd><p>in the given list and the number of each
|
||
clothing type represented.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.clothing.single_type_count">
|
||
<code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">single_type_count</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em>, <em class="sig-param"><span class="n">type</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#single_type_count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.single_type_count" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns an integer value of the number of a given type of clothing in a list.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>clothes_list</strong> (<em>list</em>) – List of clothing objects to count from</p></li>
|
||
<li><p><strong>type</strong> (<em>str</em>) – Clothing type to count</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p><em>type_count (int)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>Number of garments of the specified type in the given</dt><dd><p>list of clothing objects</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.Clothing">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">Clothing</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">db_key</span></em>, <em class="sig-param"><span class="n">db_typeclass_path</span></em>, <em class="sig-param"><span class="n">db_date_created</span></em>, <em class="sig-param"><span class="n">db_lock_storage</span></em>, <em class="sig-param"><span class="n">db_account</span></em>, <em class="sig-param"><span class="n">db_sessid</span></em>, <em class="sig-param"><span class="n">db_location</span></em>, <em class="sig-param"><span class="n">db_home</span></em>, <em class="sig-param"><span class="n">db_destination</span></em>, <em class="sig-param"><span class="n">db_cmdset_storage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#Clothing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.Clothing" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.Clothing.wear">
|
||
<code class="sig-name descname">wear</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearer</span></em>, <em class="sig-param"><span class="n">wearstyle</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#Clothing.wear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.Clothing.wear" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets clothes to ‘worn’ and optionally echoes to the room.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>wearer</strong> (<em>obj</em>) – character object wearing this clothing object</p></li>
|
||
<li><p><strong>wearstyle</strong> (<em>True</em><em> or </em><em>str</em>) – string describing the style of wear or True for none</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Keyword Arguments</dt>
|
||
<dd class="field-even"><p><strong>quiet</strong> (<em>bool</em>) – If false, does not message the room</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>Optionally sets db.worn with a ‘wearstyle’ that appends a short passage to
|
||
the end of the name of the clothing to describe how it’s worn that shows
|
||
up in the wearer’s desc - I.E. ‘around his neck’ or ‘tied loosely around
|
||
her waist’. If db.worn is set to ‘True’ then just the name will be shown.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.Clothing.remove">
|
||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearer</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#Clothing.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.Clothing.remove" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Removes worn clothes and optionally echoes to the room.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>wearer</strong> (<em>obj</em>) – character object wearing this clothing object</p>
|
||
</dd>
|
||
<dt class="field-even">Keyword Arguments</dt>
|
||
<dd class="field-even"><p><strong>quiet</strong> (<em>bool</em>) – If false, does not message the room</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.Clothing.at_get">
|
||
<code class="sig-name descname">at_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">getter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#Clothing.at_get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.Clothing.at_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Makes absolutely sure clothes aren’t already set as ‘worn’
|
||
when they’re picked up, in case they’ve somehow had their
|
||
location changed without getting removed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.clothing.Clothing.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.clothing.Clothing.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.DoesNotExist" title="evennia.objects.objects.DefaultObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject.DoesNotExist</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.clothing.Clothing.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.clothing.Clothing.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.MultipleObjectsReturned" title="evennia.objects.objects.DefaultObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject.MultipleObjectsReturned</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.Clothing.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.clothing.Clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.Clothing.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.Clothing.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'Clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.Clothing.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacter">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">ClothedCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#ClothedCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||
<p>Character that displays worn clothing when looked at. You can also
|
||
just copy the return_appearance hook defined below to your own game’s
|
||
character typeclass.</p>
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacter.return_appearance">
|
||
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#ClothedCharacter.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This formats a description. It is the hook a ‘look’ command
|
||
should call.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>The name of every clothing item carried and worn by the character
|
||
is appended to their description. If the clothing’s db.worn value
|
||
is set to True, only the name is appended, but if the value is a
|
||
string, the string is appended to the end of the name, to allow
|
||
characters to specify how clothing is worn.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacter.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.DoesNotExist" title="evennia.objects.objects.DefaultCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.DoesNotExist</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacter.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned" title="evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacter.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.clothing.ClothedCharacter'</em><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacter.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'ClothedCharacter'</em><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.CmdWear">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdWear</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdWear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdWear" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>Puts on an item of clothing you are holding.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>wear <obj> [wear style]</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Examples</p>
|
||
<p>wear shirt
|
||
wear scarf wrapped loosely about the shoulders</p>
|
||
<p>All the clothes you are wearing are appended to your description.
|
||
If you provide a ‘wear style’ after the command, the message you
|
||
provide will be displayed after the clothing’s name.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdWear.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'wear'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdWear.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.CmdWear.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdWear.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdWear.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdWear.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdWear.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'wear', 'tags': '', 'text': "\n Puts on an item of clothing you are holding.\n\n Usage:\n wear <obj> [wear style]\n\n Examples:\n wear shirt\n wear scarf wrapped loosely about the shoulders\n\n All the clothes you are wearing are appended to your description.\n If you provide a 'wear style' after the command, the message you\n provide will be displayed after the clothing's name.\n "}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.CmdRemove">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdRemove</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdRemove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>Takes off an item of clothing.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>remove <obj></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Removes an item of clothing you are wearing. You can’t remove
|
||
clothes that are covered up by something else - you must take
|
||
off the covering item first.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdRemove.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'remove'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdRemove.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.CmdRemove.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdRemove.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdRemove.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdRemove.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdRemove.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'remove', 'tags': '', 'text': "\n Takes off an item of clothing.\n\n Usage:\n remove <obj>\n\n Removes an item of clothing you are wearing. You can't remove\n clothes that are covered up by something else - you must take\n off the covering item first.\n "}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.CmdCover">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdCover</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdCover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdCover" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>Covers a worn item of clothing with another you’re holding or wearing.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>cover <obj> [with] <obj></p>
|
||
</dd>
|
||
</dl>
|
||
<p>When you cover a clothing item, it is hidden and no longer appears in
|
||
your description until it’s uncovered or the item covering it is removed.
|
||
You can’t remove an item of clothing if it’s covered.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdCover.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'cover'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdCover.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.CmdCover.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdCover.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdCover.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdCover.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdCover.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'cover', 'tags': '', 'text': "\n Covers a worn item of clothing with another you're holding or wearing.\n\n Usage:\n cover <obj> [with] <obj>\n\n When you cover a clothing item, it is hidden and no longer appears in\n your description until it's uncovered or the item covering it is removed.\n You can't remove an item of clothing if it's covered.\n "}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.CmdUncover">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdUncover</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdUncover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>Reveals a worn item of clothing that’s currently covered up.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>uncover <obj></p>
|
||
</dd>
|
||
</dl>
|
||
<p>When you uncover an item of clothing, you allow it to appear in your
|
||
description without having to take off the garment that’s currently
|
||
covering it. You can’t uncover an item of clothing if the item covering
|
||
it is also covered by something else.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdUncover.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'uncover'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdUncover.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.CmdUncover.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdUncover.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdUncover.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdUncover.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdUncover.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'uncover', 'tags': '', 'text': "\n Reveals a worn item of clothing that's currently covered up.\n\n Usage:\n uncover <obj>\n\n When you uncover an item of clothing, you allow it to appear in your\n description without having to take off the garment that's currently\n covering it. You can't uncover an item of clothing if the item covering\n it is also covered by something else.\n "}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.CmdDrop">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdDrop</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdDrop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>drop something</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>drop <obj></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Lets you drop an object from your inventory into the
|
||
location you are currently in.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdDrop.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'drop'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdDrop.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdDrop.arg_regex">
|
||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('\\s|$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.CmdDrop.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdDrop.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implement command</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdDrop.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdDrop.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdDrop.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdDrop.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'drop', 'tags': '', 'text': '\n drop something\n\n Usage:\n drop <obj>\n\n Lets you drop an object from your inventory into the\n location you are currently in.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.CmdGive">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdGive</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdGive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdGive" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>give away something to someone</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>give <inventory obj> = <target></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Gives an items from your inventory to another character,
|
||
placing it in their inventory.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdGive.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'give'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdGive.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdGive.arg_regex">
|
||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('\\s|$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.CmdGive.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdGive.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implement give</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdGive.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdGive.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdGive.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdGive.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'give', 'tags': '', 'text': '\n give away something to someone\n\n Usage:\n give <inventory obj> = <target>\n\n Gives an items from your inventory to another character,\n placing it in their inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.CmdInventory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdInventory</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdInventory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>view inventory</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>inventory
|
||
inv</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Shows your inventory.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdInventory.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'inventory'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdInventory.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'inv']</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdInventory.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdInventory.arg_regex">
|
||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.CmdInventory.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdInventory.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>check inventory</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdInventory.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdInventory.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.CmdInventory.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacterCmdSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">ClothedCharacterCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#ClothedCharacterCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacterCmdSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.cmdset_character.html#evennia.commands.default.cmdset_character.CharacterCmdSet" title="evennia.commands.default.cmdset_character.CharacterCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_character.CharacterCmdSet</span></code></a></p>
|
||
<p>Command set for clothing, including new versions of ‘give’ and ‘drop’
|
||
that take worn and covered clothing into account, as well as a new
|
||
version of ‘inventory’ that differentiates between carried and worn
|
||
items.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacterCmdSet.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacterCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacterCmdSet.at_cmdset_creation">
|
||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#ClothedCharacterCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacterCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Populates the cmdset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.clothing.ClothedCharacterCmdSet.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.clothing.ClothedCharacterCmdSet'</em><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacterCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
|
||
|
||
<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.clothing.rst.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="evennia.contrib.clothing.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="../../0.9.5/api/evennia.contrib.clothing.html">0.9.5 (master 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> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.clothing</a></li>
|
||
</ul>
|
||
<div class="develop">develop branch</div>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |