From 2bea75c27d2578c552147677e1809e9d82644001 Mon Sep 17 00:00:00 2001 From: Griatch Date: Fri, 4 Jan 2019 14:35:44 +0100 Subject: [PATCH] Further clarifications in search docstring --- evennia/objects/objects.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 5a4282a49d..e4b0b80639 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -387,9 +387,11 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): caller's contents (inventory). nofound_string (str): optional custom string for not-found error message. multimatch_string (str): optional custom string for multimatch error header. - use_dbref (bool or None, optional): if True/False, active/deactivate the use of - #dbref as valid global search arguments. If None (default), activate this ability - only if `self` has the permission 'Builder'. + use_dbref (bool or None, optional): If `True`, allow to enter e.g. a query "#123" + to find an object (globally) by its database-id 123. If `False`, the string "#123" + will be treated like a normal string. If `None` (default), the ability to query by + #dbref is turned on if `self` has the permission 'Builder' and is turned off + otherwise. Returns: match (Object, None or list): will return an Object/None if `quiet=False`,