55 lines
2.1 KiB
Python
55 lines
2.1 KiB
Python
"""
|
|
Search and multimatch handling
|
|
|
|
This module allows for overloading two functions used by Evennia's
|
|
search functionality:
|
|
|
|
at_search_result:
|
|
This is called whenever a result is returned from an object
|
|
search (a common operation in commands). It should (together
|
|
with at_multimatch_input below) define some way to present and
|
|
differentiate between multiple matches (by default these are
|
|
presented as 1-ball, 2-ball etc)
|
|
at_multimatch_input:
|
|
This is called with a search term and should be able to
|
|
identify if the user wants to separate a multimatch-result
|
|
(such as that from a previous search). By default, this
|
|
function understands input on the form 1-ball, 2-ball etc as
|
|
indicating that the 1st or 2nd match for "ball" should be
|
|
used.
|
|
|
|
This module is not called by default, to use it, add the following
|
|
line to your settings file:
|
|
|
|
SEARCH_AT_RESULT = "server.conf.at_search.at_search_result"
|
|
|
|
"""
|
|
|
|
|
|
def at_search_result(matches, caller, query="", quiet=False, **kwargs):
|
|
"""
|
|
This is a generic hook for handling all processing of a search
|
|
result, including error reporting.
|
|
|
|
Args:
|
|
matches (list): This is a list of 0, 1 or more typeclass instances,
|
|
the matched result of the search. If 0, a nomatch error should
|
|
be echoed, and if >1, multimatch errors should be given. Only
|
|
if a single match should the result pass through.
|
|
caller (Object): The object performing the search and/or which should
|
|
receive error messages.
|
|
query (str, optional): The search query used to produce `matches`.
|
|
quiet (bool, optional): If `True`, no messages will be echoed to caller
|
|
on errors.
|
|
|
|
Keyword Args:
|
|
nofound_string (str): Replacement string to echo on a notfound error.
|
|
multimatch_string (str): Replacement string to echo on a multimatch error.
|
|
|
|
Returns:
|
|
processed_result (Object or None): This is always a single result
|
|
or `None`. If `None`, any error reporting/handling should
|
|
already have happened.
|
|
|
|
"""
|