From 035831f96384ba65f7485d286385abc4a2709ad7 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Sun, 20 Aug 2023 15:30:24 +0000 Subject: [PATCH] Updated HTML docs. --- docs/2.x/.buildinfo | 2 +- docs/2.x/Coding/Changelog.html | 1 + docs/2.x/Components/EvMenu.html | 46 ++++++++------- docs/2.x/_modules/evennia/utils/evmenu.html | 25 ++++++++- docs/2.x/_sources/Coding/Changelog.md.txt | 1 + docs/2.x/_sources/Components/EvMenu.md.txt | 53 +++++++++++------- .../evennia.commands.default.building.html | 12 ++-- .../api/evennia.commands.default.comms.html | 8 +-- .../api/evennia.commands.default.general.html | 8 +-- .../api/evennia.commands.default.system.html | 4 +- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 4 +- ....base_systems.email_login.email_login.html | 4 +- ...b.base_systems.ingame_python.commands.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 8 +-- ...rib.full_systems.evscaperoom.commands.html | 16 +++--- ...ia.contrib.game_systems.barter.barter.html | 4 +- ...ontrib.game_systems.clothing.clothing.html | 4 +- ...evennia.contrib.grid.xyzgrid.commands.html | 4 +- .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...evennia.contrib.rpg.rpsystem.rpsystem.html | 4 +- ...utorials.evadventure.combat_turnbased.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 | 8 +-- ...utils.git_integration.git_integration.html | 4 +- docs/2.x/api/evennia.utils.eveditor.html | 4 +- docs/2.x/api/evennia.utils.evmenu.html | 16 ++++-- docs/2.x/api/evennia.utils.evmore.html | 4 +- docs/2.x/genindex.html | 6 +- docs/2.x/objects.inv | Bin 164479 -> 164485 bytes docs/2.x/searchindex.js | 2 +- 33 files changed, 172 insertions(+), 126 deletions(-) diff --git a/docs/2.x/.buildinfo b/docs/2.x/.buildinfo index 761a8a256c..8fdbbc1683 100644 --- a/docs/2.x/.buildinfo +++ b/docs/2.x/.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: 78f8ad4b5b61f0fcded4e5706ec87a42 +config: 0b2dc7ab2a21b06033c21551a63d13ba tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/2.x/Coding/Changelog.html b/docs/2.x/Coding/Changelog.html index 702d3465fb..78d163090b 100644 --- a/docs/2.x/Coding/Changelog.html +++ b/docs/2.x/Coding/Changelog.html @@ -185,6 +185,7 @@

Main branch

diff --git a/docs/2.x/Components/EvMenu.html b/docs/2.x/Components/EvMenu.html index c0cfd16177..d8d5f98735 100644 --- a/docs/2.x/Components/EvMenu.html +++ b/docs/2.x/Components/EvMenu.html @@ -170,8 +170,7 @@ Thanks for accepts specific options as input or free-form input. Depending what the player chooses, they are forwarded to different nodes in the menu.

The EvMenu utility class is located in evennia/utils/evmenu.py. -It allows for easily adding interactive menus to the game; for example to implement Character -creation, building commands or similar. Below is an example of offering NPC conversation choices:

+It allows for easily adding interactive menus to the game; for example to implement Character creation, building commands or similar. Below is an example of offering NPC conversation choices:

This is how the example menu at the top of this page will look in code:

from evennia.utils import evmenu
 
@@ -310,8 +309,7 @@ choose to point you to nodes that continue the conversation or maybe dump you
 into combat!

Launching the menu

-

Initializing the menu is done using a call to the evennia.utils.evmenu.EvMenu class. This is the -most common way to do so - from inside a Command:

+

Initializing the menu is done using a call to the evennia.utils.evmenu.EvMenu class. This is the most common way to do so - from inside a Command:

# in, for example gamedir/commands/command.py
 
 from evennia.utils.evmenu import EvMenu
@@ -349,7 +347,7 @@ most common way to do so - from inside a startnode (str): is the name of the menu-node to start the menu at. Changing this means that you can jump into a menu tree at different positions depending on circumstance and thus possibly re-use menu entries.

  • cmdset_mergetype (str): This is usually one of “Replace” or “Union” (see [CmdSets](Command- Sets). The first means that the menu is exclusive - the user has no access to any other commands while in the menu. The Union mergetype means the menu co-exists with previous commands (and may overload them, so be careful as to what to name your menu entries in this case).

  • cmdset_priority (int): The priority with which to merge in the menu cmdset. This allows for advanced usage.

  • -
  • auto_quit, auto_look, auto_help (bool): If either of these are True, the menu automatically makes a quit, look or help command available to the user. The main reason why you’d want to turn this off is if you want to use the aliases “q”, “l” or “h” for something in your menu. Nevertheless, at least quit is highly recommend - if False, the menu must itself supply an “exit node” (a node without any options), or the user will be stuck in the menu until the server reloads (or eternally if the menu is persistent)!

  • +
  • auto_quit, auto_look, auto_help (bool): If either of these are True, the menu automatically makes a quit, look or help command available to the user. The main reason why you’d want to turn this off is if you want to use the aliases “q”, “l” or “h” for something in your menu. The auto_help also activates the ability to have arbitrary “tool tips” in your menu node (see below), At least quit is highly recommend - if False, the menu must itself supply an “exit node” (a node without any options), or the user will be stuck in the menu until the server reloads (or eternally if the menu is persistent)!

  • cmd_on_exit (str): This command string will be executed right after the menu has closed down. From experience, it’s useful to trigger a “look” command to make sure the user is aware of the change of state; but any command can be used. If set to None, no command will be triggered after exiting the menu.

  • persistent (bool) - if True, the menu will survive a reload (so the user will not be kicked out by the reload - make sure they can exit on their own!)

  • @@ -387,24 +385,16 @@ menu. Temporary variables you store on a persistent

    Input arguments to the node

      -
    • caller (Object or Account): The object using the menu - usually a Character but could also be a -Session or Account depending on where the menu is used.

    • +
    • caller (Object or Account): The object using the menu - usually a Character but could also be a Session or Account depending on where the menu is used.

    • raw_string (str): If this is given, it will be set to the exact text the user entered on the -previous node (that is, the command entered to get to this node). On the starting-node of the -menu, this will be an empty string, unless startnode_input was set.

    • -
    • kwargs (dict): These extra keyword arguments are extra optional arguments passed to the node -when the user makes a choice on the previous node. This may include things like status flags -and details about which exact option was chosen (which can be impossible to determine from -raw_string alone). Just what is passed in kwargs is up to you when you create the previous -node.

    • +previous node (that is, the command entered to get to this node). On the starting-node of the menu, this will be an empty string, unless startnode_input was set.

      +
    • kwargs (dict): These extra keyword arguments are extra optional arguments passed to the node when the user makes a choice on the previous node. This may include things like status flags and details about which exact option was chosen (which can be impossible to determine from +raw_string alone). Just what is passed in kwargs is up to you when you create the previous node.

    @@ -412,11 +402,25 @@ node.

    Each node function must return two variables, text and options.

    text

    -

    The text variable is a string or tuple. This text is what will be displayed when the user reaches this node. If this is a tuple, then the first element of the tuple will be considered the displayed text and the second the help-text to display when the user enters the help command on this node.

    -
        text = ("This is the text to display", "This is the help text for this node")
    +

    The text variable is either a string or a tuple. This is the simplest form:

    +
    text = "Node text"
    +
    +
    +

    This is what will be displayed as text in the menu node when entering it. You can modify this dynamically in the node if you want. Returning a None node text text is allowed - this leads to a node with no text and only options.

    +
    text = ("Node text", "help text to show with h|elp")
    +
    +
    +

    In this form, we also add an optional help text. If auto_help=True when initializing the EvMenu, the user will be able to use h or help to see this text when viewing this node. If the user were to provide a custom option overriding h or help, that will be shown instead.

    +

    If auto_help=True and no help text is provided, using h|elp will give a generic error message.

    +
    text = ("Node text", {"help topic 1": "Help 1", 
    +                      ("help topic 2", "alias1", ...): "Help 2", ...})
    +
    +
    +

    This is ‘tooltip’ or ‘multi-help category’ mode. This also requires auto_help=True when initializing the EvMenu. By providing a dict as the second element of the text tuple, the user will be able to help about any of these topics. Use a tuple as key to add multiple aliases to the same help entry. This allows the user to get more detailed help text without leaving the given node.

    +

    Note that in ‘tooltip’ mode, the normal h|elp command won’t work. The h|elp entry must be added manually in the dict. As an example, this would reproduce the normal help functionality:

    +
    text = ("Node text", {("help", "h"): "Help entry...", ...})
     
    -

    Returning a None text is allowed and simply leads to a node with no text and only options. If the help text is not given, the menu will give a generic error message when using help.

    options

    diff --git a/docs/2.x/_modules/evennia/utils/evmenu.html b/docs/2.x/_modules/evennia/utils/evmenu.html index 55b8ee5389..f69068ec1d 100644 --- a/docs/2.x/_modules/evennia/utils/evmenu.html +++ b/docs/2.x/_modules/evennia/utils/evmenu.html @@ -152,8 +152,11 @@ menu is immediately exited and the default "look" command is called. - `text` (str, tuple or None): Text shown at this node. If a tuple, the - second element in the tuple is a help text to display at this - node when the user enters the menu help command there. + second element in the tuple holds either a string or a dict. If a string, + this is the help text to show when `auto_help` is active for the menu and + the user presses `h`. If a dict, this is a mapping of `'help topic': 'help text'` to + show in that menu. This can be used to show information without having to + switch to another node. - `options` (tuple, dict or None): If `None`, this exits the menu. If a single dict, this is a single-option node. If a tuple, it should be a tuple of option dictionaries. Option dicts have the following keys: @@ -998,10 +1001,21 @@ # validation of the node return values # if the nodetext is a list/tuple, the second set is the help text. - helptext = "" + # helptext can also be a dict, which allows for tooltip command-text (key-value) or + # ((key,aliases)-value) pairs. + if is_iter(nodetext): nodetext, *helptext = nodetext helptext = helptext[0] if helptext else "" + + if isinstance(helptext, dict): + # handle both (key-value) and (key, aliases)-value pairs + _help_text = {} + for topic_keys, help_entry in helptext.items(): + for topic_key in make_iter(topic_keys): + _help_text[topic_key.strip().lower()] = help_entry + helptext = _help_text + nodetext = "" if nodetext is None else str(nodetext) # handle the helptext @@ -1170,6 +1184,8 @@ self.goto(goto_node, raw_string, **(goto_kwargs or {})) elif self.auto_look and cmd in ("look", "l"): self.display_nodetext() + elif self.auto_help and isinstance(self.helptext, dict) and cmd in self.helptext: + self.display_tooltip(cmd) elif self.auto_help and cmd in ("help", "h"): self.display_helptext() elif self.auto_quit and cmd in ("quit", "q", "exit"): @@ -1192,6 +1208,9 @@
    [docs] def display_helptext(self): self.msg(self.helptext)
    +
    [docs] def display_tooltip(self, cmd): + self.msg(self.helptext.get(cmd))
    + # formatters - override in a child class
    [docs] def nodetext_formatter(self, nodetext): diff --git a/docs/2.x/_sources/Coding/Changelog.md.txt b/docs/2.x/_sources/Coding/Changelog.md.txt index af644b2dd9..c02b0302cf 100644 --- a/docs/2.x/_sources/Coding/Changelog.md.txt +++ b/docs/2.x/_sources/Coding/Changelog.md.txt @@ -2,6 +2,7 @@ ## Main branch +- Feat: EvMenu tooltips for multiple help categories in a node (Seannio) - Fix: Typo in evadventure twitch combat's call of `create_combathandler`. ## Evennia 2.2.0 diff --git a/docs/2.x/_sources/Components/EvMenu.md.txt b/docs/2.x/_sources/Components/EvMenu.md.txt index 74c4528bcf..8a1342c7ae 100644 --- a/docs/2.x/_sources/Components/EvMenu.md.txt +++ b/docs/2.x/_sources/Components/EvMenu.md.txt @@ -18,8 +18,7 @@ accepts specific options as input or free-form input. Depending what the player chooses, they are forwarded to different nodes in the menu. The `EvMenu` utility class is located in [evennia/utils/evmenu.py](evennia.utils.evmenu). -It allows for easily adding interactive menus to the game; for example to implement Character -creation, building commands or similar. Below is an example of offering NPC conversation choices: +It allows for easily adding interactive menus to the game; for example to implement Character creation, building commands or similar. Below is an example of offering NPC conversation choices: This is how the example menu at the top of this page will look in code: @@ -175,8 +174,7 @@ into combat! ## Launching the menu -Initializing the menu is done using a call to the `evennia.utils.evmenu.EvMenu` class. This is the -most common way to do so - from inside a [Command](./Commands.md): +Initializing the menu is done using a call to the `evennia.utils.evmenu.EvMenu` class. This is the most common way to do so - from inside a [Command](./Commands.md): ```python # in, for example gamedir/commands/command.py @@ -218,7 +216,7 @@ EvMenu(caller, menu_data, - `startnode` (str): is the name of the menu-node to start the menu at. Changing this means that you can jump into a menu tree at different positions depending on circumstance and thus possibly re-use menu entries. - `cmdset_mergetype` (str): This is usually one of "Replace" or "Union" (see [CmdSets](Command- Sets). The first means that the menu is exclusive - the user has no access to any other commands while in the menu. The Union mergetype means the menu co-exists with previous commands (and may overload them, so be careful as to what to name your menu entries in this case). - `cmdset_priority` (int): The priority with which to merge in the menu cmdset. This allows for advanced usage. - - `auto_quit`, `auto_look`, `auto_help` (bool): If either of these are `True`, the menu automatically makes a `quit`, `look` or `help` command available to the user. The main reason why you'd want to turn this off is if you want to use the aliases "q", "l" or "h" for something in your menu. Nevertheless, at least `quit` is highly recommend - if `False`, the menu *must* itself supply an "exit node" (a node without any options), or the user will be stuck in the menu until the server reloads (or eternally if the menu is `persistent`)! + - `auto_quit`, `auto_look`, `auto_help` (bool): If either of these are `True`, the menu automatically makes a `quit`, `look` or `help` command available to the user. The main reason why you'd want to turn this off is if you want to use the aliases "q", "l" or "h" for something in your menu. The `auto_help` also activates the ability to have arbitrary "tool tips" in your menu node (see below), At least `quit` is highly recommend - if `False`, the menu *must* itself supply an "exit node" (a node without any options), or the user will be stuck in the menu until the server reloads (or eternally if the menu is `persistent`)! - `cmd_on_exit` (str): This command string will be executed right *after* the menu has closed down. From experience, it's useful to trigger a "look" command to make sure the user is aware of the change of state; but any command can be used. If set to `None`, no command will be triggered after exiting the menu. - `persistent` (bool) - if `True`, the menu will survive a reload (so the user will not be kicked out by the reload - make sure they can exit on their own!) @@ -257,24 +255,16 @@ def menunodename3(caller, raw_string, **kwargs): ``` -> While all of the above forms are okay, it's recommended to stick to the third and last form since -it -> gives the most flexibility. The previous forms are mainly there for backwards compatibility with -> existing menus from a time when EvMenu was less able. +> While all of the above forms are okay, it's recommended to stick to the third and last form since it gives the most flexibility. The previous forms are mainly there for backwards compatibility with existing menus from a time when EvMenu was less able and may become deprecated at some time in the future. ### Input arguments to the node - - `caller` (Object or Account): The object using the menu - usually a Character but could also be a - Session or Account depending on where the menu is used. + - `caller` (Object or Account): The object using the menu - usually a Character but could also be a Session or Account depending on where the menu is used. - `raw_string` (str): If this is given, it will be set to the exact text the user entered on the - *previous* node (that is, the command entered to get to this node). On the starting-node of the - menu, this will be an empty string, unless `startnode_input` was set. - - `kwargs` (dict): These extra keyword arguments are extra optional arguments passed to the node - when the user makes a choice on the *previous* node. This may include things like status flags - and details about which exact option was chosen (which can be impossible to determine from - `raw_string` alone). Just what is passed in `kwargs` is up to you when you create the previous - node. + *previous* node (that is, the command entered to get to this node). On the starting-node of the menu, this will be an empty string, unless `startnode_input` was set. + - `kwargs` (dict): These extra keyword arguments are extra optional arguments passed to the node when the user makes a choice on the *previous* node. This may include things like status flags and details about which exact option was chosen (which can be impossible to determine from + `raw_string` alone). Just what is passed in `kwargs` is up to you when you create the previous node. ### Return values from the node @@ -283,13 +273,34 @@ Each node function must return two variables, `text` and `options`. #### text -The `text` variable is a string or tuple. This text is what will be displayed when the user reaches this node. If this is a tuple, then the first element of the tuple will be considered the displayed text and the second the help-text to display when the user enters the `help` command on this node. +The `text` variable is either a string or a tuple. This is the simplest form: + ```python - text = ("This is the text to display", "This is the help text for this node") +text = "Node text" ``` -Returning a `None` text is allowed and simply leads to a node with no text and only options. If the help text is not given, the menu will give a generic error message when using `help`. +This is what will be displayed as text in the menu node when entering it. You can modify this dynamically in the node if you want. Returning a `None` node text text is allowed - this leads to a node with no text and only options. +```python +text = ("Node text", "help text to show with h|elp") +``` + +In this form, we also add an optional help text. If `auto_help=True` when initializing the EvMenu, the user will be able to use `h` or `help` to see this text when viewing this node. If the user were to provide a custom option overriding `h` or `help`, that will be shown instead. + +If `auto_help=True` and no help text is provided, using `h|elp` will give a generic error message. + +```python +text = ("Node text", {"help topic 1": "Help 1", + ("help topic 2", "alias1", ...): "Help 2", ...}) +``` + +This is 'tooltip' or 'multi-help category' mode. This also requires `auto_help=True` when initializing the EvMenu. By providing a `dict` as the second element of the `text` tuple, the user will be able to help about any of these topics. Use a tuple as key to add multiple aliases to the same help entry. This allows the user to get more detailed help text without leaving the given node. + +Note that in 'tooltip' mode, the normal `h|elp` command won't work. The `h|elp` entry must be added manually in the dict. As an example, this would reproduce the normal help functionality: + +```python +text = ("Node text", {("help", "h"): "Help entry...", ...}) +``` #### options diff --git a/docs/2.x/api/evennia.commands.default.building.html b/docs/2.x/api/evennia.commands.default.building.html index e5e3eca10e..2db54a8863 100644 --- a/docs/2.x/api/evennia.commands.default.building.html +++ b/docs/2.x/api/evennia.commands.default.building.html @@ -600,7 +600,7 @@ You can specify the /force switch to bypass this confirmation.

    -aliases = ['@del', '@delete']
    +aliases = ['@delete', '@del']
    @@ -641,7 +641,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 '}
    @@ -1353,7 +1353,7 @@ server settings.

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

    -search_index_entry = {'aliases': '@swap @update @parent @type @typeclasses', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass swap update parent type typeclasses', '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': '@update @type @swap @parent @typeclasses', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass update type swap parent typeclasses', '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 "}
    @@ -1841,7 +1841,7 @@ one is given.

    -aliases = ['@locate', '@search']
    +aliases = ['@search', '@locate']
    @@ -1872,7 +1872,7 @@ one is given.

    -search_index_entry = {'aliases': '@locate @search', 'category': 'building', 'key': '@find', 'no_prefix': 'find locate search', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}
    +search_index_entry = {'aliases': '@search @locate', 'category': 'building', 'key': '@find', 'no_prefix': 'find search locate', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}
    diff --git a/docs/2.x/api/evennia.commands.default.comms.html b/docs/2.x/api/evennia.commands.default.comms.html index bc71ab84a5..5de183adbf 100644 --- a/docs/2.x/api/evennia.commands.default.comms.html +++ b/docs/2.x/api/evennia.commands.default.comms.html @@ -264,7 +264,7 @@ ban mychannel1,mychannel2= EvilUser : Was banned for spamming.

    -aliases = ['@channels', '@chan']
    +aliases = ['@chan', '@channels']
    @@ -789,7 +789,7 @@ don’t actually sub to yet.

    -search_index_entry = {'aliases': '@channels @chan', 'category': 'comms', 'key': '@channel', 'no_prefix': 'channel channels chan', 'tags': '', 'text': "\n Use and manage in-game channels.\n\n Usage:\n channel channelname <msg>\n channel channel name = <msg>\n channel (show all subscription)\n channel/all (show available channels)\n channel/alias channelname = alias[;alias...]\n channel/unalias alias\n channel/who channelname\n channel/history channelname [= index]\n channel/sub channelname [= alias[;alias...]]\n channel/unsub channelname[,channelname, ...]\n channel/mute channelname[,channelname,...]\n channel/unmute channelname[,channelname,...]\n\n channel/create channelname[;alias;alias[:typeclass]] [= description]\n channel/destroy channelname [= reason]\n channel/desc channelname = description\n channel/lock channelname = lockstring\n channel/unlock channelname = lockstring\n channel/ban channelname (list bans)\n channel/ban[/quiet] channelname[, channelname, ...] = subscribername [: reason]\n channel/unban[/quiet] channelname[, channelname, ...] = subscribername\n channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]\n\n # subtopics\n\n ## sending\n\n Usage: channel channelname msg\n channel channel name = msg (with space in channel name)\n\n This sends a message to the channel. Note that you will rarely use this\n command like this; instead you can use the alias\n\n channelname <msg>\n channelalias <msg>\n\n For example\n\n public Hello World\n pub Hello World\n\n (this shortcut doesn't work for aliases containing spaces)\n\n See channel/alias for help on setting channel aliases.\n\n ## alias and unalias\n\n Usage: channel/alias channel = alias[;alias[;alias...]]\n channel/unalias alias\n channel - this will list your subs and aliases to each channel\n\n Set one or more personal aliases for referencing a channel. For example:\n\n channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild\n\n You can now send to the channel using all of these:\n\n warrior's guild Hello\n warrior Hello\n wguild Hello\n warchannel Hello\n\n Note that this will not work if the alias has a space in it. So the\n 'warrior guild' alias must be used with the `channel` command:\n\n channel warrior guild = Hello\n\n Channel-aliases can be removed one at a time, using the '/unalias' switch.\n\n ## who\n\n Usage: channel/who channelname\n\n List the channel's subscribers. Shows who are currently offline or are\n muting the channel. Subscribers who are 'muting' will not see messages sent\n to the channel (use channel/mute to mute a channel).\n\n ## history\n\n Usage: channel/history channel [= index]\n\n This will display the last |c20|n lines of channel history. By supplying an\n index number, you will step that many lines back before viewing those 20 lines.\n\n For example:\n\n channel/history public = 35\n\n will go back 35 lines and show the previous 20 lines from that point (so\n lines -35 to -55).\n\n ## sub and unsub\n\n Usage: channel/sub channel [=alias[;alias;...]]\n channel/unsub channel\n\n This subscribes you to a channel and optionally assigns personal shortcuts\n for you to use to send to that channel (see aliases). When you unsub, all\n your personal aliases will also be removed.\n\n ## mute and unmute\n\n Usage: channel/mute channelname\n channel/unmute channelname\n\n Muting silences all output from the channel without actually\n un-subscribing. Other channel members will see that you are muted in the /who\n list. Sending a message to the channel will automatically unmute you.\n\n ## create and destroy\n\n Usage: channel/create channelname[;alias;alias[:typeclass]] [= description]\n channel/destroy channelname [= reason]\n\n Creates a new channel (or destroys one you control). You will automatically\n join the channel you create and everyone will be kicked and loose all aliases\n to a destroyed channel.\n\n ## lock and unlock\n\n Usage: channel/lock channelname = lockstring\n channel/unlock channelname = lockstring\n\n Note: this is an admin command.\n\n A lockstring is on the form locktype:lockfunc(). Channels understand three\n locktypes:\n listen - who may listen or join the channel.\n send - who may send messages to the channel\n control - who controls the channel. This is usually the one creating\n the channel.\n\n Common lockfuncs are all() and perm(). To make a channel everyone can\n listen to but only builders can talk on, use this:\n\n listen:all()\n send: perm(Builders)\n\n ## boot and ban\n\n Usage:\n channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]\n channel/ban channelname[, channelname, ...] = subscribername [: reason]\n channel/unban channelname[, channelname, ...] = subscribername\n channel/unban channelname\n channel/ban channelname (list bans)\n\n Booting will kick a named subscriber from channel(s) temporarily. The\n 'reason' will be passed to the booted user. Unless the /quiet switch is\n used, the channel will also be informed of the action. A booted user is\n still able to re-connect, but they'll have to set up their aliases again.\n\n Banning will blacklist a user from (re)joining the provided channels. It\n will then proceed to boot them from those channels if they were connected.\n The 'reason' and `/quiet` works the same as for booting.\n\n Example:\n boot mychannel1 = EvilUser : Kicking you to cool down a bit.\n ban mychannel1,mychannel2= EvilUser : Was banned for spamming.\n\n "}
    +search_index_entry = {'aliases': '@chan @channels', 'category': 'comms', 'key': '@channel', 'no_prefix': 'channel chan channels', 'tags': '', 'text': "\n Use and manage in-game channels.\n\n Usage:\n channel channelname <msg>\n channel channel name = <msg>\n channel (show all subscription)\n channel/all (show available channels)\n channel/alias channelname = alias[;alias...]\n channel/unalias alias\n channel/who channelname\n channel/history channelname [= index]\n channel/sub channelname [= alias[;alias...]]\n channel/unsub channelname[,channelname, ...]\n channel/mute channelname[,channelname,...]\n channel/unmute channelname[,channelname,...]\n\n channel/create channelname[;alias;alias[:typeclass]] [= description]\n channel/destroy channelname [= reason]\n channel/desc channelname = description\n channel/lock channelname = lockstring\n channel/unlock channelname = lockstring\n channel/ban channelname (list bans)\n channel/ban[/quiet] channelname[, channelname, ...] = subscribername [: reason]\n channel/unban[/quiet] channelname[, channelname, ...] = subscribername\n channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]\n\n # subtopics\n\n ## sending\n\n Usage: channel channelname msg\n channel channel name = msg (with space in channel name)\n\n This sends a message to the channel. Note that you will rarely use this\n command like this; instead you can use the alias\n\n channelname <msg>\n channelalias <msg>\n\n For example\n\n public Hello World\n pub Hello World\n\n (this shortcut doesn't work for aliases containing spaces)\n\n See channel/alias for help on setting channel aliases.\n\n ## alias and unalias\n\n Usage: channel/alias channel = alias[;alias[;alias...]]\n channel/unalias alias\n channel - this will list your subs and aliases to each channel\n\n Set one or more personal aliases for referencing a channel. For example:\n\n channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild\n\n You can now send to the channel using all of these:\n\n warrior's guild Hello\n warrior Hello\n wguild Hello\n warchannel Hello\n\n Note that this will not work if the alias has a space in it. So the\n 'warrior guild' alias must be used with the `channel` command:\n\n channel warrior guild = Hello\n\n Channel-aliases can be removed one at a time, using the '/unalias' switch.\n\n ## who\n\n Usage: channel/who channelname\n\n List the channel's subscribers. Shows who are currently offline or are\n muting the channel. Subscribers who are 'muting' will not see messages sent\n to the channel (use channel/mute to mute a channel).\n\n ## history\n\n Usage: channel/history channel [= index]\n\n This will display the last |c20|n lines of channel history. By supplying an\n index number, you will step that many lines back before viewing those 20 lines.\n\n For example:\n\n channel/history public = 35\n\n will go back 35 lines and show the previous 20 lines from that point (so\n lines -35 to -55).\n\n ## sub and unsub\n\n Usage: channel/sub channel [=alias[;alias;...]]\n channel/unsub channel\n\n This subscribes you to a channel and optionally assigns personal shortcuts\n for you to use to send to that channel (see aliases). When you unsub, all\n your personal aliases will also be removed.\n\n ## mute and unmute\n\n Usage: channel/mute channelname\n channel/unmute channelname\n\n Muting silences all output from the channel without actually\n un-subscribing. Other channel members will see that you are muted in the /who\n list. Sending a message to the channel will automatically unmute you.\n\n ## create and destroy\n\n Usage: channel/create channelname[;alias;alias[:typeclass]] [= description]\n channel/destroy channelname [= reason]\n\n Creates a new channel (or destroys one you control). You will automatically\n join the channel you create and everyone will be kicked and loose all aliases\n to a destroyed channel.\n\n ## lock and unlock\n\n Usage: channel/lock channelname = lockstring\n channel/unlock channelname = lockstring\n\n Note: this is an admin command.\n\n A lockstring is on the form locktype:lockfunc(). Channels understand three\n locktypes:\n listen - who may listen or join the channel.\n send - who may send messages to the channel\n control - who controls the channel. This is usually the one creating\n the channel.\n\n Common lockfuncs are all() and perm(). To make a channel everyone can\n listen to but only builders can talk on, use this:\n\n listen:all()\n send: perm(Builders)\n\n ## boot and ban\n\n Usage:\n channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]\n channel/ban channelname[, channelname, ...] = subscribername [: reason]\n channel/unban channelname[, channelname, ...] = subscribername\n channel/unban channelname\n channel/ban channelname (list bans)\n\n Booting will kick a named subscriber from channel(s) temporarily. The\n 'reason' will be passed to the booted user. Unless the /quiet switch is\n used, the channel will also be informed of the action. A booted user is\n still able to re-connect, but they'll have to set up their aliases again.\n\n Banning will blacklist a user from (re)joining the provided channels. It\n will then proceed to boot them from those channels if they were connected.\n The 'reason' and `/quiet` works the same as for booting.\n\n Example:\n boot mychannel1 = EvilUser : Kicking you to cool down a bit.\n ban mychannel1,mychannel2= EvilUser : Was banned for spamming.\n\n "}
    @@ -942,7 +942,7 @@ ban mychannel1,mychannel2= EvilUser : Was banned for spamming.

    -aliases = ['@channels', '@chan']
    +aliases = ['@chan', '@channels']
    @@ -962,7 +962,7 @@ ban mychannel1,mychannel2= EvilUser : Was banned for spamming.

    -search_index_entry = {'aliases': '@channels @chan', 'category': 'comms', 'key': '@channel', 'no_prefix': 'channel channels chan', 'tags': '', 'text': "\n Use and manage in-game channels.\n\n Usage:\n channel channelname <msg>\n channel channel name = <msg>\n channel (show all subscription)\n channel/all (show available channels)\n channel/alias channelname = alias[;alias...]\n channel/unalias alias\n channel/who channelname\n channel/history channelname [= index]\n channel/sub channelname [= alias[;alias...]]\n channel/unsub channelname[,channelname, ...]\n channel/mute channelname[,channelname,...]\n channel/unmute channelname[,channelname,...]\n\n channel/create channelname[;alias;alias[:typeclass]] [= description]\n channel/destroy channelname [= reason]\n channel/desc channelname = description\n channel/lock channelname = lockstring\n channel/unlock channelname = lockstring\n channel/ban channelname (list bans)\n channel/ban[/quiet] channelname[, channelname, ...] = subscribername [: reason]\n channel/unban[/quiet] channelname[, channelname, ...] = subscribername\n channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]\n\n # subtopics\n\n ## sending\n\n Usage: channel channelname msg\n channel channel name = msg (with space in channel name)\n\n This sends a message to the channel. Note that you will rarely use this\n command like this; instead you can use the alias\n\n channelname <msg>\n channelalias <msg>\n\n For example\n\n public Hello World\n pub Hello World\n\n (this shortcut doesn't work for aliases containing spaces)\n\n See channel/alias for help on setting channel aliases.\n\n ## alias and unalias\n\n Usage: channel/alias channel = alias[;alias[;alias...]]\n channel/unalias alias\n channel - this will list your subs and aliases to each channel\n\n Set one or more personal aliases for referencing a channel. For example:\n\n channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild\n\n You can now send to the channel using all of these:\n\n warrior's guild Hello\n warrior Hello\n wguild Hello\n warchannel Hello\n\n Note that this will not work if the alias has a space in it. So the\n 'warrior guild' alias must be used with the `channel` command:\n\n channel warrior guild = Hello\n\n Channel-aliases can be removed one at a time, using the '/unalias' switch.\n\n ## who\n\n Usage: channel/who channelname\n\n List the channel's subscribers. Shows who are currently offline or are\n muting the channel. Subscribers who are 'muting' will not see messages sent\n to the channel (use channel/mute to mute a channel).\n\n ## history\n\n Usage: channel/history channel [= index]\n\n This will display the last |c20|n lines of channel history. By supplying an\n index number, you will step that many lines back before viewing those 20 lines.\n\n For example:\n\n channel/history public = 35\n\n will go back 35 lines and show the previous 20 lines from that point (so\n lines -35 to -55).\n\n ## sub and unsub\n\n Usage: channel/sub channel [=alias[;alias;...]]\n channel/unsub channel\n\n This subscribes you to a channel and optionally assigns personal shortcuts\n for you to use to send to that channel (see aliases). When you unsub, all\n your personal aliases will also be removed.\n\n ## mute and unmute\n\n Usage: channel/mute channelname\n channel/unmute channelname\n\n Muting silences all output from the channel without actually\n un-subscribing. Other channel members will see that you are muted in the /who\n list. Sending a message to the channel will automatically unmute you.\n\n ## create and destroy\n\n Usage: channel/create channelname[;alias;alias[:typeclass]] [= description]\n channel/destroy channelname [= reason]\n\n Creates a new channel (or destroys one you control). You will automatically\n join the channel you create and everyone will be kicked and loose all aliases\n to a destroyed channel.\n\n ## lock and unlock\n\n Usage: channel/lock channelname = lockstring\n channel/unlock channelname = lockstring\n\n Note: this is an admin command.\n\n A lockstring is on the form locktype:lockfunc(). Channels understand three\n locktypes:\n listen - who may listen or join the channel.\n send - who may send messages to the channel\n control - who controls the channel. This is usually the one creating\n the channel.\n\n Common lockfuncs are all() and perm(). To make a channel everyone can\n listen to but only builders can talk on, use this:\n\n listen:all()\n send: perm(Builders)\n\n ## boot and ban\n\n Usage:\n channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]\n channel/ban channelname[, channelname, ...] = subscribername [: reason]\n channel/unban channelname[, channelname, ...] = subscribername\n channel/unban channelname\n channel/ban channelname (list bans)\n\n Booting will kick a named subscriber from channel(s) temporarily. The\n 'reason' will be passed to the booted user. Unless the /quiet switch is\n used, the channel will also be informed of the action. A booted user is\n still able to re-connect, but they'll have to set up their aliases again.\n\n Banning will blacklist a user from (re)joining the provided channels. It\n will then proceed to boot them from those channels if they were connected.\n The 'reason' and `/quiet` works the same as for booting.\n\n Example:\n boot mychannel1 = EvilUser : Kicking you to cool down a bit.\n ban mychannel1,mychannel2= EvilUser : Was banned for spamming.\n\n "}
    +search_index_entry = {'aliases': '@chan @channels', 'category': 'comms', 'key': '@channel', 'no_prefix': 'channel chan channels', 'tags': '', 'text': "\n Use and manage in-game channels.\n\n Usage:\n channel channelname <msg>\n channel channel name = <msg>\n channel (show all subscription)\n channel/all (show available channels)\n channel/alias channelname = alias[;alias...]\n channel/unalias alias\n channel/who channelname\n channel/history channelname [= index]\n channel/sub channelname [= alias[;alias...]]\n channel/unsub channelname[,channelname, ...]\n channel/mute channelname[,channelname,...]\n channel/unmute channelname[,channelname,...]\n\n channel/create channelname[;alias;alias[:typeclass]] [= description]\n channel/destroy channelname [= reason]\n channel/desc channelname = description\n channel/lock channelname = lockstring\n channel/unlock channelname = lockstring\n channel/ban channelname (list bans)\n channel/ban[/quiet] channelname[, channelname, ...] = subscribername [: reason]\n channel/unban[/quiet] channelname[, channelname, ...] = subscribername\n channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]\n\n # subtopics\n\n ## sending\n\n Usage: channel channelname msg\n channel channel name = msg (with space in channel name)\n\n This sends a message to the channel. Note that you will rarely use this\n command like this; instead you can use the alias\n\n channelname <msg>\n channelalias <msg>\n\n For example\n\n public Hello World\n pub Hello World\n\n (this shortcut doesn't work for aliases containing spaces)\n\n See channel/alias for help on setting channel aliases.\n\n ## alias and unalias\n\n Usage: channel/alias channel = alias[;alias[;alias...]]\n channel/unalias alias\n channel - this will list your subs and aliases to each channel\n\n Set one or more personal aliases for referencing a channel. For example:\n\n channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild\n\n You can now send to the channel using all of these:\n\n warrior's guild Hello\n warrior Hello\n wguild Hello\n warchannel Hello\n\n Note that this will not work if the alias has a space in it. So the\n 'warrior guild' alias must be used with the `channel` command:\n\n channel warrior guild = Hello\n\n Channel-aliases can be removed one at a time, using the '/unalias' switch.\n\n ## who\n\n Usage: channel/who channelname\n\n List the channel's subscribers. Shows who are currently offline or are\n muting the channel. Subscribers who are 'muting' will not see messages sent\n to the channel (use channel/mute to mute a channel).\n\n ## history\n\n Usage: channel/history channel [= index]\n\n This will display the last |c20|n lines of channel history. By supplying an\n index number, you will step that many lines back before viewing those 20 lines.\n\n For example:\n\n channel/history public = 35\n\n will go back 35 lines and show the previous 20 lines from that point (so\n lines -35 to -55).\n\n ## sub and unsub\n\n Usage: channel/sub channel [=alias[;alias;...]]\n channel/unsub channel\n\n This subscribes you to a channel and optionally assigns personal shortcuts\n for you to use to send to that channel (see aliases). When you unsub, all\n your personal aliases will also be removed.\n\n ## mute and unmute\n\n Usage: channel/mute channelname\n channel/unmute channelname\n\n Muting silences all output from the channel without actually\n un-subscribing. Other channel members will see that you are muted in the /who\n list. Sending a message to the channel will automatically unmute you.\n\n ## create and destroy\n\n Usage: channel/create channelname[;alias;alias[:typeclass]] [= description]\n channel/destroy channelname [= reason]\n\n Creates a new channel (or destroys one you control). You will automatically\n join the channel you create and everyone will be kicked and loose all aliases\n to a destroyed channel.\n\n ## lock and unlock\n\n Usage: channel/lock channelname = lockstring\n channel/unlock channelname = lockstring\n\n Note: this is an admin command.\n\n A lockstring is on the form locktype:lockfunc(). Channels understand three\n locktypes:\n listen - who may listen or join the channel.\n send - who may send messages to the channel\n control - who controls the channel. This is usually the one creating\n the channel.\n\n Common lockfuncs are all() and perm(). To make a channel everyone can\n listen to but only builders can talk on, use this:\n\n listen:all()\n send: perm(Builders)\n\n ## boot and ban\n\n Usage:\n channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]\n channel/ban channelname[, channelname, ...] = subscribername [: reason]\n channel/unban channelname[, channelname, ...] = subscribername\n channel/unban channelname\n channel/ban channelname (list bans)\n\n Booting will kick a named subscriber from channel(s) temporarily. The\n 'reason' will be passed to the booted user. Unless the /quiet switch is\n used, the channel will also be informed of the action. A booted user is\n still able to re-connect, but they'll have to set up their aliases again.\n\n Banning will blacklist a user from (re)joining the provided channels. It\n will then proceed to boot them from those channels if they were connected.\n The 'reason' and `/quiet` works the same as for booting.\n\n Example:\n boot mychannel1 = EvilUser : Kicking you to cool down a bit.\n ban mychannel1,mychannel2= EvilUser : Was banned for spamming.\n\n "}
    diff --git a/docs/2.x/api/evennia.commands.default.general.html b/docs/2.x/api/evennia.commands.default.general.html index 54a2ba138b..d4c8960c61 100644 --- a/docs/2.x/api/evennia.commands.default.general.html +++ b/docs/2.x/api/evennia.commands.default.general.html @@ -276,7 +276,7 @@ for everyone to use, you need build privileges and the alias command.

    -aliases = ['nickname', 'nicks']
    +aliases = ['nicks', 'nickname']
    @@ -308,7 +308,7 @@ for everyone to use, you need build privileges and the alias command.

    -search_index_entry = {'aliases': 'nickname nicks', 'category': 'general', 'key': 'nick', 'no_prefix': ' nickname nicks', 'tags': '', 'text': '\n define a personal alias/nick by defining a string to\n match and replace it with another on the fly\n\n Usage:\n nick[/switches] <string> [= [replacement_string]]\n nick[/switches] <template> = <replacement_template>\n nick/delete <string> or number\n nicks\n\n Switches:\n inputline - replace on the inputline (default)\n object - replace on object-lookup\n account - replace on account-lookup\n list - show all defined aliases (also "nicks" works)\n delete - remove nick by index in /list\n clearall - clear all nicks\n\n Examples:\n nick hi = say Hello, I\'m Sarah!\n nick/object tom = the tall man\n nick build $1 $2 = create/drop $1;$2\n nick tell $1 $2=page $1=$2\n nick tm?$1=page tallman=$1\n nick tm\\=$1=page tallman=$1\n\n A \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\n Put the last $-marker without an ending space to catch all remaining text. You\n can also use unix-glob matching for the left-hand side <string>:\n\n * - matches everything\n ? - matches 0 or 1 single characters\n [abcd] - matches these chars in any order\n [!abcd] - matches everything not among these chars\n \\= - escape literal \'=\' you want in your <string>\n\n Note that no objects are actually renamed or changed by this command - your nicks\n are only available to you. If you want to permanently add keywords to an object\n for everyone to use, you need build privileges and the alias command.\n\n '}
    +search_index_entry = {'aliases': 'nicks nickname', 'category': 'general', 'key': 'nick', 'no_prefix': ' nicks nickname', 'tags': '', 'text': '\n define a personal alias/nick by defining a string to\n match and replace it with another on the fly\n\n Usage:\n nick[/switches] <string> [= [replacement_string]]\n nick[/switches] <template> = <replacement_template>\n nick/delete <string> or number\n nicks\n\n Switches:\n inputline - replace on the inputline (default)\n object - replace on object-lookup\n account - replace on account-lookup\n list - show all defined aliases (also "nicks" works)\n delete - remove nick by index in /list\n clearall - clear all nicks\n\n Examples:\n nick hi = say Hello, I\'m Sarah!\n nick/object tom = the tall man\n nick build $1 $2 = create/drop $1;$2\n nick tell $1 $2=page $1=$2\n nick tm?$1=page tallman=$1\n nick tm\\=$1=page tallman=$1\n\n A \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\n Put the last $-marker without an ending space to catch all remaining text. You\n can also use unix-glob matching for the left-hand side <string>:\n\n * - matches everything\n ? - matches 0 or 1 single characters\n [abcd] - matches these chars in any order\n [!abcd] - matches everything not among these chars\n \\= - escape literal \'=\' you want in your <string>\n\n Note that no objects are actually renamed or changed by this command - your nicks\n are only available to you. If you want to permanently add keywords to an object\n for everyone to use, you need build privileges and the alias command.\n\n '}
    @@ -331,7 +331,7 @@ inv

    -aliases = ['inv', 'i']
    +aliases = ['i', 'inv']
    @@ -362,7 +362,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/2.x/api/evennia.commands.default.system.html b/docs/2.x/api/evennia.commands.default.system.html index 4f4b66b558..dc97c889a1 100644 --- a/docs/2.x/api/evennia.commands.default.system.html +++ b/docs/2.x/api/evennia.commands.default.system.html @@ -691,7 +691,7 @@ See |luhttps://ww
    -aliases = ['@delays', '@task']
    +aliases = ['@task', '@delays']
    @@ -737,7 +737,7 @@ to all the variables defined therein.

    -search_index_entry = {'aliases': '@delays @task', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks delays task', 'tags': '', 'text': "\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n "}
    +search_index_entry = {'aliases': '@task @delays', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks task delays', 'tags': '', 'text': "\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n "}
    diff --git a/docs/2.x/api/evennia.commands.default.tests.html b/docs/2.x/api/evennia.commands.default.tests.html index 708af4a5ec..58d655614f 100644 --- a/docs/2.x/api/evennia.commands.default.tests.html +++ b/docs/2.x/api/evennia.commands.default.tests.html @@ -963,7 +963,7 @@ main test suite started with

    Test the batch processor.

    -red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpcywdezmq/f40bfb679aaa60638ced507f64c97627e17881cd/evennia/contrib/tutorials/red_button/red_button.py'>
    +red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmprlci_f6c/0b030c078ae6d5ba6e59d11654f7ef99d42b1c08/evennia/contrib/tutorials/red_button/red_button.py'>
    diff --git a/docs/2.x/api/evennia.commands.default.unloggedin.html b/docs/2.x/api/evennia.commands.default.unloggedin.html index 00f420fbe4..16ba30dbd7 100644 --- a/docs/2.x/api/evennia.commands.default.unloggedin.html +++ b/docs/2.x/api/evennia.commands.default.unloggedin.html @@ -349,7 +349,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    @@ -375,7 +375,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/2.x/api/evennia.contrib.base_systems.email_login.email_login.html b/docs/2.x/api/evennia.contrib.base_systems.email_login.email_login.html index 2f227c560f..b095f3615c 100644 --- a/docs/2.x/api/evennia.contrib.base_systems.email_login.email_login.html +++ b/docs/2.x/api/evennia.contrib.base_systems.email_login.email_login.html @@ -343,7 +343,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    @@ -369,7 +369,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/2.x/api/evennia.contrib.base_systems.ingame_python.commands.html b/docs/2.x/api/evennia.contrib.base_systems.ingame_python.commands.html index 7d5faa367c..280ebcf386 100644 --- a/docs/2.x/api/evennia.contrib.base_systems.ingame_python.commands.html +++ b/docs/2.x/api/evennia.contrib.base_systems.ingame_python.commands.html @@ -124,7 +124,7 @@
    -aliases = ['@callbacks', '@callback', '@calls']
    +aliases = ['@callback', '@callbacks', '@calls']
    @@ -205,7 +205,7 @@ on user permission.

    -search_index_entry = {'aliases': '@callbacks @callback @calls', 'category': 'building', 'key': '@call', 'no_prefix': 'call callbacks callback calls', 'tags': '', 'text': '\n Command to edit callbacks.\n '}
    +search_index_entry = {'aliases': '@callback @callbacks @calls', 'category': 'building', 'key': '@call', 'no_prefix': 'call callback callbacks calls', 'tags': '', 'text': '\n Command to edit callbacks.\n '}
    diff --git a/docs/2.x/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html b/docs/2.x/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html index ca49eb74d4..7161fd5c59 100644 --- a/docs/2.x/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html +++ b/docs/2.x/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html @@ -168,7 +168,7 @@ aliases to an already joined channel.

    -aliases = ['chanalias', 'aliaschan']
    +aliases = ['aliaschan', 'chanalias']
    @@ -199,7 +199,7 @@ aliases to an already joined channel.

    -search_index_entry = {'aliases': 'chanalias aliaschan', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' chanalias aliaschan', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] <channel>\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}
    +search_index_entry = {'aliases': 'aliaschan chanalias', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' aliaschan chanalias', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] <channel>\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}
    @@ -225,7 +225,7 @@ for that channel.

    -aliases = ['delaliaschan', 'delchanalias']
    +aliases = ['delchanalias', 'delaliaschan']
    @@ -256,7 +256,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/2.x/api/evennia.contrib.full_systems.evscaperoom.commands.html b/docs/2.x/api/evennia.contrib.full_systems.evscaperoom.commands.html index 120797b7c1..fec6332087 100644 --- a/docs/2.x/api/evennia.contrib.full_systems.evscaperoom.commands.html +++ b/docs/2.x/api/evennia.contrib.full_systems.evscaperoom.commands.html @@ -219,7 +219,7 @@ the operation will be general or on the room.

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

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

    -aliases = [';', 'whisper', 'shout']
    +aliases = ['shout', ';', 'whisper']
    @@ -408,7 +408,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 '}
    @@ -498,7 +498,7 @@ looks and what actions is available.

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

    -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 '}
    +search_index_entry = {'aliases': 'unfocus e examine ex', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' unfocus e examine 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 '}
    @@ -589,7 +589,7 @@ set in self.parse())

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

    -search_index_entry = {'aliases': 'inventory inv i give', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inventory inv i give', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
    +search_index_entry = {'aliases': 'inventory give i inv', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inventory give i inv', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
    diff --git a/docs/2.x/api/evennia.contrib.game_systems.barter.barter.html b/docs/2.x/api/evennia.contrib.game_systems.barter.barter.html index 6b461fdbfa..ebcc660be2 100644 --- a/docs/2.x/api/evennia.contrib.game_systems.barter.barter.html +++ b/docs/2.x/api/evennia.contrib.game_systems.barter.barter.html @@ -753,7 +753,7 @@ try to influence the other part in the deal.

    -aliases = ['offers', 'deal']
    +aliases = ['deal', 'offers']
    @@ -779,7 +779,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/2.x/api/evennia.contrib.game_systems.clothing.clothing.html b/docs/2.x/api/evennia.contrib.game_systems.clothing.clothing.html index 7c96a8a017..2c3865a810 100644 --- a/docs/2.x/api/evennia.contrib.game_systems.clothing.clothing.html +++ b/docs/2.x/api/evennia.contrib.game_systems.clothing.clothing.html @@ -630,7 +630,7 @@ inv

    -aliases = ['inv', 'i']
    +aliases = ['i', 'inv']
    @@ -661,7 +661,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/2.x/api/evennia.contrib.grid.xyzgrid.commands.html b/docs/2.x/api/evennia.contrib.grid.xyzgrid.commands.html index f92fe04007..652a2fef7e 100644 --- a/docs/2.x/api/evennia.contrib.grid.xyzgrid.commands.html +++ b/docs/2.x/api/evennia.contrib.grid.xyzgrid.commands.html @@ -430,7 +430,7 @@ there is no room above/below you, your movement will fail.

    -aliases = ['dive', 'fly']
    +aliases = ['fly', 'dive']
    @@ -453,7 +453,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/2.x/api/evennia.contrib.rpg.dice.dice.html b/docs/2.x/api/evennia.contrib.rpg.dice.dice.html index f83eaba61b..5008628379 100644 --- a/docs/2.x/api/evennia.contrib.rpg.dice.dice.html +++ b/docs/2.x/api/evennia.contrib.rpg.dice.dice.html @@ -334,7 +334,7 @@ everyone but the person rolling.

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

    -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 "}
    +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 "}
    diff --git a/docs/2.x/api/evennia.contrib.rpg.rpsystem.rpsystem.html b/docs/2.x/api/evennia.contrib.rpg.rpsystem.rpsystem.html index c1c61a27f3..354dd6d3af 100644 --- a/docs/2.x/api/evennia.contrib.rpg.rpsystem.rpsystem.html +++ b/docs/2.x/api/evennia.contrib.rpg.rpsystem.rpsystem.html @@ -881,7 +881,7 @@ Using the command without arguments will list all current recogs.

    -aliases = ['recognize', 'forget']
    +aliases = ['forget', 'recognize']
    @@ -908,7 +908,7 @@ Using the command without arguments will list all current recogs.

    -search_index_entry = {'aliases': 'recognize forget', 'category': 'general', 'key': 'recog', 'no_prefix': ' recognize forget', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}
    +search_index_entry = {'aliases': 'forget recognize', 'category': 'general', 'key': 'recog', 'no_prefix': ' forget recognize', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}
    diff --git a/docs/2.x/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html b/docs/2.x/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html index 73fe4f65d0..5009392c4f 100644 --- a/docs/2.x/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html +++ b/docs/2.x/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html @@ -474,7 +474,7 @@ turn of combat, performing everyone’s actions in random order.

    -aliases = ['hit', 'turnbased combat']
    +aliases = ['turnbased combat', 'hit']
    @@ -520,7 +520,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/2.x/api/evennia.contrib.tutorials.evadventure.commands.html b/docs/2.x/api/evennia.contrib.tutorials.evadventure.commands.html index a8bfcc0523..ed02b786fb 100644 --- a/docs/2.x/api/evennia.contrib.tutorials.evadventure.commands.html +++ b/docs/2.x/api/evennia.contrib.tutorials.evadventure.commands.html @@ -200,7 +200,7 @@ self.args).

    -aliases = ['inv', 'i']
    +aliases = ['i', 'inv']
    @@ -224,7 +224,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 '}
    diff --git a/docs/2.x/api/evennia.contrib.tutorials.red_button.red_button.html b/docs/2.x/api/evennia.contrib.tutorials.red_button.red_button.html index dc7d45f570..aafee76616 100644 --- a/docs/2.x/api/evennia.contrib.tutorials.red_button.red_button.html +++ b/docs/2.x/api/evennia.contrib.tutorials.red_button.red_button.html @@ -161,7 +161,7 @@ such as when closing the lid and un-blinding a character.

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

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

    -aliases = ['break lid', 'smash lid', 'smash']
    +aliases = ['smash', 'smash lid', 'break lid']
    @@ -287,7 +287,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 smash lid break lid', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' smash smash lid break 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 '}
    @@ -387,7 +387,7 @@ be mutually exclusive.

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

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

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

    -search_index_entry = {'aliases': 'feel l examine listen ex get', 'category': 'general', 'key': 'look', 'no_prefix': ' feel l examine listen ex 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': 'l examine feel get listen ex', 'category': 'general', 'key': 'look', 'no_prefix': ' l examine feel get listen ex', '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/2.x/api/evennia.contrib.tutorials.tutorial_world.objects.html b/docs/2.x/api/evennia.contrib.tutorials.tutorial_world.objects.html index c0c53dccf0..e5b0bb8745 100644 --- a/docs/2.x/api/evennia.contrib.tutorials.tutorial_world.objects.html +++ b/docs/2.x/api/evennia.contrib.tutorials.tutorial_world.objects.html @@ -564,7 +564,7 @@ shift green root up/down

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

    -search_index_entry = {'aliases': 'push shiftroot move pull', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' push shiftroot 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 '}
    +search_index_entry = {'aliases': 'pull shiftroot push move', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' pull shiftroot push 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 '}
    @@ -617,7 +617,7 @@ yellow/green - horizontal roots

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

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

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

    -search_index_entry = {'aliases': 'bash thrust fight pierce parry chop slash defend kill hit stab', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' bash thrust fight pierce parry chop slash defend kill hit 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': 'pierce thrust bash hit kill chop parry defend slash stab fight', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' pierce thrust bash hit kill chop parry defend slash stab fight', '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/2.x/api/evennia.contrib.tutorials.tutorial_world.rooms.html b/docs/2.x/api/evennia.contrib.tutorials.tutorial_world.rooms.html index 39fb4d1fe8..19ef3781ae 100644 --- a/docs/2.x/api/evennia.contrib.tutorials.tutorial_world.rooms.html +++ b/docs/2.x/api/evennia.contrib.tutorials.tutorial_world.rooms.html @@ -824,7 +824,7 @@ if they fall off the bridge.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    @@ -850,7 +850,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 '}
    @@ -976,7 +976,7 @@ to find something.

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

    -search_index_entry = {'aliases': 'feel l fiddle feel around search', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' feel l fiddle feel around search', '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': 'l feel feel around fiddle search', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l feel feel around fiddle search', '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/2.x/api/evennia.contrib.utils.git_integration.git_integration.html b/docs/2.x/api/evennia.contrib.utils.git_integration.git_integration.html index 0ce4e2a391..fb8045317c 100644 --- a/docs/2.x/api/evennia.contrib.utils.git_integration.git_integration.html +++ b/docs/2.x/api/evennia.contrib.utils.git_integration.git_integration.html @@ -216,7 +216,7 @@ git evennia pull - Pull the latest evennia code.

    -directory = '/tmp/tmpcywdezmq/f40bfb679aaa60638ced507f64c97627e17881cd/evennia'
    +directory = '/tmp/tmprlci_f6c/0b030c078ae6d5ba6e59d11654f7ef99d42b1c08/evennia'
    @@ -277,7 +277,7 @@ git pull - Pull the latest code from your current branch.

    -directory = '/tmp/tmpcywdezmq/f40bfb679aaa60638ced507f64c97627e17881cd/evennia/game_template'
    +directory = '/tmp/tmprlci_f6c/0b030c078ae6d5ba6e59d11654f7ef99d42b1c08/evennia/game_template'
    diff --git a/docs/2.x/api/evennia.utils.eveditor.html b/docs/2.x/api/evennia.utils.eveditor.html index 344cf9ccfa..efe825a44c 100644 --- a/docs/2.x/api/evennia.utils.eveditor.html +++ b/docs/2.x/api/evennia.utils.eveditor.html @@ -344,7 +344,7 @@ indentation.

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

    -search_index_entry = {'aliases': ':S :x :echo : :h :> :r :i :A :p :uu :! :y :f := :I :w :q! :dw ::: :UU :j :fi :wq :u :< :s :DD :q :dd :: :fd', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :S :x :echo : :h :> :r :i :A :p :uu :! :y :f := :I :w :q! :dw ::: :UU :j :fi :wq :u :< :s :DD :q :dd :: :fd', 'tags': '', 'text': '\n Commands for the editor\n '}
    +search_index_entry = {'aliases': ':fd : :w :y :h :: :UU :s :echo :u :q :i :A :fi :S :I := :r :! :dw :j :q! :DD :< :uu :> :f :dd :x :wq :p :::', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :fd : :w :y :h :: :UU :s :echo :u :q :i :A :fi :S :I := :r :! :dw :j :q! :DD :< :uu :> :f :dd :x :wq :p :::', 'tags': '', 'text': '\n Commands for the editor\n '}
    diff --git a/docs/2.x/api/evennia.utils.evmenu.html b/docs/2.x/api/evennia.utils.evmenu.html index bc3356f1ac..b5c835eec4 100644 --- a/docs/2.x/api/evennia.utils.evmenu.html +++ b/docs/2.x/api/evennia.utils.evmenu.html @@ -172,8 +172,11 @@ returned as None as well. If the options are returned as None, the menu is immediately exited and the default “look” command is called.

    • -
      text (str, tuple or None): Text shown at this node. If a tuple, the

      second element in the tuple is a help text to display at this -node when the user enters the menu help command there.

      +
      text (str, tuple or None): Text shown at this node. If a tuple, the

      second element in the tuple holds either a string or a dict. If a string, +this is the help text to show when auto_help is active for the menu and +the user presses h. If a dict, this is a mapping of ‘help topic’: ‘help text’ to +show in that menu. This can be used to show information without having to +switch to another node.

    • @@ -668,6 +671,11 @@ should also report errors directly to the user.

      display_helptext()[source]
    +
    +
    +display_tooltip(cmd)[source]
    +
    +
    nodetext_formatter(nodetext)[source]
    @@ -939,7 +947,7 @@ single question.

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

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

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

    -search_index_entry = {'aliases': 'q abort previous t end e p next quit a top n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' q abort previous t end e p next quit a top n', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
    +search_index_entry = {'aliases': 'previous end p e quit q t n abort top a next', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' previous end p e quit q t n abort top a next', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
    diff --git a/docs/2.x/genindex.html b/docs/2.x/genindex.html index 9cee9e3c56..fefe19270b 100644 --- a/docs/2.x/genindex.html +++ b/docs/2.x/genindex.html @@ -5391,10 +5391,10 @@
  • DefaultRoom.MultipleObjectsReturned
  • - - +