mirror of
https://github.com/evennia/evennia.git
synced 2026-03-22 15:56:30 +01:00
Updated HTML docs
This commit is contained in:
Evennia docbuilder action
parent
937794ad0b
commit
dcc4cbe66f
316 changed files with 34330 additions and 3279 deletions
|
|
@ -275,58 +275,6 @@ and filtering.</p>
|
|||
location having the property destination != <strong>None</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_name">
|
||||
<code class="sig-name descname">get_display_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span><span class="o">=</span><span class="default_value">None</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/objects/objects.html#DefaultObject.get_display_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Displays the name of the object in a viewer-aware manner.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>looker</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – The object or account that is looking
|
||||
at/getting inforamtion for this object.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>name (str)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>A string containing the name of the object,</dt><dd><p>including the DBREF if this user is privileged to control
|
||||
said object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This function could be extended to change how object names
|
||||
appear to users in character, but be wary. This function
|
||||
does not change an object’s keys or aliases when
|
||||
searching, and is expected to produce something useful for
|
||||
builders.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_numbered_name">
|
||||
<code class="sig-name descname">get_numbered_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">count</span></em>, <em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_numbered_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_numbered_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the numbered (singular, plural) forms of this object’s key. This is by default called
|
||||
by return_appearance and is used for grouping multiple same-named of this object. Note that
|
||||
this will be called on <em>every</em> member of a group even though the plural name will be only
|
||||
shown once. Also the singular display version, such as ‘an apple’, ‘a tree’ is determined
|
||||
from this method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>count</strong> (<em>int</em>) – Number of objects of this type</p></li>
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Onlooker. Not used by default.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Keyword Arguments</dt>
|
||||
<dd class="field-even"><p><strong>key</strong> (<em>str</em>) – Optional key to pluralize, if given, use this instead of the object’s key.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>singular (str)</em> – The singular form to display.
|
||||
plural (str): The determined plural form of the key, including the count.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.search">
|
||||
<code class="sig-name descname">search</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">searchdata</span></em>, <em class="sig-param"><span class="n">global_search</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">use_nicks</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">typeclass</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attribute_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">exact</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">candidates</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_locks</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">nofound_string</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">multimatch_string</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_dbref</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">stacked</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultObject.search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.search" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -550,7 +498,7 @@ function on.</p></li>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.msg_contents">
|
||||
<code class="sig-name descname">msg_contents</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">exclude</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">from_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mapping</span><span class="o">=</span><span class="default_value">None</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/objects/objects.html#DefaultObject.msg_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.msg_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">msg_contents</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">exclude</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">from_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mapping</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">raise_funcparse_errors</span><span class="o">=</span><span class="default_value">False</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/objects/objects.html#DefaultObject.msg_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.msg_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Emits a message to all objects inside this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -574,6 +522,9 @@ The keys must either match **{key}</strong> or <strong>$You(key)/$you(key)</stro
|
|||
in the <strong>text</strong> string. If <strong><object></strong> doesn’t have a <strong>get_display_name</strong>
|
||||
method, it will be returned as a string. If not set, a key <strong>you</strong> will
|
||||
be auto-added to point to <strong>from_obj</strong> if given, otherwise to <strong>self</strong>.</p></li>
|
||||
<li><p><strong>raise_funcparse_errors</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set, a failing <strong>$func()</strong> will
|
||||
lead to an outright error. If unset (default), the failing <strong>$func()</strong>
|
||||
will instead appear in output unparsed.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Keyword arguments will be passed on to <strong>obj.msg()</strong> for all
|
||||
messaged objects.</p></li>
|
||||
</ul>
|
||||
|
|
@ -672,7 +623,9 @@ calling <strong>move_to</strong>.</p>
|
|||
<p>The <strong>DefaultObject</strong> hooks called (if <strong>move_hooks=True</strong>) are, in order:</p>
|
||||
<blockquote>
|
||||
<div><ol class="arabic simple">
|
||||
<li><p><strong>self.at_pre_move(destination)</strong> (if this returns False, move is aborted)</p></li>
|
||||
<li><p><strong>self.at_pre_move(destination)</strong> (abort if return False)</p></li>
|
||||
<li><p><strong>source_location.at_pre_object_leave(self, destination)</strong> (abort if return False)</p></li>
|
||||
<li><p><strong>destination.at_pre_object_receive(self, source_location)</strong> (abort if return False)</p></li>
|
||||
<li><p><strong>source_location.at_object_leave(self, destination)</strong></p></li>
|
||||
<li><p><strong>self.announce_move_from(destination)</strong></p></li>
|
||||
<li><p>(move happens here)</p></li>
|
||||
|
|
@ -795,6 +748,223 @@ lock check for superuser (be careful with this one).</p></li>
|
|||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_name">
|
||||
<code class="sig-name descname">get_display_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span><span class="o">=</span><span class="default_value">None</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/objects/objects.html#DefaultObject.get_display_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Displays the name of the object in a viewer-aware manner.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>looker</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – The object or account that is looking
|
||||
at/getting inforamtion for this object. If not given, <strong>.name</strong> will be
|
||||
returned, which can in turn be used to display colored data.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>str</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>A name to display for this object. This can contain color codes and may</dt><dd><p>be customized based on <strong>looker</strong>. By default this contains the <strong>.key</strong> of the object,
|
||||
followed by the DBREF if this user is privileged to control said object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This function could be extended to change how object names appear to users in character,
|
||||
but be wary. This function does not change an object’s keys or aliases when searching,
|
||||
and is expected to produce something useful for builders.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_numbered_name">
|
||||
<code class="sig-name descname">get_numbered_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">count</span></em>, <em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_numbered_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_numbered_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the numbered (singular, plural) forms of this object’s key. This is by default called
|
||||
by return_appearance and is used for grouping multiple same-named of this object. Note that
|
||||
this will be called on <em>every</em> member of a group even though the plural name will be only
|
||||
shown once. Also the singular display version, such as ‘an apple’, ‘a tree’ is determined
|
||||
from this method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>count</strong> (<em>int</em>) – Number of objects of this type</p></li>
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Onlooker. Not used by default.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Keyword Arguments</dt>
|
||||
<dd class="field-even"><p><strong>key</strong> (<em>str</em>) – Optional key to pluralize, if given, use this instead of the object’s key.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><p><em>tuple</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>This is a tuple <strong>(str, str)</strong> with the singular and plural forms of the key</dt><dd><p>including the count.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Examples</p>
|
||||
<dl class="simple">
|
||||
<dt>::</dt><dd><p>obj.get_numbered_name(3, looker, key=”foo”) -> (“a foo”, “three foos”)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_header">
|
||||
<code class="sig-name descname">get_display_header</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_display_header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘header’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The header display string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_desc">
|
||||
<code class="sig-name descname">get_display_desc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_display_desc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_desc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘desc’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The desc display string..</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_exits">
|
||||
<code class="sig-name descname">get_display_exits</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_display_exits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_exits" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘exits’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The exits display data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_characters">
|
||||
<code class="sig-name descname">get_display_characters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_display_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘characters’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The character display data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_things">
|
||||
<code class="sig-name descname">get_display_things</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_display_things"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_things" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘things’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The things display data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_footer">
|
||||
<code class="sig-name descname">get_display_footer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_display_footer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_footer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘footer’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The footer display string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.format_appearance">
|
||||
<code class="sig-name descname">format_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">appearance</span></em>, <em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.format_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.format_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Final processing of the entire appearance string. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>appearance</strong> (<em>str</em>) – The compiled appearance string.</p></li>
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The final formatted output.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.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>, <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/objects/objects.html#DefaultObject.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Main callback used by ‘look’ for the object to describe itself.
|
||||
This formats a description. By default, this looks for the <strong>appearance_template</strong>
|
||||
string set on this class and populates it with formatting keys</p>
|
||||
<blockquote>
|
||||
<div><p>‘name’, ‘desc’, ‘exits’, ‘characters’, ‘things’ as well as
|
||||
(currently empty) ‘header’/’footer’. Each of these values are
|
||||
retrieved by a matching method <strong>.get_display_*</strong>, such as <strong>get_display_name</strong>,
|
||||
<strong>get_display_footer</strong> etc.</p>
|
||||
</div></blockquote>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking. Passed into all helper methods.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call. This is passed into all helper methods.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>str</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>The description of this entity. By default this includes</dt><dd><p>the entity’s name, description and any contents inside it.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>To simply change the layout of how the object displays itself (like
|
||||
adding some line decorations or change colors of different sections),
|
||||
you can simply edit <strong>.appearance_template</strong>. You only need to override
|
||||
this method (and/or its helpers) if you want to change what is passed
|
||||
into the template or want the most control over output.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_first_save">
|
||||
<code class="sig-name descname">at_first_save</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultObject.at_first_save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_first_save" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -986,7 +1156,7 @@ based on the access result.</p>
|
|||
<dt id="evennia.objects.objects.DefaultObject.at_pre_move">
|
||||
<code class="sig-name descname">at_pre_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em>, <em class="sig-param"><span class="n">move_type</span><span class="o">=</span><span class="default_value">'move'</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/objects/objects.html#DefaultObject.at_pre_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_pre_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before starting to move this object to
|
||||
destination.</p>
|
||||
destination. Return False to abort move.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
@ -1000,7 +1170,7 @@ overriding the call (unused by default).</p></li>
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>shouldmove (bool)</em> – If we should move or not.</p>
|
||||
<dd class="field-even"><p><em>bool</em> – If we should move or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
|
|
@ -1008,11 +1178,61 @@ overriding the call (unused by default).</p></li>
|
|||
before it is even started.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_pre_object_leave">
|
||||
<code class="sig-name descname">at_pre_object_leave</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">leaving_object</span></em>, <em class="sig-param"><span class="n">destination</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/objects/objects.html#DefaultObject.at_pre_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_pre_object_leave" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before this object is about lose an object that was
|
||||
previously ‘inside’ it. Return False to abort move.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>leaving_object</strong> (<em>Object</em>) – The object that is about to leave.</p></li>
|
||||
<li><p><strong>destination</strong> (<em>Object</em>) – Where object is going to.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call (unused by default).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – If <strong>leaving_object</strong> should be allowed to leave or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>Notes: If this method returns False, None, the move is canceled before</dt><dd><p>it even started.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_pre_object_receive">
|
||||
<code class="sig-name descname">at_pre_object_receive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">arriving_object</span></em>, <em class="sig-param"><span class="n">source_location</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/objects/objects.html#DefaultObject.at_pre_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_pre_object_receive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before this object received another object. If this
|
||||
method returns <strong>False</strong>, the move is aborted and the moved entity
|
||||
remains where it was.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>arriving_object</strong> (<em>Object</em>) – The object moved into this one</p></li>
|
||||
<li><p><strong>source_location</strong> (<em>Object</em>) – Where <strong>moved_object</strong> came from.
|
||||
Note that this could be <strong>None</strong>.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call (unused by default).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – If False, abort move and <strong>moved_obj</strong> remains where it was.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>Notes: If this method returns False, None, the move is canceled before</dt><dd><p>it even started.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_before_move">
|
||||
<code class="sig-name descname">at_before_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em>, <em class="sig-param"><span class="n">move_type</span><span class="o">=</span><span class="default_value">'move'</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_before_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before starting to move this object to
|
||||
destination.</p>
|
||||
destination. Return False to abort move.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
@ -1026,7 +1246,7 @@ overriding the call (unused by default).</p></li>
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>shouldmove (bool)</em> – If we should move or not.</p>
|
||||
<dd class="field-even"><p><em>bool</em> – If we should move or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
|
|
@ -1370,42 +1590,6 @@ already given by the .get_display_name() (and the .name field) already.
|
|||
Per-type coloring can be applied in <strong>return_apperance</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.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>, <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/objects/objects.html#DefaultObject.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Main callback used by ‘look’ for the object to describe itself.
|
||||
This formats a description. By default, this looks for the <strong>appearance_template</strong>
|
||||
string set on this class and populates it with formatting keys</p>
|
||||
<blockquote>
|
||||
<div><p>‘name’, ‘desc’, ‘exits’, ‘characters’, ‘things’ as well as
|
||||
(currently empty) ‘header’/’footer’.</p>
|
||||
</div></blockquote>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call. This is passed into the helper
|
||||
methods and into <strong>get_display_name</strong> calls.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>str</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>The description of this entity. By default this includes</dt><dd><p>the entity’s name, description and any contents inside it.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>To simply change the layout of how the object displays itself (like
|
||||
adding some line decorations or change colors of different sections),
|
||||
you can simply edit <strong>.appearance_template</strong>. You only need to override
|
||||
this method (and/or its helpers) if you want to change what is passed
|
||||
into the template or want the most control over output.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_look">
|
||||
<code class="sig-name descname">at_look</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">target</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/objects/objects.html#DefaultObject.at_look"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_look" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -1811,8 +1995,8 @@ change the default lockset and skip creator attribution.</p></li>
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>character (Object)</em> – A newly created Character of the given typeclass.
|
||||
errors (list): A list of errors in string form, if any.</p>
|
||||
<dd class="field-odd"><p><em>tuple</em> – <strong>(new_character, errors)</strong>. On error, the <strong>new_character</strong> is <strong>None</strong> and
|
||||
<strong>errors</strong> is a <strong>list</strong> of error strings (an empty list otherwise).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue