From 79a23bc3863c0e9affb0b3d5c9bb74d520b603b0 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Sun, 29 Sep 2024 07:47:00 +0000 Subject: [PATCH] Updated HTML docs. --- docs/latest/.buildinfo | 2 +- .../game_systems/clothing/clothing.html | 3 + .../contrib/game_systems/clothing/tests.html | 2 +- .../_modules/evennia/objects/manager.html | 167 +++++++----------- docs/latest/_sources/index.md.txt | 2 +- .../api/evennia.commands.default.account.html | 4 +- .../evennia.commands.default.building.html | 8 +- .../api/evennia.commands.default.general.html | 8 +- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 16 +- ....base_systems.email_login.email_login.html | 16 +- ...b.base_systems.ingame_reports.reports.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 4 +- ...rib.full_systems.evscaperoom.commands.html | 28 +-- ...ia.contrib.game_systems.barter.barter.html | 4 +- ...trib.game_systems.turnbattle.tb_basic.html | 4 +- ...trib.game_systems.turnbattle.tb_equip.html | 4 +- ...trib.game_systems.turnbattle.tb_items.html | 4 +- ...trib.game_systems.turnbattle.tb_magic.html | 4 +- ...trib.game_systems.turnbattle.tb_range.html | 4 +- ...trib.grid.extended_room.extended_room.html | 4 +- .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...evennia.contrib.rpg.rpsystem.rpsystem.html | 4 +- ...utorials.evadventure.combat_turnbased.html | 4 +- ...b.tutorials.evadventure.combat_twitch.html | 4 +- ...ontrib.tutorials.evadventure.commands.html | 4 +- ...ntrib.tutorials.red_button.red_button.html | 16 +- ...trib.tutorials.tutorial_world.objects.html | 12 +- ...ontrib.tutorials.tutorial_world.rooms.html | 12 +- ...utils.git_integration.git_integration.html | 4 +- docs/latest/api/evennia.objects.manager.html | 24 ++- docs/latest/api/evennia.utils.eveditor.html | 4 +- docs/latest/api/evennia.utils.evmenu.html | 4 +- docs/latest/api/evennia.utils.evmore.html | 4 +- docs/latest/api/evennia.utils.search.html | 7 +- docs/latest/index.html | 2 +- docs/latest/searchindex.js | 2 +- 37 files changed, 180 insertions(+), 225 deletions(-) diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo index ade2fe5056..5b26570a47 100644 --- a/docs/latest/.buildinfo +++ b/docs/latest/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 7ccf57c5089711ff2b66b8091c6216f7 +config: d7b846554994f01deeee5ba90fb167f9 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/latest/_modules/evennia/contrib/game_systems/clothing/clothing.html b/docs/latest/_modules/evennia/contrib/game_systems/clothing/clothing.html index 408408d071..884eeb1f67 100644 --- a/docs/latest/_modules/evennia/contrib/game_systems/clothing/clothing.html +++ b/docs/latest/_modules/evennia/contrib/game_systems/clothing/clothing.html @@ -619,6 +619,9 @@ help_category = "clothing"
[docs] def func(self): + if not self.args: + self.caller.msg("Usage: remove <worn clothing object>") + return clothing = self.caller.search(self.args, candidates=self.caller.contents) if not clothing: self.caller.msg("You don't have anything like that.") diff --git a/docs/latest/_modules/evennia/contrib/game_systems/clothing/tests.html b/docs/latest/_modules/evennia/contrib/game_systems/clothing/tests.html index 5c0b82e27d..498349b473 100644 --- a/docs/latest/_modules/evennia/contrib/game_systems/clothing/tests.html +++ b/docs/latest/_modules/evennia/contrib/game_systems/clothing/tests.html @@ -177,7 +177,7 @@ ) # Test remove command. - self.call(clothing.CmdRemove(), "", "Could not find ''.", caller=self.wearer) + self.call(clothing.CmdRemove(), "", "Usage: remove <worn clothing object>", caller=self.wearer) self.call( clothing.CmdRemove(), "hat", diff --git a/docs/latest/_modules/evennia/objects/manager.html b/docs/latest/_modules/evennia/objects/manager.html index 8df609585e..0a1cc0b739 100644 --- a/docs/latest/_modules/evennia/objects/manager.html +++ b/docs/latest/_modules/evennia/objects/manager.html @@ -373,8 +373,7 @@ Args: ostring (str): A search criterion. exact (bool, optional): Require exact match of ostring - (still case-insensitive). If `False`, will do fuzzy matching - using `evennia.utils.utils.string_partial_matching` algorithm. + (still case-insensitive). If `False`, will do fuzzy matching with a regex filter. candidates (list): Only match among these candidates. typeclasses (list): Only match objects with typeclasses having thess path strings. @@ -397,7 +396,7 @@ cand_restriction = candidates is not None and Q(pk__in=candidates_id) or Q() type_restriction = typeclasses and Q(db_typeclass_path__in=make_iter(typeclasses)) or Q() if exact: - # exact match - do direct search + # exact matches only return ( ( self.filter( @@ -413,50 +412,26 @@ .distinct() .order_by("id") ) - elif candidates: - # fuzzy with candidates - search_candidates = ( - self.filter(cand_restriction & type_restriction).distinct().order_by("id") - ) - else: - # fuzzy without supplied candidates - we select our own candidates - search_candidates = ( - self.filter( - type_restriction - & (Q(db_key__icontains=ostring) | Q(db_tags__db_key__icontains=ostring)) - ) - .distinct() - .order_by("id") - ) - # fuzzy matching - key_strings = search_candidates.values_list("db_key", flat=True).order_by("id") - match_ids = [] - index_matches = string_partial_matching(key_strings, ostring, ret_index=True) - if index_matches: - # a match by key - match_ids = [ - obj.id for ind, obj in enumerate(search_candidates) if ind in index_matches - ] - else: - # match by alias rather than by key - search_candidates = search_candidates.filter( - db_tags__db_tagtype__iexact="alias", db_tags__db_key__icontains=ostring - ).distinct() - alias_strings = [] - alias_candidates = [] - # TODO create the alias_strings and alias_candidates lists more efficiently? - for candidate in search_candidates: - for alias in candidate.aliases.all(): - alias_strings.append(alias) - alias_candidates.append(candidate) - index_matches = string_partial_matching(alias_strings, ostring, ret_index=True) - if index_matches: - # it's possible to have multiple matches to the same Object, we must weed those out - match_ids = [alias_candidates[ind].id for ind in index_matches] - # TODO - not ideal to have to do a second lookup here, but we want to return a queryset - # rather than a list ... maybe the above queries can be improved. - return self.filter(id__in=match_ids)
+ # convert search term to partial-match regex + search_regex = r".* ".join(re.escape(word) for word in ostring.split()) + r'.*' + + # do the fuzzy search and return whatever it matches + return ( + ( + self.filter( + cand_restriction + & type_restriction + & ( + Q(db_key__iregex=search_regex) + | Q(db_tags__db_key__iregex=search_regex) + & Q(db_tags__db_tagtype__iexact="alias") + ) + ) + ) + .distinct() + .order_by("id") + ) # main search methods and helper functions @@ -472,14 +447,13 @@ ): """ Search as an object globally or in a list of candidates and - return results. The result is always an Object. Always returns - a list. + return results. Always returns a QuerySet of Objects. Args: searchdata (str or Object): The entity to match for. This is usually a key string but may also be an object itself. By default (if no `attribute_name` is set), this will - search `object.key` and `object.aliases` in order. + search `object.key` and `object.aliases`. Can also be on the form #dbref, which will (if `exact=True`) be matched against primary key. attribute_name (str): Use this named Attribute to @@ -509,63 +483,43 @@ a match. Returns: - matches (list): Matching objects + matches (QuerySet): Matching objects """ def _searcher(searchdata, candidates, typeclass, exact=False): """ - Helper method for searching objects. `typeclass` is only used - for global searching (no candidates) + Helper method for searching objects. """ if attribute_name: # attribute/property search (always exact). matches = self.get_objs_with_db_property_value( attribute_name, searchdata, candidates=candidates, typeclasses=typeclass ) - if matches: - return matches - return self.get_objs_with_attr_value( - attribute_name, searchdata, candidates=candidates, typeclasses=typeclass - ) + if not matches: + matches = self.get_objs_with_attr_value( + attribute_name, searchdata, candidates=candidates, typeclasses=typeclass + ) else: # normal key/alias search - return self.get_objs_with_key_or_alias( + matches = self.get_objs_with_key_or_alias( searchdata, exact=exact, candidates=candidates, typeclasses=typeclass ) + if matches and tags: + # additionally filter matches by tags + for tagkey, tagcategory in tags: + matches = matches.filter( + db_tags__db_key=tagkey, db_tags__db_category=tagcategory + ) - def _search_by_tag(query, taglist): - for tagkey, tagcategory in taglist: - query = query.filter(db_tags__db_key=tagkey, db_tags__db_category=tagcategory) - - return query - - if not searchdata and searchdata != 0: - if tags: - return _search_by_tag(self.all(), make_iter(tags)) - - return self.none() - - if typeclass: - # typeclass may also be a list - typeclasses = make_iter(typeclass) - for i, typeclass in enumerate(make_iter(typeclasses)): - if callable(typeclass): - typeclasses[i] = "%s.%s" % (typeclass.__module__, typeclass.__name__) - else: - typeclasses[i] = "%s" % typeclass - typeclass = typeclasses + return matches if candidates is not None: if not candidates: - # candidates is the empty list. This should mean no matches can ever be acquired. - return [] + # candidates is an empty list. This should mean no matches can ever be acquired. + return self.none() # Convenience check to make sure candidates are really dbobjs candidates = [cand for cand in make_iter(candidates) if cand] - if typeclass: - candidates = [ - cand for cand in candidates if _GA(cand, "db_typeclass_path") in typeclass - ] dbref = not attribute_name and exact and use_dbref and self.dbref(searchdata) if dbref: @@ -578,51 +532,54 @@ else: return self.none() + if typeclass: + # typeclass may be a string, a typeclass, or a list + typeclasses = make_iter(typeclass) + for i, typeclass in enumerate(make_iter(typeclasses)): + if callable(typeclass): + typeclasses[i] = "%s.%s" % (typeclass.__module__, typeclass.__name__) + else: + typeclasses[i] = "%s" % typeclass + typeclass = typeclasses + # Search through all possibilities. match_number = None # always run first check exact - we don't want partial matches # if on the form of 1-keyword etc. matches = _searcher(searchdata, candidates, typeclass, exact=True) + stripped_searchdata = searchdata if not matches: # no matches found - check if we are dealing with N-keyword # query - if so, strip it. - match = _MULTIMATCH_REGEX.match(str(searchdata)) + match_data = _MULTIMATCH_REGEX.match(str(searchdata)) match_number = None - stripped_searchdata = searchdata - if match: + if match_data: # strips the number - match_number, stripped_searchdata = match.group("number"), match.group("name") + match_number, stripped_searchdata = match_data.group("number"), match_data.group( + "name" + ) match_number = int(match_number) - 1 if match_number is not None: # run search against the stripped data matches = _searcher(stripped_searchdata, candidates, typeclass, exact=True) - if not matches: - # final chance to get a looser match against the number-strippped query - matches = _searcher(stripped_searchdata, candidates, typeclass, exact=False) - elif not exact: - matches = _searcher(searchdata, candidates, typeclass, exact=False) - if tags: - matches = _search_by_tag(matches, make_iter(tags)) + # at this point, if there are no matches, we give it a chance to find fuzzy matches + if not exact and not matches: + # we use stripped_searchdata in case a match number was included + matches = _searcher(stripped_searchdata, candidates, typeclass, exact=False) # deal with result - if len(matches) == 1 and match_number is not None and match_number != 0: - # this indicates trying to get a single match with a match-number - # targeting some higher-number match (like 2-box when there is only - # one box in the room). This leads to a no-match. - matches = self.none() - elif len(matches) > 1 and match_number is not None: - # multiple matches, but a number was given to separate them + if match_number is not None: if 0 <= match_number < len(matches): # limit to one match (we still want a queryset back) - # TODO: Can we do this some other way and avoid a second lookup? + # NOTE: still haven't found a way to avoid a second lookup matches = self.filter(id=matches[match_number].id) else: # a number was given outside of range. This means a no-match. matches = self.none() - # return a list (possibly empty) + # return a QuerySet (possibly empty) return matches # alias for backwards compatibility diff --git a/docs/latest/_sources/index.md.txt b/docs/latest/_sources/index.md.txt index 9b0ef8b545..42b6c5ef1f 100644 --- a/docs/latest/_sources/index.md.txt +++ b/docs/latest/_sources/index.md.txt @@ -1,6 +1,6 @@ # Evennia Documentation -This is the manual of [Evennia](https://www.evennia.com), the open source Python `MU*` creation system. Use the Search bar on the left to find or discover interesting articles. This manual was last updated September 10, 2024, see the [Evennia Changelog](Coding/Changelog.md). Latest released Evennia version is 4.3.0. +This is the manual of [Evennia](https://www.evennia.com), the open source Python `MU*` creation system. Use the Search bar on the left to find or discover interesting articles. This manual was last updated September 29, 2024, see the [Evennia Changelog](Coding/Changelog.md). Latest released Evennia version is 4.3.0. - [Introduction](./Evennia-Introduction.md) - what is this Evennia thing? - [Evennia in Pictures](./Evennia-In-Pictures.md) - a visual overview of Evennia diff --git a/docs/latest/api/evennia.commands.default.account.html b/docs/latest/api/evennia.commands.default.account.html index 8daf6e14d2..b87d5b9fb8 100644 --- a/docs/latest/api/evennia.commands.default.account.html +++ b/docs/latest/api/evennia.commands.default.account.html @@ -147,7 +147,7 @@ method. Otherwise all text will be returned to all connected sessions.

-aliases = ['ls', 'l']
+aliases = ['l', 'ls']
@@ -178,7 +178,7 @@ method. Otherwise all text will be returned to all connected sessions.

-search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}
+search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}
diff --git a/docs/latest/api/evennia.commands.default.building.html b/docs/latest/api/evennia.commands.default.building.html index 6346706782..9ddbe44d79 100644 --- a/docs/latest/api/evennia.commands.default.building.html +++ b/docs/latest/api/evennia.commands.default.building.html @@ -647,7 +647,7 @@ You can specify the /force switch to bypass this confirmation.

-aliases = ['@del', '@delete']
+aliases = ['@delete', '@del']
@@ -688,7 +688,7 @@ You can specify the /force switch to bypass this confirmation.

-search_index_entry = {'aliases': '@del @delete', 'category': 'building', 'key': '@destroy', 'no_prefix': 'destroy del delete', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}
+search_index_entry = {'aliases': '@delete @del', 'category': 'building', 'key': '@destroy', 'no_prefix': 'destroy delete del', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}
@@ -1415,7 +1415,7 @@ server settings.

-aliases = ['@typeclasses', '@type', '@swap', '@parent', '@update']
+aliases = ['@swap', '@update', '@parent', '@typeclasses', '@type']
@@ -1446,7 +1446,7 @@ server settings.

-search_index_entry = {'aliases': '@typeclasses @type @swap @parent @update', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass typeclasses type swap parent update', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}
+search_index_entry = {'aliases': '@swap @update @parent @typeclasses @type', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass swap update parent typeclasses type', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}
diff --git a/docs/latest/api/evennia.commands.default.general.html b/docs/latest/api/evennia.commands.default.general.html index d5db1091cf..9dbcff8fa3 100644 --- a/docs/latest/api/evennia.commands.default.general.html +++ b/docs/latest/api/evennia.commands.default.general.html @@ -189,7 +189,7 @@ look *<account&g
-aliases = ['ls', 'l']
+aliases = ['l', 'ls']
@@ -220,7 +220,7 @@ look *<account&g
-search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}
+search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}
@@ -611,7 +611,7 @@ placing it in their inventory.

-aliases = ["'", '"']
+aliases = ['"', "'"]
@@ -642,7 +642,7 @@ placing it in their inventory.

-search_index_entry = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}
+search_index_entry = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}
diff --git a/docs/latest/api/evennia.commands.default.tests.html b/docs/latest/api/evennia.commands.default.tests.html index 6a5b2346ed..673394d68d 100644 --- a/docs/latest/api/evennia.commands.default.tests.html +++ b/docs/latest/api/evennia.commands.default.tests.html @@ -980,7 +980,7 @@ main test suite started with

Test the batch processor.

-red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmp3cqwtgfk/f2a5c5a85a7858b24141b8ddbb79ff16eb390308/evennia/contrib/tutorials/red_button/red_button.py'>
+red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpf7czyky3/e01f79acc2eee43166ab6d445a967b08a46316dd/evennia/contrib/tutorials/red_button/red_button.py'>
diff --git a/docs/latest/api/evennia.commands.default.unloggedin.html b/docs/latest/api/evennia.commands.default.unloggedin.html index 339d25ffec..39b2c714a3 100644 --- a/docs/latest/api/evennia.commands.default.unloggedin.html +++ b/docs/latest/api/evennia.commands.default.unloggedin.html @@ -136,7 +136,7 @@ connect “account name” “pass word”

-aliases = ['con', 'co', 'conn']
+aliases = ['conn', 'co', 'con']
@@ -171,7 +171,7 @@ there is no object yet before the account has logged in)

-search_index_entry = {'aliases': 'con co conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' con co conn', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}
+search_index_entry = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn co con', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}
@@ -195,7 +195,7 @@ create “account name” “pass word”

-aliases = ['cre', 'cr']
+aliases = ['cr', 'cre']
@@ -232,7 +232,7 @@ create “account name” “pass word”

-search_index_entry = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'no_prefix': ' cre cr', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname> <password>\n create "account name" "pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}
+search_index_entry = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'no_prefix': ' cr cre', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname> <password>\n create "account name" "pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}
@@ -256,7 +256,7 @@ version is a bit more complicated.

-aliases = ['qu', 'q']
+aliases = ['q', 'qu']
@@ -282,7 +282,7 @@ version is a bit more complicated.

-search_index_entry = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'no_prefix': ' qu q', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
+search_index_entry = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'no_prefix': ' q qu', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
@@ -355,7 +355,7 @@ for simplicity. It shows a pane of info.

-aliases = ['?', 'h']
+aliases = ['h', '?']
@@ -381,7 +381,7 @@ for simplicity. It shows a pane of info.

-search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
+search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
diff --git a/docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html b/docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html index 608e247c36..b72c64e927 100644 --- a/docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html +++ b/docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html @@ -153,7 +153,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.

-aliases = ['con', 'co', 'conn']
+aliases = ['conn', 'co', 'con']
@@ -183,7 +183,7 @@ there is no object yet before the account has logged in)

-search_index_entry = {'aliases': 'con co conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' con co conn', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}
+search_index_entry = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn co con', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}
@@ -205,7 +205,7 @@ there is no object yet before the account has logged in)

-aliases = ['cre', 'cr']
+aliases = ['cr', 'cre']
@@ -247,7 +247,7 @@ name enclosed in quotes:

-search_index_entry = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'no_prefix': ' cre cr', 'tags': '', 'text': '\n Create a new account.\n\n Usage (at login screen):\n create "accountname" <email> <password>\n\n This creates a new account account.\n\n '}
+search_index_entry = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'no_prefix': ' cr cre', 'tags': '', 'text': '\n Create a new account.\n\n Usage (at login screen):\n create "accountname" <email> <password>\n\n This creates a new account account.\n\n '}
@@ -266,7 +266,7 @@ version is a bit more complicated.

-aliases = ['qu', 'q']
+aliases = ['q', 'qu']
@@ -292,7 +292,7 @@ version is a bit more complicated.

-search_index_entry = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'no_prefix': ' qu q', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
+search_index_entry = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'no_prefix': ' q qu', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
@@ -355,7 +355,7 @@ for simplicity. It shows a pane of info.

-aliases = ['?', 'h']
+aliases = ['h', '?']
@@ -381,7 +381,7 @@ for simplicity. It shows a pane of info.

-search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
+search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
diff --git a/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html b/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html index 7daf2d1844..97862bc173 100644 --- a/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html +++ b/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html @@ -174,7 +174,7 @@ players

-aliases = ['manage bugs', 'manage players', 'manage ideas']
+aliases = ['manage players', 'manage bugs', 'manage ideas']
@@ -208,7 +208,7 @@ to all the variables defined therein.

-search_index_entry = {'aliases': 'manage bugs manage players manage ideas', 'category': 'general', 'key': 'manage reports', 'no_prefix': ' manage bugs manage players manage ideas', 'tags': '', 'text': '\n manage the various reports\n\n Usage:\n manage [report type]\n\n Available report types:\n bugs\n ideas\n players\n\n Initializes a menu for reviewing and changing the status of current reports.\n '}
+search_index_entry = {'aliases': 'manage players manage bugs manage ideas', 'category': 'general', 'key': 'manage reports', 'no_prefix': ' manage players manage bugs manage ideas', 'tags': '', 'text': '\n manage the various reports\n\n Usage:\n manage [report type]\n\n Available report types:\n bugs\n ideas\n players\n\n Initializes a menu for reviewing and changing the status of current reports.\n '}
diff --git a/docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html b/docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html index 0b54e83fe8..ca9f71eb11 100644 --- a/docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html +++ b/docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html @@ -231,7 +231,7 @@ for that channel.

-aliases = ['delaliaschan', 'delchanalias']
+aliases = ['delchanalias', 'delaliaschan']
@@ -262,7 +262,7 @@ for that channel.

-search_index_entry = {'aliases': 'delaliaschan delchanalias', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delaliaschan delchanalias', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}
+search_index_entry = {'aliases': 'delchanalias delaliaschan', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delchanalias delaliaschan', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}
diff --git a/docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html b/docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html index 989a43c878..bd4b17fe50 100644 --- a/docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html +++ b/docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html @@ -225,7 +225,7 @@ the operation will be general or on the room.

-aliases = ['quit', 'abort', 'q', 'chicken out']
+aliases = ['chicken out', 'q', 'abort', 'quit']
@@ -249,7 +249,7 @@ set in self.parse())

-search_index_entry = {'aliases': 'quit abort q chicken out', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' quit abort q chicken out', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}
+search_index_entry = {'aliases': 'chicken out q abort quit', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' chicken out q abort quit', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}
@@ -270,7 +270,7 @@ set in self.parse())

-aliases = ['ls', 'l']
+aliases = ['l', 'ls']
@@ -304,7 +304,7 @@ set in self.parse())

-search_index_entry = {'aliases': 'ls l', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}
+search_index_entry = {'aliases': 'l ls', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}
@@ -385,7 +385,7 @@ shout

-aliases = ['shout', ';', 'whisper']
+aliases = ['shout', 'whisper', ';']
@@ -414,7 +414,7 @@ set in self.parse())

-search_index_entry = {'aliases': 'shout ; whisper', 'category': 'general', 'key': 'say', 'no_prefix': ' shout ; whisper', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}
+search_index_entry = {'aliases': 'shout whisper ;', 'category': 'general', 'key': 'say', 'no_prefix': ' shout whisper ;', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}
@@ -442,7 +442,7 @@ emote /me points to /box and /lever.

-aliases = [':', 'pose']
+aliases = ['pose', ':']
@@ -481,7 +481,7 @@ set in self.parse())

-search_index_entry = {'aliases': ': pose', 'category': 'general', 'key': 'emote', 'no_prefix': ' : pose', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use "..." to enact speech.\n\n Usage:\n emote <emote>\n :<emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}
+search_index_entry = {'aliases': 'pose :', 'category': 'general', 'key': 'emote', 'no_prefix': ' pose :', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use "..." to enact speech.\n\n Usage:\n emote <emote>\n :<emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}
@@ -504,7 +504,7 @@ looks and what actions is available.

-aliases = ['examine', 'e', 'unfocus', 'ex']
+aliases = ['unfocus', 'ex', 'examine', 'e']
@@ -533,7 +533,7 @@ set in self.parse())

-search_index_entry = {'aliases': 'examine e unfocus ex', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' examine e unfocus ex', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}
+search_index_entry = {'aliases': 'unfocus ex examine e', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' unfocus ex examine e', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}
@@ -595,7 +595,7 @@ set in self.parse())

-aliases = ['give', 'inv', 'i', 'inventory']
+aliases = ['i', 'give', 'inv', 'inventory']
@@ -619,7 +619,7 @@ set in self.parse())

-search_index_entry = {'aliases': 'give inv i inventory', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' give inv i inventory', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
+search_index_entry = {'aliases': 'i give inv inventory', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' i give inv inventory', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
@@ -640,7 +640,7 @@ set in self.parse())

-aliases = ['@dig', '@open']
+aliases = ['@open', '@dig']
@@ -663,7 +663,7 @@ to all the variables defined therein.

-search_index_entry = {'aliases': '@dig @open', 'category': 'general', 'key': 'open', 'no_prefix': ' dig open', 'tags': '', 'text': '\n Interact with an object in focus.\n\n Usage:\n <action> [arg]\n\n '}
+search_index_entry = {'aliases': '@open @dig', 'category': 'general', 'key': 'open', 'no_prefix': ' open dig', 'tags': '', 'text': '\n Interact with an object in focus.\n\n Usage:\n <action> [arg]\n\n '}
diff --git a/docs/latest/api/evennia.contrib.game_systems.barter.barter.html b/docs/latest/api/evennia.contrib.game_systems.barter.barter.html index 180d50f58c..995664a60e 100644 --- a/docs/latest/api/evennia.contrib.game_systems.barter.barter.html +++ b/docs/latest/api/evennia.contrib.game_systems.barter.barter.html @@ -759,7 +759,7 @@ try to influence the other part in the deal.

-aliases = ['offers', 'deal']
+aliases = ['deal', 'offers']
@@ -785,7 +785,7 @@ try to influence the other part in the deal.

-search_index_entry = {'aliases': 'offers deal', 'category': 'trading', 'key': 'status', 'no_prefix': ' offers deal', 'tags': '', 'text': "\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n "}
+search_index_entry = {'aliases': 'deal offers', 'category': 'trading', 'key': 'status', 'no_prefix': ' deal offers', 'tags': '', 'text': "\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n "}
diff --git a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html index c662d4ed02..9dd6a535f0 100644 --- a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html +++ b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html @@ -686,7 +686,7 @@ if there are still any actions you can take.

-aliases = ['wait', 'hold']
+aliases = ['hold', 'wait']
@@ -712,7 +712,7 @@ if there are still any actions you can take.

-search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
+search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
diff --git a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_equip.html b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_equip.html index b43d0f5a48..0bed424fda 100644 --- a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_equip.html +++ b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_equip.html @@ -581,7 +581,7 @@ if there are still any actions you can take.

-aliases = ['wait', 'hold']
+aliases = ['hold', 'wait']
@@ -601,7 +601,7 @@ if there are still any actions you can take.

-search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
+search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
diff --git a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html index 1e2a340556..9b7607f915 100644 --- a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html +++ b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html @@ -704,7 +704,7 @@ if there are still any actions you can take.

-aliases = ['wait', 'hold']
+aliases = ['hold', 'wait']
@@ -724,7 +724,7 @@ if there are still any actions you can take.

-search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
+search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
diff --git a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html index 62ecd7c88e..0f29530eac 100644 --- a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html +++ b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html @@ -483,7 +483,7 @@ if there are still any actions you can take.

-aliases = ['wait', 'hold']
+aliases = ['hold', 'wait']
@@ -503,7 +503,7 @@ if there are still any actions you can take.

-search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
+search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
diff --git a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_range.html b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_range.html index 66eedd87ae..d06a19f299 100644 --- a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_range.html +++ b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_range.html @@ -943,7 +943,7 @@ if there are still any actions you can take.

-aliases = ['wait', 'hold']
+aliases = ['hold', 'wait']
@@ -963,7 +963,7 @@ if there are still any actions you can take.

-search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
+search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
diff --git a/docs/latest/api/evennia.contrib.grid.extended_room.extended_room.html b/docs/latest/api/evennia.contrib.grid.extended_room.extended_room.html index 3f01341f75..712938071f 100644 --- a/docs/latest/api/evennia.contrib.grid.extended_room.extended_room.html +++ b/docs/latest/api/evennia.contrib.grid.extended_room.extended_room.html @@ -657,7 +657,7 @@ look *<account&g
-aliases = ['ls', 'l']
+aliases = ['l', 'ls']
@@ -677,7 +677,7 @@ look *<account&g
-search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}
+search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}
diff --git a/docs/latest/api/evennia.contrib.rpg.dice.dice.html b/docs/latest/api/evennia.contrib.rpg.dice.dice.html index fad4cb5e02..3d7ee8d157 100644 --- a/docs/latest/api/evennia.contrib.rpg.dice.dice.html +++ b/docs/latest/api/evennia.contrib.rpg.dice.dice.html @@ -340,7 +340,7 @@ everyone but the person rolling.

-aliases = ['roll', '@dice']
+aliases = ['@dice', 'roll']
@@ -366,7 +366,7 @@ everyone but the person rolling.

-search_index_entry = {'aliases': 'roll @dice', 'category': 'general', 'key': 'dice', 'no_prefix': ' roll dice', 'tags': '', 'text': "\n roll dice\n\n Usage:\n dice[/switch] <nr>d<sides> [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 < 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (<,>,<=,>=,==,!=). So e.g. 2d6 + 3 > 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n "}
+search_index_entry = {'aliases': '@dice roll', 'category': 'general', 'key': 'dice', 'no_prefix': ' dice roll', 'tags': '', 'text': "\n roll dice\n\n Usage:\n dice[/switch] <nr>d<sides> [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 < 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (<,>,<=,>=,==,!=). So e.g. 2d6 + 3 > 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n "}
diff --git a/docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html b/docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html index e7d57657fb..97a20164de 100644 --- a/docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html +++ b/docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html @@ -736,7 +736,7 @@ commands the caller can use.

-aliases = ["'", '"']
+aliases = ['"', "'"]
@@ -767,7 +767,7 @@ commands the caller can use.

-search_index_entry = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}
+search_index_entry = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}
diff --git a/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html b/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html index 269a797481..5749a8d5e1 100644 --- a/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html +++ b/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html @@ -480,7 +480,7 @@ turn of combat, performing everyone’s actions in random order.

-aliases = ['hit', 'turnbased combat']
+aliases = ['turnbased combat', 'hit']
@@ -526,7 +526,7 @@ set in self.parse())

-search_index_entry = {'aliases': 'hit turnbased combat', 'category': 'general', 'key': 'attack', 'no_prefix': ' hit turnbased combat', 'tags': '', 'text': '\n Start or join combat.\n\n Usage:\n attack [<target>]\n\n '}
+search_index_entry = {'aliases': 'turnbased combat hit', 'category': 'general', 'key': 'attack', 'no_prefix': ' turnbased combat hit', 'tags': '', 'text': '\n Start or join combat.\n\n Usage:\n attack [<target>]\n\n '}
diff --git a/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_twitch.html b/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_twitch.html index 2d9f9a7a5d..dc40c5b194 100644 --- a/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_twitch.html +++ b/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_twitch.html @@ -395,7 +395,7 @@ look *<account&g
-aliases = ['ls', 'l']
+aliases = ['l', 'ls']
@@ -415,7 +415,7 @@ look *<account&g
-search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}
+search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}
diff --git a/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html b/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html index c0bc2608d6..18e51861b5 100644 --- a/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html +++ b/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html @@ -307,7 +307,7 @@ unwear <item>

-aliases = ['unwear', 'unwield']
+aliases = ['unwield', 'unwear']
@@ -331,7 +331,7 @@ set in self.parse())

-search_index_entry = {'aliases': 'unwear unwield', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwear unwield', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}
+search_index_entry = {'aliases': 'unwield unwear', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwield unwear', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}
diff --git a/docs/latest/api/evennia.contrib.tutorials.red_button.red_button.html b/docs/latest/api/evennia.contrib.tutorials.red_button.red_button.html index 382de35876..dd4d2e080d 100644 --- a/docs/latest/api/evennia.contrib.tutorials.red_button.red_button.html +++ b/docs/latest/api/evennia.contrib.tutorials.red_button.red_button.html @@ -167,7 +167,7 @@ such as when closing the lid and un-blinding a character.

-aliases = ['push', 'press button', 'press']
+aliases = ['press button', 'push', 'press']
@@ -196,7 +196,7 @@ check if the lid is open or closed.

-search_index_entry = {'aliases': 'push press button press', 'category': 'general', 'key': 'push button', 'no_prefix': ' push press button press', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}
+search_index_entry = {'aliases': 'press button push press', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button push press', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}
@@ -266,7 +266,7 @@ check if the lid is open or closed.

-aliases = ['break lid', 'smash lid', 'smash']
+aliases = ['break lid', 'smash', 'smash lid']
@@ -293,7 +293,7 @@ break.

-search_index_entry = {'aliases': 'break lid smash lid smash', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' break lid smash lid smash', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}
+search_index_entry = {'aliases': 'break lid smash smash lid', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' break lid smash smash lid', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}
@@ -393,7 +393,7 @@ be mutually exclusive.

-aliases = ['push', 'press button', 'press']
+aliases = ['press button', 'push', 'press']
@@ -422,7 +422,7 @@ set in self.parse())

-search_index_entry = {'aliases': 'push press button press', 'category': 'general', 'key': 'push button', 'no_prefix': ' push press button press', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}
+search_index_entry = {'aliases': 'press button push press', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button push press', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}
@@ -520,7 +520,7 @@ be mutually exclusive.

-aliases = ['examine', 'l', 'feel', 'ex', 'listen', 'get']
+aliases = ['feel', 'listen', 'ex', 'examine', 'get', 'l']
@@ -546,7 +546,7 @@ be mutually exclusive.

-search_index_entry = {'aliases': 'examine l feel ex listen get', 'category': 'general', 'key': 'look', 'no_prefix': ' examine l feel ex listen get', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}
+search_index_entry = {'aliases': 'feel listen ex examine get l', 'category': 'general', 'key': 'look', 'no_prefix': ' feel listen ex examine get l', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}
diff --git a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html index a5025a48c7..ff392ff9b1 100644 --- a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html +++ b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html @@ -439,7 +439,7 @@ of the object. We overload it with our own version.

-aliases = ['light', 'burn']
+aliases = ['burn', 'light']
@@ -466,7 +466,7 @@ to sit on a “lightable” object, we operate only on self.obj.

-search_index_entry = {'aliases': 'light burn', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' light burn', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}
+search_index_entry = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' burn light', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}
@@ -570,7 +570,7 @@ shift green root up/down

-aliases = ['pull', 'push', 'shiftroot', 'move']
+aliases = ['shiftroot', 'push', 'move', 'pull']
@@ -606,7 +606,7 @@ yellow/green - horizontal roots

-search_index_entry = {'aliases': 'pull push shiftroot move', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' pull push shiftroot move', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}
+search_index_entry = {'aliases': 'shiftroot push move pull', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' shiftroot push move pull', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}
@@ -793,7 +793,7 @@ parry - forgoes your attack but will make you harder to hit on next

-aliases = ['pierce', 'chop', 'defend', 'slash', 'hit', 'fight', 'stab', 'parry', 'kill', 'thrust', 'bash']
+aliases = ['pierce', 'bash', 'hit', 'slash', 'kill', 'chop', 'fight', 'parry', 'stab', 'thrust', 'defend']
@@ -819,7 +819,7 @@ parry - forgoes your attack but will make you harder to hit on next

-search_index_entry = {'aliases': 'pierce chop defend slash hit fight stab parry kill thrust bash', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' pierce chop defend slash hit fight stab parry kill thrust bash', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}
+search_index_entry = {'aliases': 'pierce bash hit slash kill chop fight parry stab thrust defend', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' pierce bash hit slash kill chop fight parry stab thrust defend', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}
diff --git a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html index ac3d99302d..0667892635 100644 --- a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html +++ b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html @@ -262,7 +262,7 @@ code except for adding in the details.

-aliases = ['ls', 'l']
+aliases = ['l', 'ls']
@@ -277,7 +277,7 @@ code except for adding in the details.

-search_index_entry = {'aliases': 'ls l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}
+search_index_entry = {'aliases': 'l ls', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}
@@ -830,7 +830,7 @@ if they fall off the bridge.

-aliases = ['?', 'h']
+aliases = ['h', '?']
@@ -856,7 +856,7 @@ if they fall off the bridge.

-search_index_entry = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}
+search_index_entry = {'aliases': 'h ?', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}
@@ -982,7 +982,7 @@ to find something.

-aliases = ['feel around', 'l', 'search', 'fiddle', 'feel']
+aliases = ['feel', 'feel around', 'fiddle', 'search', 'l']
@@ -1010,7 +1010,7 @@ random chance of eventually finding a light source.

-search_index_entry = {'aliases': 'feel around l search fiddle feel', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' feel around l search fiddle feel', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}
+search_index_entry = {'aliases': 'feel feel around fiddle search l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' feel feel around fiddle search l', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}
diff --git a/docs/latest/api/evennia.contrib.utils.git_integration.git_integration.html b/docs/latest/api/evennia.contrib.utils.git_integration.git_integration.html index b8215fc423..a98a156025 100644 --- a/docs/latest/api/evennia.contrib.utils.git_integration.git_integration.html +++ b/docs/latest/api/evennia.contrib.utils.git_integration.git_integration.html @@ -222,7 +222,7 @@ git evennia pull - Pull the latest evennia code.

-directory = '/tmp/tmp3cqwtgfk/f2a5c5a85a7858b24141b8ddbb79ff16eb390308/evennia'
+directory = '/tmp/tmpf7czyky3/e01f79acc2eee43166ab6d445a967b08a46316dd/evennia'
@@ -283,7 +283,7 @@ git pull - Pull the latest code from your current branch.

-directory = '/tmp/tmp3cqwtgfk/f2a5c5a85a7858b24141b8ddbb79ff16eb390308/evennia/game_template'
+directory = '/tmp/tmpf7czyky3/e01f79acc2eee43166ab6d445a967b08a46316dd/evennia/game_template'
diff --git a/docs/latest/api/evennia.objects.manager.html b/docs/latest/api/evennia.objects.manager.html index 29837432cf..98e39b3b43 100644 --- a/docs/latest/api/evennia.objects.manager.html +++ b/docs/latest/api/evennia.objects.manager.html @@ -298,8 +298,7 @@ to exclude from the match.

  • ostring (str) – A search criterion.

  • exact (bool, optional) – Require exact match of ostring -(still case-insensitive). If False, will do fuzzy matching -using evennia.utils.utils.string_partial_matching algorithm.

    • +(still case-insensitive). If False, will do fuzzy matching with a regex filter.

  • candidates (list) – Only match among these candidates.

  • typeclasses (list) – Only match objects with typeclasses having thess path strings.

@@ -314,15 +313,14 @@ using evennia.utils.utils.string_partial_matching algorithm.

search_object(searchdata, attribute_name=None, typeclass=None, candidates=None, exact=True, use_dbref=True, tags=None)[source]

Search as an object globally or in a list of candidates and -return results. The result is always an Object. Always returns -a list.

+return results. Always returns a QuerySet of Objects.

Parameters

  • searchdata (str or Object) – The entity to match for. This is usually a key string but may also be an object itself. By default (if no attribute_name is set), this will -search object.key and object.aliases in order. +search object.key and object.aliases. Can also be on the form #dbref, which will (if exact=True) be matched against primary key.

  • attribute_name (str) – Use this named Attribute to @@ -353,7 +351,7 @@ a match.

Returns
-

matches (list) – Matching objects

+

matches (QuerySet) – Matching objects

@@ -362,15 +360,14 @@ a match.

Search as an object globally or in a list of candidates and -return results. The result is always an Object. Always returns -a list.

+return results. Always returns a QuerySet of Objects.

Parameters

  • searchdata (str or Object) – The entity to match for. This is usually a key string but may also be an object itself. By default (if no attribute_name is set), this will -search object.key and object.aliases in order. +search object.key and object.aliases. Can also be on the form #dbref, which will (if exact=True) be matched against primary key.

  • attribute_name (str) – Use this named Attribute to @@ -401,7 +398,7 @@ a match.

Returns
-

matches (list) – Matching objects

+

matches (QuerySet) – Matching objects

@@ -410,15 +407,14 @@ a match.

search(searchdata, attribute_name=None, typeclass=None, candidates=None, exact=True, use_dbref=True, tags=None)

Search as an object globally or in a list of candidates and -return results. The result is always an Object. Always returns -a list.

+return results. Always returns a QuerySet of Objects.

Parameters

  • searchdata (str or Object) – The entity to match for. This is usually a key string but may also be an object itself. By default (if no attribute_name is set), this will -search object.key and object.aliases in order. +search object.key and object.aliases. Can also be on the form #dbref, which will (if exact=True) be matched against primary key.

  • attribute_name (str) – Use this named Attribute to @@ -449,7 +445,7 @@ a match.

Returns
-

matches (list) – Matching objects

+

matches (QuerySet) – Matching objects

diff --git a/docs/latest/api/evennia.utils.eveditor.html b/docs/latest/api/evennia.utils.eveditor.html index 6cca07390e..32cbc10791 100644 --- a/docs/latest/api/evennia.utils.eveditor.html +++ b/docs/latest/api/evennia.utils.eveditor.html @@ -356,7 +356,7 @@ indentation.

-aliases = [':uu', ':q', ':echo', ':I', ':=', ':dd', ':j', ':dw', ':::', ':A', ':s', ':!', ':r', ':fd', ':u', ':y', ':wq', ':w', ':<', ':DD', ':>', ':fi', ':S', ':q!', ':', ':i', ':p', '::', ':h', ':UU', ':f', ':x']
+aliases = [':u', ':>', ':dd', ':s', ':wq', '::', ':i', ':w', ':I', ':r', ':fi', ':UU', ':::', ':', ':dw', ':echo', ':fd', ':q', ':S', ':x', ':A', ':p', ':=', ':j', ':h', ':<', ':!', ':y', ':f', ':q!', ':DD', ':uu']
@@ -384,7 +384,7 @@ efficient presentation.

-search_index_entry = {'aliases': ':uu :q :echo :I := :dd :j :dw ::: :A :s :! :r :fd :u :y :wq :w :< :DD :> :fi :S :q! : :i :p :: :h :UU :f :x', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :uu :q :echo :I := :dd :j :dw ::: :A :s :! :r :fd :u :y :wq :w :< :DD :> :fi :S :q! : :i :p :: :h :UU :f :x', 'tags': '', 'text': '\n Commands for the editor\n '}
+search_index_entry = {'aliases': ':u :> :dd :s :wq :: :i :w :I :r :fi :UU ::: : :dw :echo :fd :q :S :x :A :p := :j :h :< :! :y :f :q! :DD :uu', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :u :> :dd :s :wq :: :i :w :I :r :fi :UU ::: : :dw :echo :fd :q :S :x :A :p := :j :h :< :! :y :f :q! :DD :uu', 'tags': '', 'text': '\n Commands for the editor\n '}
diff --git a/docs/latest/api/evennia.utils.evmenu.html b/docs/latest/api/evennia.utils.evmenu.html index 09b8b90e1d..56ba2c5d34 100644 --- a/docs/latest/api/evennia.utils.evmenu.html +++ b/docs/latest/api/evennia.utils.evmenu.html @@ -955,7 +955,7 @@ single question.

-aliases = ['no', 'y', 'yes', 'a', '__nomatch_command', 'n', 'abort']
+aliases = ['a', 'y', 'no', 'yes', 'abort', '__nomatch_command', 'n']
@@ -981,7 +981,7 @@ single question.

-search_index_entry = {'aliases': 'no y yes a __nomatch_command n abort', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' no y yes a __nomatch_command n abort', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}
+search_index_entry = {'aliases': 'a y no yes abort __nomatch_command n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' a y no yes abort __nomatch_command n', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}
diff --git a/docs/latest/api/evennia.utils.evmore.html b/docs/latest/api/evennia.utils.evmore.html index 70f96d0e6c..ab2400d885 100644 --- a/docs/latest/api/evennia.utils.evmore.html +++ b/docs/latest/api/evennia.utils.evmore.html @@ -151,7 +151,7 @@ the caller.msg() construct every time the page is updated.

-aliases = ['next', 'q', 'top', 'p', 'a', 't', 'e', 'previous', 'end', 'quit', 'n', 'abort']
+aliases = ['a', 'quit', 'end', 'previous', 'abort', 'next', 'e', 't', 'q', 'p', 'n', 'top']
@@ -177,7 +177,7 @@ the caller.msg() construct every time the page is updated.

-search_index_entry = {'aliases': 'next q top p a t e previous end quit n abort', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' next q top p a t e previous end quit n abort', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
+search_index_entry = {'aliases': 'a quit end previous abort next e t q p n top', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' a quit end previous abort next e t q p n top', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
diff --git a/docs/latest/api/evennia.utils.search.html b/docs/latest/api/evennia.utils.search.html index e01c746739..71a1f3c044 100644 --- a/docs/latest/api/evennia.utils.search.html +++ b/docs/latest/api/evennia.utils.search.html @@ -136,15 +136,14 @@ there is only one match) unless noted otherwise.

evennia.utils.search.search_object(searchdata, attribute_name=None, typeclass=None, candidates=None, exact=True, use_dbref=True, tags=None)

Search as an object globally or in a list of candidates and -return results. The result is always an Object. Always returns -a list.

+return results. Always returns a QuerySet of Objects.

Parameters

  • searchdata (str or Object) – The entity to match for. This is usually a key string but may also be an object itself. By default (if no attribute_name is set), this will -search object.key and object.aliases in order. +search object.key and object.aliases. Can also be on the form #dbref, which will (if exact=True) be matched against primary key.

  • attribute_name (str) – Use this named Attribute to @@ -175,7 +174,7 @@ a match.

Returns
-

matches (list) – Matching objects

+

matches (QuerySet) – Matching objects

diff --git a/docs/latest/index.html b/docs/latest/index.html index 21fee58bf2..769dc05cd5 100644 --- a/docs/latest/index.html +++ b/docs/latest/index.html @@ -118,7 +118,7 @@

Evennia Documentation

-

This is the manual of Evennia, the open source Python MU* creation system. Use the Search bar on the left to find or discover interesting articles. This manual was last updated September 10, 2024, see the Evennia Changelog. Latest released Evennia version is 4.3.0.

+

This is the manual of Evennia, the open source Python MU* creation system. Use the Search bar on the left to find or discover interesting articles. This manual was last updated September 29, 2024, see the Evennia Changelog. Latest released Evennia version is 4.3.0.