mirror of
https://github.com/evennia/evennia.git
synced 2026-03-23 16:26:30 +01:00
418 lines
No EOL
28 KiB
HTML
418 lines
No EOL
28 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>evennia.utils.search — Evennia latest documentation</title>
|
||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/language_data.js"></script>
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="evennia.utils.test_resources" href="evennia.utils.test_resources.html" />
|
||
<link rel="prev" title="evennia.utils.picklefield" href="evennia.utils.picklefield.html" />
|
||
</head><body>
|
||
|
||
|
||
<div class="admonition important">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
|
||
</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"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.utils.test_resources.html" title="evennia.utils.test_resources"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.utils.picklefield.html" title="evennia.utils.picklefield"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.utils.html" accesskey="U">evennia.utils</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.utils.search</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
|
||
<div class="documentwrapper">
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||
</a></p>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="evennia.utils.picklefield.html"
|
||
title="previous chapter">evennia.utils.picklefield</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.utils.test_resources.html"
|
||
title="next chapter">evennia.utils.test_resources</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.utils.search.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div><h3>Links</h3>
|
||
<ul>
|
||
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
||
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
||
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||
<li>
|
||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.utils.search">
|
||
<span id="evennia-utils-search"></span><h1>evennia.utils.search<a class="headerlink" href="#module-evennia.utils.search" title="Permalink to this headline">¶</a></h1>
|
||
<p>This is a convenient container gathering all the main
|
||
search methods for the various database tables.</p>
|
||
<p>It is intended to be used e.g. as</p>
|
||
<p>> from evennia.utils import search
|
||
> match = search.objects(…)</p>
|
||
<p>Note that this is not intended to be a complete listing of all search
|
||
methods! You need to refer to the respective manager to get all
|
||
possible search methods. To get to the managers from your code, import
|
||
the database model and call its ‘objects’ property.</p>
|
||
<p>Also remember that all commands in this file return lists (also if
|
||
there is only one match) unless noted otherwise.</p>
|
||
<dl class="simple">
|
||
<dt>Example: To reach the search method ‘get_object_with_account’</dt><dd><p>in evennia/objects/managers.py:</p>
|
||
</dd>
|
||
</dl>
|
||
<p>> from evennia.objects.models import ObjectDB
|
||
> match = Object.objects.get_object_with_account(…)</p>
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_object">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_object</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/utils/search.html#search_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.search.search_object" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Search for objects in the database.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>key</strong> (<em>str</em><em> or </em><em>int</em>) – Object key or dbref to search for. This can also
|
||
be a list of keys/dbrefs. <strong>None</strong> (default) returns all objects.</p></li>
|
||
<li><p><strong>exact</strong> (<em>bool</em>) – Only valid for string keys. If True, requires exact
|
||
key match, otherwise also match key with case-insensitive and
|
||
partial matching. Default is True.</p></li>
|
||
<li><p><strong>candidates</strong> (<em>list</em>) – Only search among these object candidates,
|
||
if given. Default is to search all objects.</p></li>
|
||
<li><p><strong>attribute_name</strong> (<em>str</em>) – If set, search by objects with this attribute_name
|
||
defined on them, with the value specified by <strong>attribute_value</strong>.</p></li>
|
||
<li><p><strong>attribute_value</strong> (<em>any</em>) – What value the given attribute_name must have.</p></li>
|
||
<li><p><strong>location</strong> (<em>Object</em>) – Filter by objects at this location.</p></li>
|
||
<li><p><strong>typeclass</strong> (<em>str</em><em> or </em><em>TypeClass</em>) – Filter by objects having this typeclass.
|
||
This can also be a list of typeclasses.</p></li>
|
||
<li><p><strong>tags</strong> (<em>str</em><em> or </em><em>list</em>) – Filter by objects having one or more Tags.
|
||
This can be a single tag key, a list of tag keys, or a list of
|
||
tuples (tag_key, tag_category).</p></li>
|
||
<li><p><strong>nofetch</strong> (<em>bool</em>) – Don’t fetch typeclass and perms data from db.
|
||
This is faster but gives less info.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>matches (list)</em> – List of Objects matching the search criteria.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_account">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_account</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/utils/search.html#search_account"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.search.search_account" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Search for accounts in the database.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>key</strong> (<em>str</em><em> or </em><em>int</em>) – Account key or dbref to search for. This can also
|
||
be a list of keys/dbrefs. <strong>None</strong> (default) returns all accounts.</p></li>
|
||
<li><p><strong>exact</strong> (<em>bool</em>) – Only valid for string keys. If True, requires exact
|
||
key match, otherwise also match key with case-insensitive and
|
||
partial matching. Default is True.</p></li>
|
||
<li><p><strong>candidates</strong> (<em>list</em>) – Only search among these account candidates,
|
||
if given. Default is to search all accounts.</p></li>
|
||
<li><p><strong>attribute_name</strong> (<em>str</em>) – If set, search by accounts with this attribute_name
|
||
defined on them, with the value specified by <strong>attribute_value</strong>.</p></li>
|
||
<li><p><strong>attribute_value</strong> (<em>any</em>) – What value the given attribute_name must have.</p></li>
|
||
<li><p><strong>tags</strong> (<em>str</em><em> or </em><em>list</em>) – Filter by accounts having one or more Tags.
|
||
This can be a single tag key, a list of tag keys, or a list of
|
||
tuples (tag_key, tag_category).</p></li>
|
||
<li><p><strong>nofetch</strong> (<em>bool</em>) – Don’t fetch typeclass and perms data from db.
|
||
This is faster but gives less info.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>matches (list)</em> – List of Accounts matching the search criteria.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_script">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_script</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/utils/search.html#search_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.search.search_script" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Search for scripts in the database.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>key</strong> (<em>str</em><em> or </em><em>int</em>) – Script key or dbref to search for. This can also
|
||
be a list of keys/dbrefs. <strong>None</strong> (default) returns all scripts.</p></li>
|
||
<li><p><strong>exact</strong> (<em>bool</em>) – Only valid for string keys. If True, requires exact
|
||
key match, otherwise also match key with case-insensitive and
|
||
partial matching. Default is True.</p></li>
|
||
<li><p><strong>candidates</strong> (<em>list</em>) – Only search among these script candidates,
|
||
if given. Default is to search all scripts.</p></li>
|
||
<li><p><strong>attribute_name</strong> (<em>str</em>) – If set, search by scripts with this attribute_name
|
||
defined on them, with the value specified by <strong>attribute_value</strong>.</p></li>
|
||
<li><p><strong>attribute_value</strong> (<em>any</em>) – What value the given attribute_name must have.</p></li>
|
||
<li><p><strong>obj</strong> (<em>Object</em>) – Filter by scripts defined on this object.</p></li>
|
||
<li><p><strong>account</strong> (<em>Account</em>) – Filter by scripts defined on this account.</p></li>
|
||
<li><p><strong>typeclass</strong> (<em>str</em><em> or </em><em>TypeClass</em>) – Filter by scripts having this typeclass.
|
||
This can also be a list of typeclasses.</p></li>
|
||
<li><p><strong>tags</strong> (<em>str</em><em> or </em><em>list</em>) – Filter by scripts having one or more Tags.
|
||
This can be a single tag key, a list of tag keys, or a list of
|
||
tuples (tag_key, tag_category).</p></li>
|
||
<li><p><strong>nofetch</strong> (<em>bool</em>) – Don’t fetch typeclass and perms data from db.
|
||
This is faster but gives less info.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>matches (list)</em> – List of Scripts matching the search criteria.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_message">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_message</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/utils/search.html#search_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.search.search_message" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Search for messages in the database.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sender</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>str</em>) – Filter by messages sent by this entity.
|
||
If a string, this is an external sender name.</p></li>
|
||
<li><p><strong>receiver</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>str</em>) – Filter by messages received by this entity.
|
||
If a string, this is an external receiver name.</p></li>
|
||
<li><p><strong>channel</strong> (<em>Channel</em>) – Filter by messages sent to this channel.</p></li>
|
||
<li><p><strong>date</strong> (<em>datetime</em>) – Filter by messages sent on this date.</p></li>
|
||
<li><p><strong>type</strong> (<em>str</em>) – Filter by messages of this type.</p></li>
|
||
<li><p><strong>tags</strong> (<em>str</em><em> or </em><em>list</em>) – Filter by messages having one or more Tags.
|
||
This can be a single tag key, a list of tag keys, or a list of
|
||
tuples (tag_key, tag_category).</p></li>
|
||
<li><p><strong>exclude_tags</strong> (<em>str</em><em> or </em><em>list</em>) – Exclude messages with these tags.</p></li>
|
||
<li><p><strong>search_text</strong> (<em>str</em>) – Search for text in message content.</p></li>
|
||
<li><p><strong>exact</strong> (<em>bool</em>) – If True, require exact text match. Default False.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>matches (list)</em> – List of Messages matching the search criteria.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_channel">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_channel</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/utils/search.html#search_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.search.search_channel" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Search for channels in the database.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>key</strong> (<em>str</em><em> or </em><em>int</em>) – Channel key or dbref to search for. This can also
|
||
be a list of keys/dbrefs. <strong>None</strong> (default) returns all channels.</p></li>
|
||
<li><p><strong>exact</strong> (<em>bool</em>) – Only valid for string keys. If True, requires exact
|
||
key match, otherwise also match key with case-insensitive and
|
||
partial matching. Default is True.</p></li>
|
||
<li><p><strong>candidates</strong> (<em>list</em>) – Only search among these channel candidates,
|
||
if given. Default is to search all channels.</p></li>
|
||
<li><p><strong>attribute_name</strong> (<em>str</em>) – If set, search by channels with this attribute_name
|
||
defined on them, with the value specified by <strong>attribute_value</strong>.</p></li>
|
||
<li><p><strong>attribute_value</strong> (<em>any</em>) – What value the given attribute_name must have.</p></li>
|
||
<li><p><strong>typeclass</strong> (<em>str</em><em> or </em><em>TypeClass</em>) – Filter by channels having this typeclass.
|
||
This can also be a list of typeclasses.</p></li>
|
||
<li><p><strong>tags</strong> (<em>str</em><em> or </em><em>list</em>) – Filter by channels having one or more Tags.
|
||
This can be a single tag key, a list of tag keys, or a list of
|
||
tuples (tag_key, tag_category).</p></li>
|
||
<li><p><strong>nofetch</strong> (<em>bool</em>) – Don’t fetch typeclass and perms data from db.
|
||
This is faster but gives less info.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>matches (list)</em> – List of Channels matching the search criteria.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_help_entry">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_help_entry</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="headerlink" href="#evennia.utils.search.search_help_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Search for help entries in the database.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>key</strong> (<em>str</em><em> or </em><em>int</em>) – Help entry key or dbref to search for. This can also
|
||
be a list of keys/dbrefs. <strong>None</strong> (default) returns all help entries.</p></li>
|
||
<li><p><strong>exact</strong> (<em>bool</em>) – Only valid for string keys. If True, requires exact
|
||
key match, otherwise also match key with case-insensitive and
|
||
partial matching. Default is True.</p></li>
|
||
<li><p><strong>category</strong> (<em>str</em>) – Filter by help entries in this category.</p></li>
|
||
<li><p><strong>tags</strong> (<em>str</em><em> or </em><em>list</em>) – Filter by help entries having one or more Tags.
|
||
This can be a single tag key, a list of tag keys, or a list of
|
||
tuples (tag_key, tag_category).</p></li>
|
||
<li><p><strong>locks</strong> (<em>str</em>) – Filter by help entries with these locks.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>matches (list)</em> – List of HelpEntries matching the search criteria.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_tag">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_tag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tagtype</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="headerlink" href="#evennia.utils.search.search_tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Find object based on tag or category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>key</strong> (<em>str</em><em>, </em><em>optional</em>) – The tag key to search for.</p></li>
|
||
<li><p><strong>category</strong> (<em>str</em><em>, </em><em>optional</em>) – The category of tag
|
||
to search for. If not set, uncategorized
|
||
tags will be searched.</p></li>
|
||
<li><p><strong>tagtype</strong> (<em>str</em><em>, </em><em>optional</em>) – ‘type’ of Tag, by default
|
||
this is either <strong>None</strong> (a normal Tag), <strong>alias</strong> or
|
||
<strong>permission</strong>. This always apply to all queried tags.</p></li>
|
||
<li><p><strong>kwargs</strong> (<em>any</em>) – Other optional parameter that may be supported
|
||
by the manager method.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p><em>matches (list)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>List of Objects with tags matching</dt><dd><p>the search criteria, or an empty list if no
|
||
matches were found.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_script_tag">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_script_tag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tagtype</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/utils/search.html#search_script_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.search.search_script_tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Find script based on tag or category.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_account_tag">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_account_tag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tagtype</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/utils/search.html#search_account_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.search.search_account_tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Find account based on tag or category.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_channel_tag">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_channel_tag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tagtype</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/utils/search.html#search_channel_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.search.search_channel_tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Find channel based on tag or category.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.utils.search.search_typeclass">
|
||
<code class="sig-prename descclassname">evennia.utils.search.</code><code class="sig-name descname">search_typeclass</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">typeclass</span></em>, <em class="sig-param"><span class="n">include_children</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">include_parents</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.utils.search.search_typeclass" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Searches through all objects returning those of a certain typeclass.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>typeclass</strong> (<em>str</em><em> or </em><em>class</em>) – A typeclass class or a python path to a typeclass.</p></li>
|
||
<li><p><strong>include_children</strong> (<em>bool</em><em>, </em><em>optional</em>) – Return objects with
|
||
given typeclass <em>and</em> all children inheriting from this
|
||
typeclass. Mutuall exclusive to <strong>include_parents</strong>.</p></li>
|
||
<li><p><strong>include_parents</strong> (<em>bool</em><em>, </em><em>optional</em>) – Return objects with
|
||
given typeclass <em>and</em> all parents to this typeclass.
|
||
Mutually exclusive to <strong>include_children</strong>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>objects (list)</em> – The objects found with the given typeclasses.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.utils.test_resources.html" title="evennia.utils.test_resources"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.utils.picklefield.html" title="evennia.utils.picklefield"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.utils.html" >evennia.utils</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.utils.search</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
<div class="admonition important">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
|
||
</div>
|
||
|
||
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2024, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |