From 63fe1702545776d3105bacfac451238953989c60 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Mon, 1 Apr 2024 09:15:56 +0000 Subject: [PATCH] Updated HTML docs. --- docs/latest/.buildinfo | 2 +- docs/latest/Coding/Changelog.html | 7 +++++ docs/latest/Contributing-Docs.html | 19 ++++++++++++ .../evennia/commands/default/building.html | 28 ++++++++++++++---- .../evennia/commands/default/tests.html | 19 +++++++++++- .../_modules/evennia/utils/eveditor.html | 9 ++---- docs/latest/_modules/evennia/utils/utils.html | 18 +++++++++++ docs/latest/_sources/Coding/Changelog.md.txt | 11 +++++++ docs/latest/_sources/Contributing-Docs.md.txt | 15 +++++++++- .../api/evennia.commands.default.admin.html | 4 +-- ...evennia.commands.default.batchprocess.html | 4 +-- .../evennia.commands.default.building.html | 17 ++++++----- .../api/evennia.commands.default.general.html | 8 ++--- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 8 ++--- ....base_systems.email_login.email_login.html | 8 ++--- ...systems.mux_comms_cmds.mux_comms_cmds.html | 4 +-- ...rib.full_systems.evscaperoom.commands.html | 16 +++++----- ...ontrib.game_systems.clothing.clothing.html | 4 +-- ...evennia.contrib.grid.xyzgrid.commands.html | 4 +-- ...utorials.evadventure.combat_turnbased.html | 4 +-- ...b.tutorials.evadventure.combat_twitch.html | 4 +-- ...ontrib.tutorials.evadventure.commands.html | 8 ++--- ...ntrib.tutorials.red_button.red_button.html | 16 +++++----- ...trib.tutorials.tutorial_world.objects.html | 12 ++++---- ...ontrib.tutorials.tutorial_world.rooms.html | 4 +-- ...utils.git_integration.git_integration.html | 4 +-- 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.utils.html | 14 +++++++++ docs/latest/genindex.html | 2 ++ docs/latest/index.html | 1 + docs/latest/objects.inv | Bin 168709 -> 168790 bytes docs/latest/searchindex.js | 2 +- 35 files changed, 205 insertions(+), 85 deletions(-) diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo index d97e14281e..f4b1b0a9db 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: 045cb0b524198abc1cbf591a1f6615ad +config: b1e80c5fb0e553828115c486c02c1902 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/latest/Coding/Changelog.html b/docs/latest/Coding/Changelog.html index a87a3439c9..5d1523d1e7 100644 --- a/docs/latest/Coding/Changelog.html +++ b/docs/latest/Coding/Changelog.html @@ -202,6 +202,8 @@ default object’s adding line breaks in hook returns. (InspectorCaracal)

  • Feature: New sethelp/category switch to change a help topic’s category after it was created (chiizujin)

    • +

  • Feature: Add alias/delete switch for removing object aliases +from in-game with default command (chiizujin)

  • Fix: Use plural (‘no apples’) instead of singular (‘no apple’) in get_numbered_name for better grammatical form (InspectorCaracal)

  • Fix: Object aliases not showing in search multi-match @@ -214,6 +216,11 @@ to disappear for wider client widths (chiizujin)

    • duplicates (chiizujin)

  • Fix: Traceback in crafting contrib’s recipe.msg (InspectorCaracal)

    • +

  • Fix: EvEditor line-echo compacted whitespace erroneously (chiizujin)

    • +

  • Fix: EvEditor :help described the :paste operation in the wrong +way (chiizujin)

    • +

  • Fix: EvEditor range:range specification didn’t return correct +range (chiizujin)

  • Doc: Added Beginner Tutorial lessons for AI, Quests and Procedural dungeon (Griatch)

  • Doc fixes (Griatch, InspectorCaracal)

    • diff --git a/docs/latest/Contributing-Docs.html b/docs/latest/Contributing-Docs.html index 1b5f021868..05166ea6c3 100644 --- a/docs/latest/Contributing-Docs.html +++ b/docs/latest/Contributing-Docs.html @@ -66,6 +66,7 @@
    • Contributing to Evennia Docs
      • Source file structure
        • +
      • Automatically generated doc pages
      • Editing syntax
        • Italic/Bold
        • Headings
          • @@ -187,6 +188,24 @@ result in Evennia. This is often on a tutorial or FAQ form and will refer to the

        • conf.py holds the Sphinx configuration. It should usually not be modified except to update the Evennia version on a new branch.

        +
        +

        Automatically generated doc pages

        +

        Some doc pages are automatically generated. Changes to their generated markdown file will be overwritten. Instead they must be modified at the point the automation reads the text from.

        +
          +

        • All API docs under source/api are built from the doc strings of Evennia core code. Documentation fixes for these needs to be done in the doc strings of the relevant module, function, class or method.

          • +

        • Contribs/Contribs-Overview.md is completely generated from scratch when building the docs, by the script evennia/docs/pylib/contrib_readmes2docs.py.

          +
            +

          • All contrib blurbs on the above page are taken from the first paragraph of each contrib’s README.md, found under evennia/contrib/*/*/README.md.

            • +

          • Similarly, all contrib documentation linked from the above page is generated from each contrib’s README.md file.

            • +
          +
          • +

        • Components/Default-Commands.md is generated from the command classes found under evennia/commands/default/.

          • +

        • Coding/Evennia-Code-Style.md is generated from evennia/CODING_STYLE.md.

          • +

        • Coding/Changelog.md is generated from evennia/CHANGELOG.md

          • +

        • Setup/Settings-Default.md is generated from the default settings file evennia/default_settings.py

          • +
        +

        Most auto-generated pages have a warning in the header indicating that it’s auto-generated.

        +

        Editing syntax

        The format used for Evennia’s docs is Markdown (Commonmark). While markdown diff --git a/docs/latest/_modules/evennia/commands/default/building.html b/docs/latest/_modules/evennia/commands/default/building.html index f6f6a78f5b..98e7a656db 100644 --- a/docs/latest/_modules/evennia/commands/default/building.html +++ b/docs/latest/_modules/evennia/commands/default/building.html @@ -310,10 +310,13 @@ alias <obj> [= [alias[,alias,alias,...]]] alias <obj> = alias/category <obj> = [alias[,alias,...]:<category> + alias/delete <obj> = <alias> Switches: category - requires ending input with :category, to store the given aliases with the given category. + delete - deletes all occurrences of the given alias, regardless + of category Assigns aliases to an object so it can be referenced by more than one name. Assign empty to remove all aliases from object. If @@ -327,7 +330,7 @@ key = "@alias" aliases = "setobjalias" - switch_options = ("category",) + switch_options = ("category", "delete") locks = "cmd:perm(setobjalias) or perm(Builder)" help_category = "Building" @@ -344,12 +347,12 @@ return objname = self.lhs - # Find the object to receive aliases + # Find the object to receive/delete aliases obj = caller.search(objname) if not obj: return - if self.rhs is None: - # no =, so we just list aliases on object. + if self.rhs is None and 'delete' not in self.switches: + # no =, and not deleting, so we just list aliases on object. aliases = obj.aliases.all(return_key_and_category=True) if aliases: caller.msg( @@ -372,7 +375,9 @@ return if not self.rhs: - # we have given an empty =, so delete aliases + # we have given an empty =, so delete aliases. + # as a side-effect, 'alias/delete obj' and 'alias/delete obj=' + # will also be caught here, which is fine old_aliases = obj.aliases.all() if old_aliases: caller.msg( @@ -384,6 +389,19 @@ caller.msg("No aliases to clear.") return + if "delete" in self.switches: + # delete all matching keys, regardless of category + existed = False + for key, category in obj.aliases.all(return_key_and_category=True): + if key == self.rhs: + obj.aliases.remove(key=self.rhs, category=category) + existed = True + if existed: + caller.msg("Alias '%s' deleted from %s." % (self.rhs, obj.get_display_name(caller))) + else: + caller.msg("%s has no alias '%s'." % (obj.get_display_name(caller), self.rhs)) + return + category = None if "category" in self.switches: if ":" in self.rhs: diff --git a/docs/latest/_modules/evennia/commands/default/tests.html b/docs/latest/_modules/evennia/commands/default/tests.html index cd9d7b3912..1a28901ecf 100644 --- a/docs/latest/_modules/evennia/commands/default/tests.html +++ b/docs/latest/_modules/evennia/commands/default/tests.html @@ -880,7 +880,24 @@ self.call(building.CmdSetObjAlias(), "Obj", "Aliases for Obj: 'testobj1b'") self.call(building.CmdSetObjAlias(), "Obj2 =", "Cleared aliases from Obj2") - self.call(building.CmdSetObjAlias(), "Obj2 =", "No aliases to clear.") + self.call(building.CmdSetObjAlias(), "Obj2 =", "No aliases to clear.") + + self.call(building.CmdSetObjAlias(), "Obj =", "Cleared aliases from Obj: testobj1b") + self.call(building.CmdSetObjAlias(), + "/category Obj = testobj1b:category1", + "Alias(es) for 'Obj' set to 'testobj1b' (category: 'category1')." + ) + self.call( + building.CmdSetObjAlias(), + "/category Obj = testobj1b:category2", + "Alias(es) for 'Obj' set to 'testobj1b,testobj1b' (category: 'category2')." + ) + self.call( + building.CmdSetObjAlias(), # delete both occurences of alias 'testobj1b' + "/delete Obj = testobj1b", + "Alias 'testobj1b' deleted from Obj." + ) + self.call(building.CmdSetObjAlias(), "Obj =", "No aliases to clear.")

        [docs] def test_copy(self): self.call( diff --git a/docs/latest/_modules/evennia/utils/eveditor.html b/docs/latest/_modules/evennia/utils/eveditor.html index 7d88d5e201..89b0983b23 100644 --- a/docs/latest/_modules/evennia/utils/eveditor.html +++ b/docs/latest/_modules/evennia/utils/eveditor.html @@ -397,12 +397,9 @@ linerange = False if arglist and arglist[0].count(":") == 1: part1, part2 = arglist[0].split(":") - if part1 and part1.isdigit(): - lstart = min(max(0, int(part1)) - 1, nlines) - linerange = True - if part2 and part2.isdigit(): - lend = min(lstart + 1, int(part2)) + 1 - linerange = True + lstart = min(max(1, int(part1)), nlines) - 1 if utils.value_is_integer(part1) else 0 + lend = min(max(lstart + 1, int(part2)), nlines) if utils.value_is_integer(part2) else nlines + linerange = True elif arglist and arglist[0].isdigit(): lstart = min(max(0, int(arglist[0]) - 1), nlines) lend = lstart + 1 diff --git a/docs/latest/_modules/evennia/utils/utils.html b/docs/latest/_modules/evennia/utils/utils.html index beda03ced3..f0b9334b9e 100644 --- a/docs/latest/_modules/evennia/utils/utils.html +++ b/docs/latest/_modules/evennia/utils/utils.html @@ -3169,6 +3169,24 @@ logger.log_warn("ip_from_request: No valid IP address found in request. Using remote_addr.") return remote_addr
        + + +
        [docs]def value_is_integer(value): + """ + Determines if a value can be type-cast to an integer. + + Args: + value (any): The value to check. + + Returns: + result (bool): Whether it can be type-cast to an integer or not. + """ + try: + int(value) + except ValueError: + return False + + return True
        diff --git a/docs/latest/_sources/Coding/Changelog.md.txt b/docs/latest/_sources/Coding/Changelog.md.txt index 3349e8a9d9..980dcc8c8a 100644 --- a/docs/latest/_sources/Coding/Changelog.md.txt +++ b/docs/latest/_sources/Coding/Changelog.md.txt @@ -7,6 +7,8 @@ adding line breaks in hook returns. (InspectorCaracal) - [Feature][pull3458]: New `sethelp/category` switch to change a help topic's category after it was created (chiizujin) +- [Feature][pull3467]: Add `alias/delete` switch for removing object aliases + from in-game with default command (chiizujin) - [Fix][pull3446]: Use plural ('no apples') instead of singular ('no apple') in `get_numbered_name` for better grammatical form (InspectorCaracal) - [Fix][pull3453]: Object aliases not showing in search multi-match @@ -19,6 +21,11 @@ duplicates (chiizujin) - [Fix][pull3454]: Traceback in crafting contrib's `recipe.msg` (InspectorCaracal) +- [Fix][pull3459]: EvEditor line-echo compacted whitespace erroneously (chiizujin) +- [Fix][pull3463]: EvEditor :help described the :paste operation in the wrong + way (chiizujin) +- [Fix][pull3464]: EvEditor range:range specification didn't return correct + range (chiizujin) - Doc: Added Beginner Tutorial lessons for AI, Quests and Procedural dungeon (Griatch) - Doc fixes (Griatch, InspectorCaracal) @@ -30,6 +37,10 @@ [pull3457]: https://github.com/evennia/evennia/pull/3457 [pull3458]: https://github.com/evennia/evennia/pull/3458 [pull3454]: https://github.com/evennia/evennia/pull/3454 +[pull3459]: https://github.com/evennia/evennia/pull/3459 +[pull3463]: https://github.com/evennia/evennia/pull/3463 +[pull3464]: https://github.com/evennia/evennia/pull/3464 +[pull3467]: https://github.com/evennia/evennia/pull/3467 ## Evennia 4.0.0 diff --git a/docs/latest/_sources/Contributing-Docs.md.txt b/docs/latest/_sources/Contributing-Docs.md.txt index d595fd398a..0308cfdceb 100644 --- a/docs/latest/_sources/Contributing-Docs.md.txt +++ b/docs/latest/_sources/Contributing-Docs.md.txt @@ -23,12 +23,25 @@ at the root of `evennia/docs/source/`. result in Evennia. This is often on a tutorial or FAQ form and will refer to the rest of the documentation for further reading. - `source/Howtos/Beginner-Tutorial/` holds all documents part of the initial tutorial sequence. - Other files and folders: - `source/api/` contains the auto-generated API documentation as `.html` files. Don't edit these files manually, they are auto-generated from sources. - `source/_templates` and `source/_static` hold files for the doc itself. They should only be modified if wanting to change the look and structure of the documentation generation itself. - `conf.py` holds the Sphinx configuration. It should usually not be modified except to update the Evennia version on a new branch. +## Automatically generated doc pages + +Some doc pages are automatically generated. Changes to their generated markdown file will be overwritten. Instead they must be modified at the point the automation reads the text from. + +- All API docs under `source/api` are built from the doc strings of Evennia core code. Documentation fixes for these needs to be done in the doc strings of the relevant module, function, class or method. +- [Contribs/Contribs-Overview.md](Contribs/Contribs-Overview.md) is completely generated from scratch when building the docs, by the script `evennia/docs/pylib/contrib_readmes2docs.py`. + - All contrib blurbs on the above page are taken from the first paragraph of each contrib's `README.md`, found under `evennia/contrib/*/*/README.md`. + - Similarly, all contrib documentation linked from the above page is generated from each contrib's `README.md` file. +- [Components/Default-Commands.md](Components/Default-Commands.md) is generated from the command classes found under `evennia/commands/default/`. +- [Coding/Evennia-Code-Style.md](Coding/Evennia-Code-Style.md) is generated from `evennia/CODING_STYLE.md`. +- [Coding/Changelog.md](Coding/Changelog.md) is generated from `evennia/CHANGELOG.md` +- [Setup/Settings-Default.md](Setup/Settings-Default.md) is generated from the default settings file `evennia/default_settings.py` + +Most auto-generated pages have a warning in the header indicating that it's auto-generated. ## Editing syntax diff --git a/docs/latest/api/evennia.commands.default.admin.html b/docs/latest/api/evennia.commands.default.admin.html index 0a96bab33d..1e73ac7e58 100644 --- a/docs/latest/api/evennia.commands.default.admin.html +++ b/docs/latest/api/evennia.commands.default.admin.html @@ -331,7 +331,7 @@ to accounts respectively.

        -aliases = ['pemit', 'remit']
        +aliases = ['remit', 'pemit']
        @@ -362,7 +362,7 @@ to accounts respectively.

        -search_index_entry = {'aliases': 'pemit remit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' pemit remit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [<obj>, <obj>, ... =] <message>\n remit [<obj>, <obj>, ... =] <message>\n pemit [<obj>, <obj>, ... =] <message>\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}
        +search_index_entry = {'aliases': 'remit pemit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' remit pemit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [<obj>, <obj>, ... =] <message>\n remit [<obj>, <obj>, ... =] <message>\n pemit [<obj>, <obj>, ... =] <message>\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}
        diff --git a/docs/latest/api/evennia.commands.default.batchprocess.html b/docs/latest/api/evennia.commands.default.batchprocess.html index 9b80e97757..5a7b88c2de 100644 --- a/docs/latest/api/evennia.commands.default.batchprocess.html +++ b/docs/latest/api/evennia.commands.default.batchprocess.html @@ -152,7 +152,7 @@ skipping, reloading etc.

        -aliases = ['batchcommand', 'batchcmd']
        +aliases = ['batchcmd', 'batchcommand']
        @@ -183,7 +183,7 @@ skipping, reloading etc.

        -search_index_entry = {'aliases': 'batchcommand batchcmd', 'category': 'building', 'key': 'batchcommands', 'no_prefix': ' batchcommand batchcmd', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}
        +search_index_entry = {'aliases': 'batchcmd batchcommand', 'category': 'building', 'key': 'batchcommands', 'no_prefix': ' batchcmd batchcommand', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}
        diff --git a/docs/latest/api/evennia.commands.default.building.html b/docs/latest/api/evennia.commands.default.building.html index 1f63077bb6..637945eab5 100644 --- a/docs/latest/api/evennia.commands.default.building.html +++ b/docs/latest/api/evennia.commands.default.building.html @@ -215,11 +215,14 @@ Others are “cmd_dig”, “cmd_open”, “cmd_tunnel”, etc.

        • Usage:

        alias <obj> [= [alias[,alias,alias,…]]] alias <obj> = -alias/category <obj> = [alias[,alias,…]:<category>

        +alias/category <obj> = [alias[,alias,…]:<category> +alias/delete <obj> = <alias>

        Switches:
        category - requires ending input with :category, to store the

        given aliases with the given category.

        +
        delete - deletes all occurrences of the given alias, regardless

        of category

        +
        @@ -242,7 +245,7 @@ by everyone.

        -switch_options = ('category',)
        +switch_options = ('category', 'delete')
        @@ -273,7 +276,7 @@ by everyone.

        -search_index_entry = {'aliases': 'setobjalias', 'category': 'building', 'key': '@alias', 'no_prefix': 'alias setobjalias', 'tags': '', 'text': "\n adding permanent aliases for object\n\n Usage:\n alias <obj> [= [alias[,alias,alias,...]]]\n alias <obj> =\n alias/category <obj> = [alias[,alias,...]:<category>\n\n Switches:\n category - requires ending input with :category, to store the\n given aliases with the given category.\n\n Assigns aliases to an object so it can be referenced by more\n than one name. Assign empty to remove all aliases from object. If\n assigning a category, all aliases given will be using this category.\n\n Observe that this is not the same thing as personal aliases\n created with the 'nick' command! Aliases set with alias are\n changing the object in question, making those aliases usable\n by everyone.\n "}
        +search_index_entry = {'aliases': 'setobjalias', 'category': 'building', 'key': '@alias', 'no_prefix': 'alias setobjalias', 'tags': '', 'text': "\n adding permanent aliases for object\n\n Usage:\n alias <obj> [= [alias[,alias,alias,...]]]\n alias <obj> =\n alias/category <obj> = [alias[,alias,...]:<category>\n alias/delete <obj> = <alias>\n\n Switches:\n category - requires ending input with :category, to store the\n given aliases with the given category.\n delete - deletes all occurrences of the given alias, regardless\n of category\n\n Assigns aliases to an object so it can be referenced by more\n than one name. Assign empty to remove all aliases from object. If\n assigning a category, all aliases given will be using this category.\n\n Observe that this is not the same thing as personal aliases\n created with the 'nick' command! Aliases set with alias are\n changing the object in question, making those aliases usable\n by everyone.\n "}
        @@ -643,7 +646,7 @@ You can specify the /force switch to bypass this confirmation.

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

        -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 '}
        +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 '}
        @@ -1411,7 +1414,7 @@ server settings.

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

        -search_index_entry = {'aliases': '@update @typeclasses @swap @type @parent', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass update typeclasses swap type parent', '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': '@parent @typeclasses @type @swap @update', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass parent typeclasses type swap 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 "}
        diff --git a/docs/latest/api/evennia.commands.default.general.html b/docs/latest/api/evennia.commands.default.general.html index ad63246dce..8f71de335d 100644 --- a/docs/latest/api/evennia.commands.default.general.html +++ b/docs/latest/api/evennia.commands.default.general.html @@ -337,7 +337,7 @@ inv

        -aliases = ['inv', 'i']
        +aliases = ['i', 'inv']
        @@ -368,7 +368,7 @@ inv

        -search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
        +search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
        @@ -723,7 +723,7 @@ automatically begin with your name.

        -aliases = ['emote', ':']
        +aliases = [':', 'emote']
        @@ -764,7 +764,7 @@ space.

        -search_index_entry = {'aliases': 'emote :', 'category': 'general', 'key': 'pose', 'no_prefix': ' emote :', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}
        +search_index_entry = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'no_prefix': ' : emote', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}
        diff --git a/docs/latest/api/evennia.commands.default.tests.html b/docs/latest/api/evennia.commands.default.tests.html index d1661972eb..506fd751c5 100644 --- a/docs/latest/api/evennia.commands.default.tests.html +++ b/docs/latest/api/evennia.commands.default.tests.html @@ -975,7 +975,7 @@ main test suite started with

        Test the batch processor.

        -red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpsgau2ds0/6431b5c6c48826e4ec0aa51b8c718677e6a43fd5/evennia/contrib/tutorials/red_button/red_button.py'>
        +red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpsd70qei1/7cce317da0f28b615fa6a15ff176e7e3d3169695/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 0aad904baf..e88bb49569 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 = ['conn', 'co', 'con']
        +aliases = ['co', 'conn', 'con']
        @@ -171,7 +171,7 @@ there is no object yet before the account has logged in)

        -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 '}
        +search_index_entry = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'no_prefix': ' co conn 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 '}
        @@ -256,7 +256,7 @@ version is a bit more complicated.

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

        -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 '}
        +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 '}
        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 9b77346f2c..8ddeba981f 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 = ['conn', 'co', 'con']
        +aliases = ['co', 'conn', 'con']
        @@ -183,7 +183,7 @@ there is no object yet before the account has logged in)

        -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 '}
        +search_index_entry = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'no_prefix': ' co conn 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 '}
        @@ -266,7 +266,7 @@ version is a bit more complicated.

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

        -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 '}
        +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 '}
        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 9cb93a4627..6f78c0d57a 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 = ['delchanalias', 'delaliaschan']
        +aliases = ['delaliaschan', 'delchanalias']
        @@ -262,7 +262,7 @@ for that channel.

        -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 "}
        +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 "}
        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 e144969079..7fdf7fd44c 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 = ['abort', 'chicken out', 'q', 'quit']
        +aliases = ['quit', 'chicken out', 'abort', 'q']
        @@ -249,7 +249,7 @@ set in self.parse())

        -search_index_entry = {'aliases': 'abort chicken out q quit', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' abort chicken out q 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 '}
        +search_index_entry = {'aliases': 'quit chicken out abort q', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' quit chicken out abort q', '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 '}
        @@ -385,7 +385,7 @@ shout

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

        -search_index_entry = {'aliases': 'whisper ; shout', 'category': 'general', 'key': 'say', 'no_prefix': ' whisper ; shout', '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 '}
        @@ -504,7 +504,7 @@ looks and what actions is available.

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

        -search_index_entry = {'aliases': 'ex e unfocus examine', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' ex e unfocus examine', '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': 'ex e examine unfocus', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' ex e examine unfocus', '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 = ['inventory', 'give', 'inv', 'i']
        +aliases = ['give', 'inventory', 'i', 'inv']
        @@ -619,7 +619,7 @@ set in self.parse())

        -search_index_entry = {'aliases': 'inventory give inv i', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inventory give inv i', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
        +search_index_entry = {'aliases': 'give inventory i inv', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' give inventory i inv', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
        diff --git a/docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html b/docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html index 158896c484..8c8be515bb 100644 --- a/docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html +++ b/docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html @@ -636,7 +636,7 @@ inv

        -aliases = ['inv', 'i']
        +aliases = ['i', 'inv']
        @@ -667,7 +667,7 @@ inv

        -search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
        +search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
        diff --git a/docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html b/docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html index f6516a49a8..fd3910210f 100644 --- a/docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html +++ b/docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html @@ -436,7 +436,7 @@ there is no room above/below you, your movement will fail.

        -aliases = ['dive', 'fly']
        +aliases = ['fly', 'dive']
        @@ -459,7 +459,7 @@ to all the variables defined therein.

        -search_index_entry = {'aliases': 'dive fly', 'category': 'general', 'key': 'fly or dive', 'no_prefix': ' dive fly', 'tags': '', 'text': '\n Fly or Dive up and down.\n\n Usage:\n fly\n dive\n\n Will fly up one room or dive down one room at your current position. If\n there is no room above/below you, your movement will fail.\n\n '}
        +search_index_entry = {'aliases': 'fly dive', 'category': 'general', 'key': 'fly or dive', 'no_prefix': ' fly dive', 'tags': '', 'text': '\n Fly or Dive up and down.\n\n Usage:\n fly\n dive\n\n Will fly up one room or dive down one room at your current position. If\n there is no room above/below you, your movement will fail.\n\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 610db7d702..ff25abe9cc 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 83b1ca5a7f..5108263cd5 100644 --- a/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_twitch.html +++ b/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_twitch.html @@ -491,7 +491,7 @@ boost INT Wizard Goblin

        -aliases = ['foil', 'boost']
        +aliases = ['boost', 'foil']
        @@ -525,7 +525,7 @@ set in self.parse())

        -search_index_entry = {'aliases': 'foil boost', 'category': 'combat', 'key': 'stunt', 'no_prefix': ' foil boost', 'tags': '', 'text': '\n Perform a combat stunt, that boosts an ally against a target, or\n foils an enemy, giving them disadvantage against an ally.\n\n Usage:\n boost [ability] <recipient> <target>\n foil [ability] <recipient> <target>\n boost [ability] <target> (same as boost me <target>)\n foil [ability] <target> (same as foil <target> me)\n\n Example:\n boost STR me Goblin\n boost DEX Goblin\n foil STR Goblin me\n foil INT Goblin\n boost INT Wizard Goblin\n\n '}
        +search_index_entry = {'aliases': 'boost foil', 'category': 'combat', 'key': 'stunt', 'no_prefix': ' boost foil', 'tags': '', 'text': '\n Perform a combat stunt, that boosts an ally against a target, or\n foils an enemy, giving them disadvantage against an ally.\n\n Usage:\n boost [ability] <recipient> <target>\n foil [ability] <recipient> <target>\n boost [ability] <target> (same as boost me <target>)\n foil [ability] <target> (same as foil <target> me)\n\n Example:\n boost STR me Goblin\n boost DEX Goblin\n foil STR Goblin me\n foil INT Goblin\n boost INT Wizard Goblin\n\n '}
        diff --git a/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html b/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html index 18e51861b5..98c34b6087 100644 --- a/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html +++ b/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html @@ -206,7 +206,7 @@ self.args).

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

        -search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n View your inventory\n\n Usage:\n inventory\n\n '}
        +search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n View your inventory\n\n Usage:\n inventory\n\n '}
        @@ -307,7 +307,7 @@ unwear <item>

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

        -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 '}
        +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 '}
        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 782c34ac1f..aafbe7d051 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 = ['press', 'push', 'press button']
        +aliases = ['press button', 'push', 'press']
        @@ -196,7 +196,7 @@ check if the lid is open or closed.

        -search_index_entry = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' press push press button', '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 = ['smash', 'break lid', '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': 'smash break lid smash lid', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' smash break lid 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 = ['press', 'push', 'press button']
        +aliases = ['press button', 'push', 'press']
        @@ -422,7 +422,7 @@ set in self.parse())

        -search_index_entry = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' press push press button', '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 = ['get', 'examine', 'listen', 'feel', 'ex', 'l']
        +aliases = ['examine', 'get', 'feel', 'ex', 'l', 'listen']
        @@ -546,7 +546,7 @@ be mutually exclusive.

        -search_index_entry = {'aliases': 'get examine listen feel ex l', 'category': 'general', 'key': 'look', 'no_prefix': ' get examine listen feel ex 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 "}
        +search_index_entry = {'aliases': 'examine get feel ex l listen', 'category': 'general', 'key': 'look', 'no_prefix': ' examine get feel ex l listen', '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 cfff2ce632..0ba9e67cea 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 '}
        @@ -623,7 +623,7 @@ yellow/green - horizontal roots

        -aliases = ['push button', 'button', 'press button']
        +aliases = ['press button', 'push button', 'button']
        @@ -649,7 +649,7 @@ yellow/green - horizontal roots

        -search_index_entry = {'aliases': 'push button button press button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' push button button press button', 'tags': '', 'text': '\n Presses a button.\n '}
        +search_index_entry = {'aliases': 'press button push button button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' press button push button button', 'tags': '', 'text': '\n Presses a button.\n '}
        @@ -793,7 +793,7 @@ parry - forgoes your attack but will make you harder to hit on next

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

        -search_index_entry = {'aliases': 'hit kill thrust bash chop defend pierce slash parry fight stab', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' hit kill thrust bash chop defend pierce slash parry fight stab', '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': 'stab parry fight hit kill slash chop pierce thrust defend bash', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' stab parry fight hit kill slash chop pierce thrust defend 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 '}
        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 5eed77e82d..3d92a22e70 100644 --- a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html +++ b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html @@ -982,7 +982,7 @@ to find something.

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

        -search_index_entry = {'aliases': 'search fiddle feel l feel around', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' search fiddle feel l feel around', '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': 'fiddle feel around search feel l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' fiddle feel around search feel 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 c032acc164..f59a576a95 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/tmpsgau2ds0/6431b5c6c48826e4ec0aa51b8c718677e6a43fd5/evennia'
        +directory = '/tmp/tmpsd70qei1/7cce317da0f28b615fa6a15ff176e7e3d3169695/evennia'
        @@ -283,7 +283,7 @@ git pull - Pull the latest code from your current branch.

        -directory = '/tmp/tmpsgau2ds0/6431b5c6c48826e4ec0aa51b8c718677e6a43fd5/evennia/game_template'
        +directory = '/tmp/tmpsd70qei1/7cce317da0f28b615fa6a15ff176e7e3d3169695/evennia/game_template'
        diff --git a/docs/latest/api/evennia.utils.eveditor.html b/docs/latest/api/evennia.utils.eveditor.html index aa76125a4e..02ea0da19a 100644 --- a/docs/latest/api/evennia.utils.eveditor.html +++ b/docs/latest/api/evennia.utils.eveditor.html @@ -350,7 +350,7 @@ indentation.

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

        -search_index_entry = {'aliases': ':dd :p ::: :uu :h :A :: : :u :r :wq :dw :S :q :I :UU := :j :f :q! :< :fi :echo :x :i :! :y :DD :s :w :> :fd', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :dd :p ::: :uu :h :A :: : :u :r :wq :dw :S :q :I :UU := :j :f :q! :< :fi :echo :x :i :! :y :DD :s :w :> :fd', 'tags': '', 'text': '\n Commands for the editor\n '}
        +search_index_entry = {'aliases': ':q! :dd :DD := :p :< :j :y :A :UU :dw :u :h :x :> :: :f :fi :fd :S :wq :s :echo :I : :i ::: :w :q :r :uu :!', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :q! :dd :DD := :p :< :j :y :A :UU :dw :u :h :x :> :: :f :fi :fd :S :wq :s :echo :I : :i ::: :w :q :r :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 0e04a9e387..9fdd26710f 100644 --- a/docs/latest/api/evennia.utils.evmenu.html +++ b/docs/latest/api/evennia.utils.evmenu.html @@ -953,7 +953,7 @@ single question.

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

        -search_index_entry = {'aliases': 'abort a no __nomatch_command y n yes', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' abort a no __nomatch_command y n yes', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}
        +search_index_entry = {'aliases': 'n no __nomatch_command a abort y yes', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' n no __nomatch_command a abort y yes', '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 04548d9695..86369d0ffe 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 = ['t', 'q', 'e', 'abort', 'a', 'end', 'top', 'previous', 'n', 'p', 'quit', 'next']
        +aliases = ['end', 'n', 'p', 'q', 'top', 'abort', 'a', 'e', 'quit', 'previous', 'next', 't']
        @@ -177,7 +177,7 @@ the caller.msg() construct every time the page is updated.

        -search_index_entry = {'aliases': 't q e abort a end top previous n p quit next', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' t q e abort a end top previous n p quit next', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
        +search_index_entry = {'aliases': 'end n p q top abort a e quit previous next t', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' end n p q top abort a e quit previous next t', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
        diff --git a/docs/latest/api/evennia.utils.utils.html b/docs/latest/api/evennia.utils.utils.html index 0870a8accd..63870d4b29 100644 --- a/docs/latest/api/evennia.utils.utils.html +++ b/docs/latest/api/evennia.utils.utils.html @@ -1898,6 +1898,20 @@ then settings.UPSTREAM_IPS will be used.

        +
        +
        +evennia.utils.utils.value_is_integer(value)[source]
        +

        Determines if a value can be type-cast to an integer.

        +
        +
        Parameters
        +

        value (any) – The value to check.

        +
        +
        Returns
        +

        result (bool) – Whether it can be type-cast to an integer or not.

        +
        +
        +
        + diff --git a/docs/latest/genindex.html b/docs/latest/genindex.html index d74322538c..51ce742af7 100644 --- a/docs/latest/genindex.html +++ b/docs/latest/genindex.html @@ -24507,6 +24507,8 @@
    • value_from_datadict() (evennia.utils.picklefield.PickledWidget method) +
      • +
    • value_is_integer() (in module evennia.utils.utils)