From d35cbb8f68e754a1b290af2ae5d4212493ee1759 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Mon, 12 Jan 2026 16:46:03 +0000 Subject: [PATCH] Updated HTML docs. --- .../api/evennia.commands.default.admin.html | 4 ++-- .../api/evennia.commands.default.building.html | 16 ++++++++-------- .../api/evennia.commands.default.comms.html | 8 ++++---- .../api/evennia.commands.default.general.html | 16 ++++++++-------- .../api/evennia.commands.default.system.html | 4 ++-- .../api/evennia.commands.default.unloggedin.html | 12 ++++++------ ...rib.base_systems.email_login.email_login.html | 12 ++++++------ ...trib.base_systems.ingame_python.commands.html | 4 ++-- ...trib.base_systems.ingame_reports.reports.html | 4 ++-- ...se_systems.mux_comms_cmds.mux_comms_cmds.html | 4 ++-- ...ontrib.full_systems.evscaperoom.commands.html | 16 ++++++++-------- ...b.game_systems.achievements.achievements.html | 4 ++-- ...a.contrib.game_systems.clothing.clothing.html | 4 ++-- ...contrib.game_systems.turnbattle.tb_basic.html | 4 ++-- ...contrib.game_systems.turnbattle.tb_equip.html | 4 ++-- ...contrib.game_systems.turnbattle.tb_items.html | 4 ++-- ...contrib.game_systems.turnbattle.tb_magic.html | 4 ++-- ...contrib.game_systems.turnbattle.tb_range.html | 4 ++-- .../evennia.contrib.grid.xyzgrid.commands.html | 4 ++-- .../api/evennia.contrib.rpg.dice.dice.html | 4 ++-- .../evennia.contrib.rpg.rpsystem.rpsystem.html | 4 ++-- ...b.tutorials.evadventure.combat_turnbased.html | 4 ++-- ...a.contrib.tutorials.evadventure.commands.html | 8 ++++---- ....contrib.tutorials.red_button.red_button.html | 12 ++++++------ ...contrib.tutorials.tutorial_world.objects.html | 12 ++++++------ ...a.contrib.tutorials.tutorial_world.rooms.html | 4 ++-- docs/latest/api/evennia.utils.eveditor.html | 4 ++-- docs/latest/api/evennia.utils.evmenu.html | 4 ++-- docs/latest/api/evennia.utils.evmore.html | 4 ++-- 29 files changed, 96 insertions(+), 96 deletions(-) diff --git a/docs/latest/api/evennia.commands.default.admin.html b/docs/latest/api/evennia.commands.default.admin.html index 649f580fc6..77fa66f3b3 100644 --- a/docs/latest/api/evennia.commands.default.admin.html +++ b/docs/latest/api/evennia.commands.default.admin.html @@ -265,7 +265,7 @@ to accounts respectively.

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

-search_index_entry = {'aliases': 'remit pemit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' remit pemit', 'tags': '', 'text': '\nadmin command for emitting message to multiple objects\n\nUsage:\n  emit[/switches] [<obj>, <obj>, ... =] <message>\n  remit           [<obj>, <obj>, ... =] <message>\n  pemit           [<obj>, <obj>, ... =] <message>\n\nSwitches:\n  room     -  limit emits to rooms only (default)\n  accounts -  limit emits to accounts only\n  contents -  send to the contents of matched objects too\n\nEmits a message to the selected objects or to\nyour immediate surroundings. If the object is a room,\nsend to its contents. remit and pemit are just\nlimited forms of emit, for sending to rooms and\nto accounts respectively.\n'}
+search_index_entry = {'aliases': 'pemit remit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' pemit remit', 'tags': '', 'text': '\nadmin command for emitting message to multiple objects\n\nUsage:\n  emit[/switches] [<obj>, <obj>, ... =] <message>\n  remit           [<obj>, <obj>, ... =] <message>\n  pemit           [<obj>, <obj>, ... =] <message>\n\nSwitches:\n  room     -  limit emits to rooms only (default)\n  accounts -  limit emits to accounts only\n  contents -  send to the contents of matched objects too\n\nEmits a message to the selected objects or to\nyour immediate surroundings. If the object is a room,\nsend to its contents. remit and pemit are just\nlimited forms of emit, for sending to rooms and\nto accounts respectively.\n'}
diff --git a/docs/latest/api/evennia.commands.default.building.html b/docs/latest/api/evennia.commands.default.building.html index 32f97b854a..a15feb94ac 100644 --- a/docs/latest/api/evennia.commands.default.building.html +++ b/docs/latest/api/evennia.commands.default.building.html @@ -585,7 +585,7 @@ You can specify the /force switch to bypass this confirmation.

-aliases = ['@del', '@delete']
+aliases = ['@delete', '@del']
@@ -626,7 +626,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': '\npermanently delete objects\n\nUsage:\n   destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\nSwitches:\n   override - The destroy command will usually avoid accidentally\n              destroying account objects. This switch overrides this safety.\n   force - destroy without confirmation.\nExamples:\n   destroy house, roof, door, 44-78\n   destroy 5-10, flower, 45\n   destroy/force north\n\nDestroys one or many objects. If dbrefs are used, a range to delete can be\ngiven, e.g. 4-10. Also the end points will be deleted. This command\ndisplays a confirmation before destroying, to make sure of your choice.\nYou 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': '\npermanently delete objects\n\nUsage:\n   destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\nSwitches:\n   override - The destroy command will usually avoid accidentally\n              destroying account objects. This switch overrides this safety.\n   force - destroy without confirmation.\nExamples:\n   destroy house, roof, door, 44-78\n   destroy 5-10, flower, 45\n   destroy/force north\n\nDestroys one or many objects. If dbrefs are used, a range to delete can be\ngiven, e.g. 4-10. Also the end points will be deleted. This command\ndisplays a confirmation before destroying, to make sure of your choice.\nYou can specify the /force switch to bypass this confirmation.\n'}
@@ -1353,7 +1353,7 @@ server settings.

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

-search_index_entry = {'aliases': '@type @parent @update @swap @typeclasses', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass type parent update swap typeclasses', 'tags': '', 'text': "\nset or change an object's typeclass\n\nUsage:\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\nSwitch:\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\nExample:\n  type button = examples.red_button.RedButton\n  type/prototype button=a red button\n\nIf the typeclass_path is not given, the current object's typeclass is\nassumed.\n\nView or set an object's typeclass. If setting, the creation hooks of the\nnew typeclass will be run on the object. If you have clashing properties on\nthe old class, use /reset. By default you are protected from changing to a\ntypeclass of the same name as the one you already have - use /force to\noverride this protection.\n\nThe given typeclass must be identified by its location using python\ndot-notation pointing to the correct module and class. If no typeclass is\ngiven (or a wrong typeclass is given). Errors in the path or new typeclass\nwill lead to the old typeclass being kept. The location of the typeclass\nmodule is searched from the default typeclass directory, as defined in the\nserver settings.\n\n"}
+search_index_entry = {'aliases': '@type @typeclasses @update @swap @parent', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass type typeclasses update swap parent', 'tags': '', 'text': "\nset or change an object's typeclass\n\nUsage:\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\nSwitch:\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\nExample:\n  type button = examples.red_button.RedButton\n  type/prototype button=a red button\n\nIf the typeclass_path is not given, the current object's typeclass is\nassumed.\n\nView or set an object's typeclass. If setting, the creation hooks of the\nnew typeclass will be run on the object. If you have clashing properties on\nthe old class, use /reset. By default you are protected from changing to a\ntypeclass of the same name as the one you already have - use /force to\noverride this protection.\n\nThe given typeclass must be identified by its location using python\ndot-notation pointing to the correct module and class. If no typeclass is\ngiven (or a wrong typeclass is given). Errors in the path or new typeclass\nwill lead to the old typeclass being kept. The location of the typeclass\nmodule is searched from the default typeclass directory, as defined in the\nserver settings.\n\n"}
@@ -1539,7 +1539,7 @@ If object is not specified, the current location is examined.

-aliases = ['@exam', '@ex']
+aliases = ['@ex', '@exam']
@@ -1812,7 +1812,7 @@ the cases, see the module doc.

-search_index_entry = {'aliases': '@exam @ex', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine exam ex', 'tags': '', 'text': '\nget detailed information about an object\n\nUsage:\n  examine [<object>[/attrname]]\n  examine [*<account>[/attrname]]\n\nSwitch:\n  account - examine an Account (same as adding *)\n  object - examine an Object (useful when OOC)\n  script - examine a Script\n  channel - examine a Channel\n\nThe examine command shows detailed game info about an\nobject and optionally a specific attribute on it.\nIf object is not specified, the current location is examined.\n\nAppend a * before the search string to examine an account.\n\n'}
+search_index_entry = {'aliases': '@ex @exam', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine ex exam', 'tags': '', 'text': '\nget detailed information about an object\n\nUsage:\n  examine [<object>[/attrname]]\n  examine [*<account>[/attrname]]\n\nSwitch:\n  account - examine an Account (same as adding *)\n  object - examine an Object (useful when OOC)\n  script - examine a Script\n  channel - examine a Channel\n\nThe examine command shows detailed game info about an\nobject and optionally a specific attribute on it.\nIf object is not specified, the current location is examined.\n\nAppend a * before the search string to examine an account.\n\n'}
@@ -1846,7 +1846,7 @@ one is given.

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

-search_index_entry = {'aliases': '@locate @search', 'category': 'building', 'key': '@find', 'no_prefix': 'find locate search', 'tags': '', 'text': '\nsearch the database for objects\n\nUsage:\n  find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n  locate - this is a shorthand for using the /loc switch.\n\nSwitches:\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\nSearches the database for an object of a particular name or exact #dbref.\nUse *accountname to search for an account. The switches allows for\nlimiting object matches to certain game entities. Dbrefmin and dbrefmax\nlimits matches to within the given dbrefs range, or above/below if only\none is given.\n'}
+search_index_entry = {'aliases': '@search @locate', 'category': 'building', 'key': '@find', 'no_prefix': 'find search locate', 'tags': '', 'text': '\nsearch the database for objects\n\nUsage:\n  find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n  locate - this is a shorthand for using the /loc switch.\n\nSwitches:\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\nSearches the database for an object of a particular name or exact #dbref.\nUse *accountname to search for an account. The switches allows for\nlimiting object matches to certain game entities. Dbrefmin and dbrefmax\nlimits matches to within the given dbrefs range, or above/below if only\none is given.\n'}
diff --git a/docs/latest/api/evennia.commands.default.comms.html b/docs/latest/api/evennia.commands.default.comms.html index a6dd806bcc..0a00d950c8 100644 --- a/docs/latest/api/evennia.commands.default.comms.html +++ b/docs/latest/api/evennia.commands.default.comms.html @@ -232,7 +232,7 @@ ban mychannel1,mychannel2= EvilUser : Was banned for spamming.

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

-search_index_entry = {'aliases': '@channels @chan', 'category': 'comms', 'key': '@channel', 'no_prefix': 'channel channels chan', 'tags': '', 'text': "\nUse and manage in-game channels.\n\nUsage:\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\nUsage: channel channelname msg\n       channel channel name = msg  (with space in channel name)\n\nThis sends a message to the channel. Note that you will rarely use this\ncommand like this; instead you can use the alias\n\n    channelname <msg>\n    channelalias <msg>\n\nFor example\n\n    public Hello World\n    pub Hello World\n\n(this shortcut doesn't work for aliases containing spaces)\n\nSee channel/alias for help on setting channel aliases.\n\n## alias and unalias\n\nUsage: channel/alias channel = alias[;alias[;alias...]]\n       channel/unalias alias\n       channel    - this will list your subs and aliases to each channel\n\nSet one or more personal aliases for referencing a channel. For example:\n\n    channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild\n\nYou 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\nNote 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\nChannel-aliases can be removed one at a time, using the '/unalias' switch.\n\n## who\n\nUsage: channel/who channelname\n\nList the channel's subscribers. Shows who are currently offline or are\nmuting the channel. Subscribers who are 'muting' will not see messages sent\nto the channel (use channel/mute to mute a channel).\n\n## history\n\nUsage: channel/history channel [= index]\n\nThis will display the last |c20|n lines of channel history. By supplying an\nindex number, you will step that many lines back before viewing those 20 lines.\n\nFor example:\n\n    channel/history public = 35\n\nwill go back 35 lines and show the previous 20 lines from that point (so\nlines -35 to -55).\n\n## sub and unsub\n\nUsage: channel/sub channel [=alias[;alias;...]]\n       channel/unsub channel\n\nThis subscribes you to a channel and optionally assigns personal shortcuts\nfor you to use to send to that channel (see aliases). When you unsub, all\nyour personal aliases will also be removed.\n\n## mute and unmute\n\nUsage: channel/mute channelname\n       channel/unmute channelname\n\nMuting silences all output from the channel without actually\nun-subscribing. Other channel members will see that you are muted in the /who\nlist. Sending a message to the channel will automatically unmute you.\n\n## create and destroy\n\nUsage: channel/create channelname[;alias;alias[:typeclass]] [= description]\n       channel/destroy channelname [= reason]\n\nCreates a new channel (or destroys one you control). You will automatically\njoin the channel you create and everyone will be kicked and loose all aliases\nto a destroyed channel.\n\n## lock and unlock\n\nUsage: channel/lock channelname = lockstring\n       channel/unlock channelname = lockstring\n\nNote: this is an admin command.\n\nA lockstring is on the form locktype:lockfunc(). Channels understand three\nlocktypes:\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\nCommon lockfuncs are all() and perm(). To make a channel everyone can\nlisten to but only builders can talk on, use this:\n\n    listen:all()\n    send: perm(Builders)\n\n## boot and ban\n\nUsage:\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\nBooting will kick a named subscriber from channel(s) temporarily. The\n'reason' will be passed to the booted user. Unless the /quiet switch is\nused, the channel will also be informed of the action. A booted user is\nstill able to re-connect, but they'll have to set up their aliases again.\n\nBanning will blacklist a user from (re)joining the provided channels. It\nwill then proceed to boot them from those channels if they were connected.\nThe 'reason' and `/quiet` works the same as for booting.\n\nExample:\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': "\nUse and manage in-game channels.\n\nUsage:\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\nUsage: channel channelname msg\n       channel channel name = msg  (with space in channel name)\n\nThis sends a message to the channel. Note that you will rarely use this\ncommand like this; instead you can use the alias\n\n    channelname <msg>\n    channelalias <msg>\n\nFor example\n\n    public Hello World\n    pub Hello World\n\n(this shortcut doesn't work for aliases containing spaces)\n\nSee channel/alias for help on setting channel aliases.\n\n## alias and unalias\n\nUsage: channel/alias channel = alias[;alias[;alias...]]\n       channel/unalias alias\n       channel    - this will list your subs and aliases to each channel\n\nSet one or more personal aliases for referencing a channel. For example:\n\n    channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild\n\nYou 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\nNote 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\nChannel-aliases can be removed one at a time, using the '/unalias' switch.\n\n## who\n\nUsage: channel/who channelname\n\nList the channel's subscribers. Shows who are currently offline or are\nmuting the channel. Subscribers who are 'muting' will not see messages sent\nto the channel (use channel/mute to mute a channel).\n\n## history\n\nUsage: channel/history channel [= index]\n\nThis will display the last |c20|n lines of channel history. By supplying an\nindex number, you will step that many lines back before viewing those 20 lines.\n\nFor example:\n\n    channel/history public = 35\n\nwill go back 35 lines and show the previous 20 lines from that point (so\nlines -35 to -55).\n\n## sub and unsub\n\nUsage: channel/sub channel [=alias[;alias;...]]\n       channel/unsub channel\n\nThis subscribes you to a channel and optionally assigns personal shortcuts\nfor you to use to send to that channel (see aliases). When you unsub, all\nyour personal aliases will also be removed.\n\n## mute and unmute\n\nUsage: channel/mute channelname\n       channel/unmute channelname\n\nMuting silences all output from the channel without actually\nun-subscribing. Other channel members will see that you are muted in the /who\nlist. Sending a message to the channel will automatically unmute you.\n\n## create and destroy\n\nUsage: channel/create channelname[;alias;alias[:typeclass]] [= description]\n       channel/destroy channelname [= reason]\n\nCreates a new channel (or destroys one you control). You will automatically\njoin the channel you create and everyone will be kicked and loose all aliases\nto a destroyed channel.\n\n## lock and unlock\n\nUsage: channel/lock channelname = lockstring\n       channel/unlock channelname = lockstring\n\nNote: this is an admin command.\n\nA lockstring is on the form locktype:lockfunc(). Channels understand three\nlocktypes:\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\nCommon lockfuncs are all() and perm(). To make a channel everyone can\nlisten to but only builders can talk on, use this:\n\n    listen:all()\n    send: perm(Builders)\n\n## boot and ban\n\nUsage:\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\nBooting will kick a named subscriber from channel(s) temporarily. The\n'reason' will be passed to the booted user. Unless the /quiet switch is\nused, the channel will also be informed of the action. A booted user is\nstill able to re-connect, but they'll have to set up their aliases again.\n\nBanning will blacklist a user from (re)joining the provided channels. It\nwill then proceed to boot them from those channels if they were connected.\nThe 'reason' and `/quiet` works the same as for booting.\n\nExample:\n    boot mychannel1 = EvilUser : Kicking you to cool down a bit.\n    ban mychannel1,mychannel2= EvilUser : Was banned for spamming.\n\n"}
@@ -940,7 +940,7 @@ ban mychannel1,mychannel2= EvilUser : Was banned for spamming.

-aliases = ['@channels', '@chan']
+aliases = ['@chan', '@channels']
@@ -960,7 +960,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': "\nUse and manage in-game channels.\n\nUsage:\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\nUsage: channel channelname msg\n       channel channel name = msg  (with space in channel name)\n\nThis sends a message to the channel. Note that you will rarely use this\ncommand like this; instead you can use the alias\n\n    channelname <msg>\n    channelalias <msg>\n\nFor example\n\n    public Hello World\n    pub Hello World\n\n(this shortcut doesn't work for aliases containing spaces)\n\nSee channel/alias for help on setting channel aliases.\n\n## alias and unalias\n\nUsage: channel/alias channel = alias[;alias[;alias...]]\n       channel/unalias alias\n       channel    - this will list your subs and aliases to each channel\n\nSet one or more personal aliases for referencing a channel. For example:\n\n    channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild\n\nYou 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\nNote 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\nChannel-aliases can be removed one at a time, using the '/unalias' switch.\n\n## who\n\nUsage: channel/who channelname\n\nList the channel's subscribers. Shows who are currently offline or are\nmuting the channel. Subscribers who are 'muting' will not see messages sent\nto the channel (use channel/mute to mute a channel).\n\n## history\n\nUsage: channel/history channel [= index]\n\nThis will display the last |c20|n lines of channel history. By supplying an\nindex number, you will step that many lines back before viewing those 20 lines.\n\nFor example:\n\n    channel/history public = 35\n\nwill go back 35 lines and show the previous 20 lines from that point (so\nlines -35 to -55).\n\n## sub and unsub\n\nUsage: channel/sub channel [=alias[;alias;...]]\n       channel/unsub channel\n\nThis subscribes you to a channel and optionally assigns personal shortcuts\nfor you to use to send to that channel (see aliases). When you unsub, all\nyour personal aliases will also be removed.\n\n## mute and unmute\n\nUsage: channel/mute channelname\n       channel/unmute channelname\n\nMuting silences all output from the channel without actually\nun-subscribing. Other channel members will see that you are muted in the /who\nlist. Sending a message to the channel will automatically unmute you.\n\n## create and destroy\n\nUsage: channel/create channelname[;alias;alias[:typeclass]] [= description]\n       channel/destroy channelname [= reason]\n\nCreates a new channel (or destroys one you control). You will automatically\njoin the channel you create and everyone will be kicked and loose all aliases\nto a destroyed channel.\n\n## lock and unlock\n\nUsage: channel/lock channelname = lockstring\n       channel/unlock channelname = lockstring\n\nNote: this is an admin command.\n\nA lockstring is on the form locktype:lockfunc(). Channels understand three\nlocktypes:\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\nCommon lockfuncs are all() and perm(). To make a channel everyone can\nlisten to but only builders can talk on, use this:\n\n    listen:all()\n    send: perm(Builders)\n\n## boot and ban\n\nUsage:\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\nBooting will kick a named subscriber from channel(s) temporarily. The\n'reason' will be passed to the booted user. Unless the /quiet switch is\nused, the channel will also be informed of the action. A booted user is\nstill able to re-connect, but they'll have to set up their aliases again.\n\nBanning will blacklist a user from (re)joining the provided channels. It\nwill then proceed to boot them from those channels if they were connected.\nThe 'reason' and `/quiet` works the same as for booting.\n\nExample:\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': "\nUse and manage in-game channels.\n\nUsage:\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\nUsage: channel channelname msg\n       channel channel name = msg  (with space in channel name)\n\nThis sends a message to the channel. Note that you will rarely use this\ncommand like this; instead you can use the alias\n\n    channelname <msg>\n    channelalias <msg>\n\nFor example\n\n    public Hello World\n    pub Hello World\n\n(this shortcut doesn't work for aliases containing spaces)\n\nSee channel/alias for help on setting channel aliases.\n\n## alias and unalias\n\nUsage: channel/alias channel = alias[;alias[;alias...]]\n       channel/unalias alias\n       channel    - this will list your subs and aliases to each channel\n\nSet one or more personal aliases for referencing a channel. For example:\n\n    channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild\n\nYou 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\nNote 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\nChannel-aliases can be removed one at a time, using the '/unalias' switch.\n\n## who\n\nUsage: channel/who channelname\n\nList the channel's subscribers. Shows who are currently offline or are\nmuting the channel. Subscribers who are 'muting' will not see messages sent\nto the channel (use channel/mute to mute a channel).\n\n## history\n\nUsage: channel/history channel [= index]\n\nThis will display the last |c20|n lines of channel history. By supplying an\nindex number, you will step that many lines back before viewing those 20 lines.\n\nFor example:\n\n    channel/history public = 35\n\nwill go back 35 lines and show the previous 20 lines from that point (so\nlines -35 to -55).\n\n## sub and unsub\n\nUsage: channel/sub channel [=alias[;alias;...]]\n       channel/unsub channel\n\nThis subscribes you to a channel and optionally assigns personal shortcuts\nfor you to use to send to that channel (see aliases). When you unsub, all\nyour personal aliases will also be removed.\n\n## mute and unmute\n\nUsage: channel/mute channelname\n       channel/unmute channelname\n\nMuting silences all output from the channel without actually\nun-subscribing. Other channel members will see that you are muted in the /who\nlist. Sending a message to the channel will automatically unmute you.\n\n## create and destroy\n\nUsage: channel/create channelname[;alias;alias[:typeclass]] [= description]\n       channel/destroy channelname [= reason]\n\nCreates a new channel (or destroys one you control). You will automatically\njoin the channel you create and everyone will be kicked and loose all aliases\nto a destroyed channel.\n\n## lock and unlock\n\nUsage: channel/lock channelname = lockstring\n       channel/unlock channelname = lockstring\n\nNote: this is an admin command.\n\nA lockstring is on the form locktype:lockfunc(). Channels understand three\nlocktypes:\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\nCommon lockfuncs are all() and perm(). To make a channel everyone can\nlisten to but only builders can talk on, use this:\n\n    listen:all()\n    send: perm(Builders)\n\n## boot and ban\n\nUsage:\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\nBooting will kick a named subscriber from channel(s) temporarily. The\n'reason' will be passed to the booted user. Unless the /quiet switch is\nused, the channel will also be informed of the action. A booted user is\nstill able to re-connect, but they'll have to set up their aliases again.\n\nBanning will blacklist a user from (re)joining the provided channels. It\nwill then proceed to boot them from those channels if they were connected.\nThe 'reason' and `/quiet` works the same as for booting.\n\nExample:\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/latest/api/evennia.commands.default.general.html b/docs/latest/api/evennia.commands.default.general.html index 76a82f412d..f71c7aa2d5 100644 --- a/docs/latest/api/evennia.commands.default.general.html +++ b/docs/latest/api/evennia.commands.default.general.html @@ -216,7 +216,7 @@ for everyone to use, you need build privileges and the alias command.

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

-search_index_entry = {'aliases': 'nicks nickname', 'category': 'general', 'key': 'nick', 'no_prefix': ' nicks nickname', 'tags': '', 'text': '\ndefine a personal alias/nick by defining a string to\nmatch and replace it with another on the fly\n\nUsage:\n  nick[/switches] <string> [= [replacement_string]]\n  nick[/switches] <template> = <replacement_template>\n  nick/delete <string> or number\n  nicks\n\nSwitches:\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\nExamples:\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\nA \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\nPut the last $-marker without an ending space to catch all remaining text. You\ncan 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\nNote that no objects are actually renamed or changed by this command - your nicks\nare only available to you. If you want to permanently add keywords to an object\nfor everyone to use, you need build privileges and the alias command.\n\n'}
+search_index_entry = {'aliases': 'nickname nicks', 'category': 'general', 'key': 'nick', 'no_prefix': ' nickname nicks', 'tags': '', 'text': '\ndefine a personal alias/nick by defining a string to\nmatch and replace it with another on the fly\n\nUsage:\n  nick[/switches] <string> [= [replacement_string]]\n  nick[/switches] <template> = <replacement_template>\n  nick/delete <string> or number\n  nicks\n\nSwitches:\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\nExamples:\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\nA \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\nPut the last $-marker without an ending space to catch all remaining text. You\ncan 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\nNote that no objects are actually renamed or changed by this command - your nicks\nare only available to you. If you want to permanently add keywords to an object\nfor everyone to use, you need build privileges and the alias command.\n\n'}
@@ -271,7 +271,7 @@ inv

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

-search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\nview inventory\n\nUsage:\n  inventory\n  inv\n\nShows your inventory.\n'}
+search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\nview inventory\n\nUsage:\n  inventory\n  inv\n\nShows your inventory.\n'}
@@ -545,7 +545,7 @@ placing it in their inventory.

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

-search_index_entry = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\nspeak as your character\n\nUsage:\n  say <message>\n\nTalk to those in your current location.\n'}
+search_index_entry = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\nspeak as your character\n\nUsage:\n  say <message>\n\nTalk to those in your current location.\n'}
@@ -656,7 +656,7 @@ automatically begin with your name.

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

-search_index_entry = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'no_prefix': ' : emote', 'tags': '', 'text': "\nstrike a pose\n\nUsage:\n  pose <pose text>\n  pose's <pose text>\n\nExample:\n  pose is standing by the wall, smiling.\n   -> others will see:\n  Tom is standing by the wall, smiling.\n\nDescribe an action being taken. The pose text will\nautomatically begin with your name.\n"}
+search_index_entry = {'aliases': 'emote :', 'category': 'general', 'key': 'pose', 'no_prefix': ' emote :', 'tags': '', 'text': "\nstrike a pose\n\nUsage:\n  pose <pose text>\n  pose's <pose text>\n\nExample:\n  pose is standing by the wall, smiling.\n   -> others will see:\n  Tom is standing by the wall, smiling.\n\nDescribe an action being taken. The pose text will\nautomatically begin with your name.\n"}
diff --git a/docs/latest/api/evennia.commands.default.system.html b/docs/latest/api/evennia.commands.default.system.html index 85dbe9bc21..02a5aff6bd 100644 --- a/docs/latest/api/evennia.commands.default.system.html +++ b/docs/latest/api/evennia.commands.default.system.html @@ -631,7 +631,7 @@ See |luhttps://ww
-aliases = ['@delays', '@task']
+aliases = ['@task', '@delays']
@@ -679,7 +679,7 @@ to all the variables defined therein.

-search_index_entry = {'aliases': '@delays @task', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks delays task', 'tags': '', 'text': "\nDisplay or terminate active tasks (delays).\n\nUsage:\n    tasks[/switch] [task_id or function_name]\n\nSwitches:\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\nNotes:\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\nExamples:\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': "\nDisplay or terminate active tasks (delays).\n\nUsage:\n    tasks[/switch] [task_id or function_name]\n\nSwitches:\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\nNotes:\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\nExamples:\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/latest/api/evennia.commands.default.unloggedin.html b/docs/latest/api/evennia.commands.default.unloggedin.html index 385205f391..143d2cdc38 100644 --- a/docs/latest/api/evennia.commands.default.unloggedin.html +++ b/docs/latest/api/evennia.commands.default.unloggedin.html @@ -70,7 +70,7 @@ connect “account name” “pass word”

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

-search_index_entry = {'aliases': 'con co conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' con co conn', 'tags': '', 'text': '\nconnect to the game\n\nUsage (at login screen):\n  connect accountname password\n  connect "account name" "pass word"\n\nUse the create command to first create an account before logging in.\n\nIf you have spaces in your name, enclose it in double quotes.\n'}
+search_index_entry = {'aliases': 'con conn co', 'category': 'general', 'key': 'connect', 'no_prefix': ' con conn co', 'tags': '', 'text': '\nconnect to the game\n\nUsage (at login screen):\n  connect accountname password\n  connect "account name" "pass word"\n\nUse the create command to first create an account before logging in.\n\nIf you have spaces in your name, enclose it in double quotes.\n'}
@@ -240,7 +240,7 @@ All it does is display the connect screen.

-aliases = ['l', 'look']
+aliases = ['look', 'l']
@@ -266,7 +266,7 @@ All it does is display the connect screen.

-search_index_entry = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\nlook when in unlogged-in state\n\nUsage:\n  look\n\nThis is an unconnected version of the look command for simplicity.\n\nThis is called by the server and kicks everything in gear.\nAll it does is display the connect screen.\n'}
+search_index_entry = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\nlook when in unlogged-in state\n\nUsage:\n  look\n\nThis is an unconnected version of the look command for simplicity.\n\nThis is called by the server and kicks everything in gear.\nAll it does is display the connect screen.\n'}
@@ -289,7 +289,7 @@ for simplicity. It shows a pane of info.

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

-search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\nget help when in unconnected-in state\n\nUsage:\n  help\n\nThis is an unconnected version of the help command,\nfor simplicity. It shows a pane of info.\n'}
+search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\nget help when in unconnected-in state\n\nUsage:\n  help\n\nThis is an unconnected version of the help command,\nfor simplicity. It shows a pane of info.\n'}
diff --git a/docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html b/docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html index 245b1f4a0e..6ca53e7e51 100644 --- a/docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html +++ b/docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html @@ -87,7 +87,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.

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

-search_index_entry = {'aliases': 'con co conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' con co conn', 'tags': '', 'text': '\nConnect to the game.\n\nUsage (at login screen):\n    connect <email> <password>\n\nUse the create command to first create an account before logging in.\n'}
+search_index_entry = {'aliases': 'con conn co', 'category': 'general', 'key': 'connect', 'no_prefix': ' con conn co', 'tags': '', 'text': '\nConnect to the game.\n\nUsage (at login screen):\n    connect <email> <password>\n\nUse the create command to first create an account before logging in.\n'}
@@ -245,7 +245,7 @@ All it does is display the connect screen.

-aliases = ['l', 'look']
+aliases = ['look', 'l']
@@ -271,7 +271,7 @@ All it does is display the connect screen.

-search_index_entry = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\nThis is an unconnected version of the `look` command for simplicity.\n\nThis is called by the server and kicks everything in gear.\nAll it does is display the connect screen.\n'}
+search_index_entry = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\nThis is an unconnected version of the `look` command for simplicity.\n\nThis is called by the server and kicks everything in gear.\nAll it does is display the connect screen.\n'}
@@ -289,7 +289,7 @@ for simplicity. It shows a pane of info.

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

-search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\nThis is an unconnected version of the help command,\nfor simplicity. It shows a pane of info.\n'}
+search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\nThis is an unconnected version of the help command,\nfor simplicity. It shows a pane of info.\n'}
diff --git a/docs/latest/api/evennia.contrib.base_systems.ingame_python.commands.html b/docs/latest/api/evennia.contrib.base_systems.ingame_python.commands.html index c43ab8f47f..66b6d0dca3 100644 --- a/docs/latest/api/evennia.contrib.base_systems.ingame_python.commands.html +++ b/docs/latest/api/evennia.contrib.base_systems.ingame_python.commands.html @@ -64,7 +64,7 @@
-aliases = ['@calls', '@callbacks', '@callback']
+aliases = ['@calls', '@callback', '@callbacks']
@@ -145,7 +145,7 @@ on user permission.

-search_index_entry = {'aliases': '@calls @callbacks @callback', 'category': 'building', 'key': '@call', 'no_prefix': 'call calls callbacks callback', 'tags': '', 'text': '\nCommand to edit callbacks.\n'}
+search_index_entry = {'aliases': '@calls @callback @callbacks', 'category': 'building', 'key': '@call', 'no_prefix': 'call calls callback callbacks', 'tags': '', 'text': '\nCommand to edit callbacks.\n'}
diff --git a/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html b/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html index 8b0289a7d5..d7c2d604ef 100644 --- a/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html +++ b/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html @@ -100,7 +100,7 @@ players

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

-search_index_entry = {'aliases': 'manage bugs manage players manage ideas', 'category': 'general', 'key': 'manage reports', 'no_prefix': ' manage bugs manage players manage ideas', 'tags': '', 'text': '\nmanage the various reports\n\nUsage:\n    manage [report type]\n\nAvailable report types:\n    bugs\n    ideas\n    players\n\nInitializes a menu for reviewing and changing the status of current reports.\n'}
+search_index_entry = {'aliases': 'manage players manage ideas manage bugs', 'category': 'general', 'key': 'manage reports', 'no_prefix': ' manage players manage ideas manage bugs', 'tags': '', 'text': '\nmanage the various reports\n\nUsage:\n    manage [report type]\n\nAvailable report types:\n    bugs\n    ideas\n    players\n\nInitializes a menu for reviewing and changing the status of current reports.\n'}
diff --git a/docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html b/docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html index 30c948271d..6297912b44 100644 --- a/docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html +++ b/docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html @@ -108,7 +108,7 @@ aliases to an already joined channel.

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

-search_index_entry = {'aliases': 'aliaschan chanalias', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' aliaschan chanalias', 'tags': '', 'text': '\nAdd a channel alias and/or subscribe to a channel\n\nUsage:\n   addcom [alias=] <channel>\n\nJoins a given channel. If alias is given, this will allow you to\nrefer to the channel by this alias rather than the full channel\nname. Subsequent calls of this command can be used to add multiple\naliases to an already joined channel.\n'}
+search_index_entry = {'aliases': 'chanalias aliaschan', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' chanalias aliaschan', 'tags': '', 'text': '\nAdd a channel alias and/or subscribe to a channel\n\nUsage:\n   addcom [alias=] <channel>\n\nJoins a given channel. If alias is given, this will allow you to\nrefer to the channel by this alias rather than the full channel\nname. Subsequent calls of this command can be used to add multiple\naliases to an already joined channel.\n'}
diff --git a/docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html b/docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html index bb9005e9e9..5055909321 100644 --- a/docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html +++ b/docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html @@ -159,7 +159,7 @@ the operation will be general or on the room.

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

-search_index_entry = {'aliases': 'abort chicken out quit q', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' abort chicken out quit q', 'tags': '', 'text': '\nGive up\n\nUsage:\n  give up\n\nAbandons your attempts at escaping and of ever winning the pie-eating contest.\n\n'}
+search_index_entry = {'aliases': 'chicken out q abort quit', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' chicken out q abort quit', 'tags': '', 'text': '\nGive up\n\nUsage:\n  give up\n\nAbandons your attempts at escaping and of ever winning the pie-eating contest.\n\n'}
@@ -319,7 +319,7 @@ shout

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

-search_index_entry = {'aliases': 'shout whisper ;', 'category': 'general', 'key': 'say', 'no_prefix': ' shout whisper ;', 'tags': '', 'text': '\nPerform an communication action.\n\nUsage:\n  say <text>\n  whisper\n  shout\n\n'}
+search_index_entry = {'aliases': 'whisper shout ;', 'category': 'general', 'key': 'say', 'no_prefix': ' whisper shout ;', 'tags': '', 'text': '\nPerform an communication action.\n\nUsage:\n  say <text>\n  whisper\n  shout\n\n'}
@@ -438,7 +438,7 @@ looks and what actions is available.

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

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

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

-search_index_entry = {'aliases': 'inventory give i inv', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inventory give i inv', 'tags': '', 'text': '\nUse focus / examine instead.\n\n'}
+search_index_entry = {'aliases': 'inv give i inventory', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inv give i inventory', 'tags': '', 'text': '\nUse focus / examine instead.\n\n'}
diff --git a/docs/latest/api/evennia.contrib.game_systems.achievements.achievements.html b/docs/latest/api/evennia.contrib.game_systems.achievements.achievements.html index 8dcc4b526e..8ce9ad8eff 100644 --- a/docs/latest/api/evennia.contrib.game_systems.achievements.achievements.html +++ b/docs/latest/api/evennia.contrib.game_systems.achievements.achievements.html @@ -223,7 +223,7 @@ achievements/progress rats

-aliases = ['achievement', 'achieves', 'achieve']
+aliases = ['achieves', 'achievement', 'achieve']
@@ -273,7 +273,7 @@ to all the variables defined therein.

-search_index_entry = {'aliases': 'achievement achieves achieve', 'category': 'general', 'key': 'achievements', 'no_prefix': ' achievement achieves achieve', 'tags': '', 'text': '\nview achievements\n\nUsage:\n    achievements[/switches] [args]\n\nSwitches:\n    all          View all achievements, including locked ones.\n    completed    View achievements you\'ve completed.\n    progress     View achievements you have partially completed\n\nCheck your achievement statuses or browse the list. Providing a command argument\nwill search all your currently unlocked achievements for matches, and the switches\nwill filter the list to something other than "all unlocked". Combining a command\nargument with a switch will search only in that list.\n\nExamples:\n    achievements apples\n    achievements/all\n    achievements/progress rats\n'}
+search_index_entry = {'aliases': 'achieves achievement achieve', 'category': 'general', 'key': 'achievements', 'no_prefix': ' achieves achievement achieve', 'tags': '', 'text': '\nview achievements\n\nUsage:\n    achievements[/switches] [args]\n\nSwitches:\n    all          View all achievements, including locked ones.\n    completed    View achievements you\'ve completed.\n    progress     View achievements you have partially completed\n\nCheck your achievement statuses or browse the list. Providing a command argument\nwill search all your currently unlocked achievements for matches, and the switches\nwill filter the list to something other than "all unlocked". Combining a command\nargument with a switch will search only in that list.\n\nExamples:\n    achievements apples\n    achievements/all\n    achievements/progress rats\n'}
diff --git a/docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html b/docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html index 8e262d7580..2d389093c0 100644 --- a/docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html +++ b/docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html @@ -576,7 +576,7 @@ inv

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

-search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\nview inventory\n\nUsage:\n  inventory\n  inv\n\nShows your inventory.\n'}
+search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\nview inventory\n\nUsage:\n  inventory\n  inv\n\nShows your inventory.\n'}
diff --git a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html index 6a7984db5c..91b77111ef 100644 --- a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html +++ b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html @@ -626,7 +626,7 @@ if there are still any actions you can take.

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

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

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

-search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\nPasses on your turn.\n\nUsage:\n  pass\n\nWhen in a fight, you can use this command to end your turn early, even\nif there are still any actions you can take.\n'}
+search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\nPasses on your turn.\n\nUsage:\n  pass\n\nWhen in a fight, you can use this command to end your turn early, even\nif there are still any actions you can take.\n'}
diff --git a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html index a9a89fb36c..99cbac91db 100644 --- a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html +++ b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html @@ -647,7 +647,7 @@ if there are still any actions you can take.

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

-search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\nPasses on your turn.\n\nUsage:\n  pass\n\nWhen in a fight, you can use this command to end your turn early, even\nif there are still any actions you can take.\n'}
+search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\nPasses on your turn.\n\nUsage:\n  pass\n\nWhen in a fight, you can use this command to end your turn early, even\nif there are still any actions you can take.\n'}
diff --git a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html index 6a90c6de2e..5dca06a02d 100644 --- a/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html +++ b/docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html @@ -426,7 +426,7 @@ if there are still any actions you can take.

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

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

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

-search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\nPasses on your turn.\n\nUsage:\n  pass\n\nWhen in a fight, you can use this command to end your turn early, even\nif there are still any actions you can take.\n'}
+search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\nPasses on your turn.\n\nUsage:\n  pass\n\nWhen in a fight, you can use this command to end your turn early, even\nif there are still any actions you can take.\n'}
diff --git a/docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html b/docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html index 939df047bb..e8ac9be00b 100644 --- a/docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html +++ b/docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html @@ -370,7 +370,7 @@ there is no room above/below you, your movement will fail.

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

-search_index_entry = {'aliases': 'fly dive', 'category': 'general', 'key': 'fly or dive', 'no_prefix': ' fly dive', 'tags': '', 'text': '\nFly or Dive up and down.\n\nUsage:\n  fly\n  dive\n\nWill fly up one room or dive down one room at your current position. If\nthere is no room above/below you, your movement will fail.\n\n'}
+search_index_entry = {'aliases': 'dive fly', 'category': 'general', 'key': 'fly or dive', 'no_prefix': ' dive fly', 'tags': '', 'text': '\nFly or Dive up and down.\n\nUsage:\n  fly\n  dive\n\nWill fly up one room or dive down one room at your current position. If\nthere is no room above/below you, your movement will fail.\n\n'}
diff --git a/docs/latest/api/evennia.contrib.rpg.dice.dice.html b/docs/latest/api/evennia.contrib.rpg.dice.dice.html index e3b05d0851..06326fad3f 100644 --- a/docs/latest/api/evennia.contrib.rpg.dice.dice.html +++ b/docs/latest/api/evennia.contrib.rpg.dice.dice.html @@ -265,7 +265,7 @@ everyone but the person rolling.

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

-search_index_entry = {'aliases': '@dice roll', 'category': 'general', 'key': 'dice', 'no_prefix': ' dice roll', 'tags': '', 'text': "\nroll dice\n\nUsage:\n  dice[/switch] <nr>d<sides> [modifier] [success condition]\n\nSwitch:\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\nExamples:\n  dice 3d6 + 4\n  dice 1d100 - 2 < 50\n\nThis will roll the given number of dice with given sides and modifiers.\nSo e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\nthen add 3 to the total'.\nAccepted modifiers are +, -, * and /.\nA success condition is given as normal Python conditionals\n(<,>,<=,>=,==,!=). So e.g. 2d6 + 3 > 10 means that the roll will succeed\nonly if the final result is above 8. If a success condition is given, the\noutcome (pass/fail) will be echoed along with how much it succeeded/failed\nwith. The hidden/secret switches will hide all or parts of the roll from\neveryone but the person rolling.\n"}
+search_index_entry = {'aliases': 'roll @dice', 'category': 'general', 'key': 'dice', 'no_prefix': ' roll dice', 'tags': '', 'text': "\nroll dice\n\nUsage:\n  dice[/switch] <nr>d<sides> [modifier] [success condition]\n\nSwitch:\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\nExamples:\n  dice 3d6 + 4\n  dice 1d100 - 2 < 50\n\nThis will roll the given number of dice with given sides and modifiers.\nSo e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\nthen add 3 to the total'.\nAccepted modifiers are +, -, * and /.\nA success condition is given as normal Python conditionals\n(<,>,<=,>=,==,!=). So e.g. 2d6 + 3 > 10 means that the roll will succeed\nonly if the final result is above 8. If a success condition is given, the\noutcome (pass/fail) will be echoed along with how much it succeeded/failed\nwith. The hidden/secret switches will hide all or parts of the roll from\neveryone but the person rolling.\n"}
diff --git a/docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html b/docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html index d2c08aca49..194c45cd52 100644 --- a/docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html +++ b/docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html @@ -670,7 +670,7 @@ commands the caller can use.

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

-search_index_entry = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\nspeak as your character\n\nUsage:\n  say <message>\n\nTalk to those in your current location.\n'}
+search_index_entry = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\nspeak as your character\n\nUsage:\n  say <message>\n\nTalk to those in your current location.\n'}
diff --git a/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html b/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html index 797590cde2..0837acef5a 100644 --- a/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html +++ b/docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html @@ -414,7 +414,7 @@ turn of combat, performing everyone’s actions in random order.

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

-search_index_entry = {'aliases': 'turnbased combat hit', 'category': 'general', 'key': 'attack', 'no_prefix': ' turnbased combat hit', 'tags': '', 'text': '\nStart or join combat.\n\nUsage:\n  attack [<target>]\n\n'}
+search_index_entry = {'aliases': 'hit turnbased combat', 'category': 'general', 'key': 'attack', 'no_prefix': ' hit turnbased combat', 'tags': '', 'text': '\nStart or join combat.\n\nUsage:\n  attack [<target>]\n\n'}
diff --git a/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html b/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html index 28a2cd87a2..3a00704d98 100644 --- a/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html +++ b/docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html @@ -140,7 +140,7 @@ self.args).

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

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

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

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

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

-search_index_entry = {'aliases': 'press button press push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button press push', 'tags': '', 'text': '\nPush the red button (lid closed)\n\nUsage:\n  push button\n\n'}
+search_index_entry = {'aliases': 'push press press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' push press press button', 'tags': '', 'text': '\nPush the red button (lid closed)\n\nUsage:\n  push button\n\n'}
@@ -320,7 +320,7 @@ be mutually exclusive.

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

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

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

-search_index_entry = {'aliases': 'get listen examine l ex feel', 'category': 'general', 'key': 'look', 'no_prefix': ' get listen examine l ex feel', 'tags': '', 'text': "\nLooking around in darkness\n\nUsage:\n  look <obj>\n\n... not that there's much to see in the dark.\n\n"}
+search_index_entry = {'aliases': 'get ex l feel examine listen', 'category': 'general', 'key': 'look', 'no_prefix': ' get ex l feel examine listen', 'tags': '', 'text': "\nLooking around in darkness\n\nUsage:\n  look <obj>\n\n... not that there's much to see in the dark.\n\n"}
diff --git a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html index 4d39e48372..26f240365c 100644 --- a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html +++ b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html @@ -504,7 +504,7 @@ shift green root up/down

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

-search_index_entry = {'aliases': 'pull move push shiftroot', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' pull move push shiftroot', 'tags': '', 'text': '\nShifts roots around.\n\nUsage:\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': 'push move shiftroot pull', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' push move shiftroot pull', 'tags': '', 'text': '\nShifts roots around.\n\nUsage:\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'}
@@ -557,7 +557,7 @@ yellow/green - horizontal roots

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

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

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

-search_index_entry = {'aliases': 'stab parry bash thrust hit slash kill fight chop pierce defend', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' stab parry bash thrust hit slash kill fight chop pierce defend', 'tags': '', 'text': '\nAttack the enemy. Commands:\n\n  stab <enemy>\n  slash <enemy>\n  parry\n\nstab - (thrust) makes a lot of damage but is harder to hit with.\nslash - is easier to land, but does not make as much damage.\nparry - forgoes your attack but will make you harder to hit on next\n        enemy attack.\n\n'}
+search_index_entry = {'aliases': 'slash defend pierce kill parry fight hit thrust chop stab bash', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' slash defend pierce kill parry fight hit thrust chop stab bash', 'tags': '', 'text': '\nAttack the enemy. Commands:\n\n  stab <enemy>\n  slash <enemy>\n  parry\n\nstab - (thrust) makes a lot of damage but is harder to hit with.\nslash - is easier to land, but does not make as much damage.\nparry - forgoes your attack but will make you harder to hit on next\n        enemy attack.\n\n'}
diff --git a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html index 914215dc02..93c768f1da 100644 --- a/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html +++ b/docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html @@ -766,7 +766,7 @@ if they fall off the bridge.

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

-search_index_entry = {'aliases': 'h ?', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\nOverwritten help command while on the bridge.\n'}
+search_index_entry = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\nOverwritten help command while on the bridge.\n'}
diff --git a/docs/latest/api/evennia.utils.eveditor.html b/docs/latest/api/evennia.utils.eveditor.html index dd17ea852d..197d285b64 100644 --- a/docs/latest/api/evennia.utils.eveditor.html +++ b/docs/latest/api/evennia.utils.eveditor.html @@ -290,7 +290,7 @@ indentation.

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

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

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

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

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

-search_index_entry = {'aliases': 'top a quit previous abort p e next t end n q', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' top a quit previous abort p e next t end n q', 'tags': '', 'text': '\nManipulate the text paging. Catch no-input with aliases.\n'}
+search_index_entry = {'aliases': 'p a next quit abort t top q n e end previous', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' p a next quit abort t top q n e end previous', 'tags': '', 'text': '\nManipulate the text paging. Catch no-input with aliases.\n'}