Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-29 03:57:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2021-10-26 22:10:11 +02:00
parent 7900aad365
commit d51d02b44d
48 changed files with 198 additions and 202 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/1.0-dev/_modules/evennia/objects/objects.html
View file

@ -447,13 +447,15 @@
<span class="sd"> searchdata (str or obj): Primary search criterion. Will be matched</span>
<span class="sd"> against `object.key` (with `object.aliases` second) unless</span>
<span class="sd"> the keyword attribute_name specifies otherwise.</span>
<span class="sd"> **Special strings:**</span>
<span class="sd"> - `#&lt;num&gt;`: search by unique dbref. This is always</span>
<span class="sd"> a global search.</span>
<span class="sd"> Special keywords:</span>
<span class="sd"> - `#&lt;num&gt;`: search by unique dbref. This is always a global search.</span>
<span class="sd"> - `me,self`: self-reference to this object</span>
<span class="sd"> - `&lt;num&gt;-&lt;string&gt;` - can be used to differentiate</span>
<span class="sd"> between multiple same-named matches. The exact form of this input</span>
<span class="sd"> is given by `settings.SEARCH_MULTIMATCH_REGEX`.</span>
<span class="sd"> global_search (bool): Search all objects globally. This overrules &#39;location&#39; data.</span>
<span class="sd"> use_nicks (bool): Use nickname-replace (nicktype &quot;object&quot;) on `searchdata`.</span>
<span class="sd"> typeclass (str or Typeclass, or list of either): Limit search only</span>
@ -501,11 +503,9 @@
<span class="sd"> error depending on the value of `quiet`.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Object: If finding a match an `quiet=False`</span>
<span class="sd"> None: If not finding a unique match and `quiet=False`.</span>
<span class="sd"> list: With 0, 1 or more matching objects if `quiet=True`</span>
<span class="sd"> list: With 2 or more matching objects if `stacked` is a positive integer and</span>
<span class="sd"> the matched stack has only object-copies.</span>
<span class="sd"> Object, None or list: Will return an `Object` or `None` if `quiet=False`. Will return</span>
<span class="sd"> a `list` with 0, 1 or more matches if `quiet=True`. If `stacked` is a positive integer,</span>
<span class="sd"> this list may contain all stacked identical matches.</span>
<span class="sd"> Notes:</span>
<span class="sd"> To find Accounts, use eg. `evennia.account_search`. If</span>