From 478c0b6473146160d10ac993357f82873ab07855 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Mon, 3 Oct 2022 17:53:07 +0000 Subject: [PATCH] Updated HTML docs --- docs/0.9.5/.buildinfo | 2 +- docs/0.9.5/Default-Commands.html | 28 +- docs/0.9.5/_sources/Default-Commands.md.txt | 28 +- .../api/evennia.commands.default.account.html | 2 +- .../evennia.commands.default.building.html | 6 +- .../api/evennia.commands.default.comms.html | 6 +- .../api/evennia.commands.default.general.html | 4 +- .../api/evennia.commands.default.system.html | 6 +- .../evennia.commands.default.unloggedin.html | 4 +- docs/0.9.5/api/evennia.contrib.chargen.html | 2 +- .../api/evennia.contrib.email_login.html | 4 +- ...vennia.contrib.ingame_python.commands.html | 2 +- docs/0.9.5/api/evennia.contrib.rpsystem.html | 2 +- ...b.tutorial_examples.cmdset_red_button.html | 4 +- ...vennia.contrib.tutorial_world.objects.html | 8 +- .../evennia.contrib.tutorial_world.rooms.html | 4 +- docs/0.9.5/api/evennia.utils.eveditor.html | 2 +- docs/0.9.5/api/evennia.utils.evmore.html | 2 +- docs/1.0-dev/.buildinfo | 2 +- docs/1.0-dev/Contribs/Contribs-Overview.html | 2 +- .../ingame_map_display.html | 428 ++++++++++++++++++ .../evadventure/tests/test_chargen.html | 169 +++++++ docs/1.0-dev/_modules/index.html | 2 + ...game_map_display.ingame_map_display.md.txt | 10 + ...nia.contrib.grid.ingame_map_display.md.txt | 18 + ...ntrib.grid.ingame_map_display.tests.md.txt | 10 + .../_sources/api/evennia.contrib.grid.md.txt | 1 + ...contrib.tutorials.evadventure.tests.md.txt | 1 + ...ials.evadventure.tests.test_chargen.md.txt | 10 + docs/1.0-dev/api/evennia-api.html | 6 + .../api/evennia.commands.default.account.html | 4 +- .../evennia.commands.default.building.html | 4 +- .../api/evennia.commands.default.general.html | 16 +- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 8 +- ....base_systems.email_login.email_login.html | 8 +- ...b.base_systems.ingame_python.commands.html | 4 +- ...rib.full_systems.evscaperoom.commands.html | 24 +- ...ontrib.game_systems.clothing.clothing.html | 4 +- ...trib.game_systems.turnbattle.tb_basic.html | 4 +- ...trib.game_systems.turnbattle.tb_equip.html | 4 +- ...trib.game_systems.turnbattle.tb_items.html | 4 +- ...trib.game_systems.turnbattle.tb_magic.html | 4 +- ...trib.game_systems.turnbattle.tb_range.html | 4 +- ...trib.grid.extended_room.extended_room.html | 4 +- ...nnia.contrib.grid.extended_room.tests.html | 10 +- docs/1.0-dev/api/evennia.contrib.grid.html | 5 + ...ennia.contrib.grid.ingame_map_display.html | 148 ++++++ ...ingame_map_display.ingame_map_display.html | 413 +++++++++++++++++ ...contrib.grid.ingame_map_display.tests.html | 143 ++++++ .../api/evennia.contrib.grid.mapbuilder.html | 10 +- docs/1.0-dev/api/evennia.contrib.html | 6 + .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...evennia.contrib.rpg.rpsystem.rpsystem.html | 4 +- ...ontrib.tutorials.evadventure.commands.html | 4 +- ...evennia.contrib.tutorials.evadventure.html | 1 + ...a.contrib.tutorials.evadventure.tests.html | 1 + ...als.evadventure.tests.test_characters.html | 10 +- ...orials.evadventure.tests.test_chargen.html | 174 +++++++ ...torials.evadventure.tests.test_combat.html | 10 +- .../api/evennia.contrib.tutorials.html | 1 + ...ntrib.tutorials.red_button.red_button.html | 16 +- ...trib.tutorials.tutorial_world.objects.html | 12 +- ...ontrib.tutorials.tutorial_world.rooms.html | 8 +- docs/1.0-dev/api/evennia.html | 6 + docs/1.0-dev/api/evennia.utils.eveditor.html | 4 +- docs/1.0-dev/api/evennia.utils.evmenu.html | 4 +- docs/1.0-dev/api/evennia.utils.evmore.html | 4 +- docs/1.0-dev/genindex.html | 101 ++++- docs/1.0-dev/objects.inv | Bin 156003 -> 156405 bytes docs/1.0-dev/py-modindex.html | 15 + docs/1.0-dev/searchindex.js | 2 +- 72 files changed, 1820 insertions(+), 169 deletions(-) create mode 100644 docs/1.0-dev/_modules/evennia/contrib/grid/ingame_map_display/ingame_map_display.html create mode 100644 docs/1.0-dev/_modules/evennia/contrib/tutorials/evadventure/tests/test_chargen.html create mode 100644 docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.ingame_map_display.md.txt create mode 100644 docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.md.txt create mode 100644 docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.tests.md.txt create mode 100644 docs/1.0-dev/_sources/api/evennia.contrib.tutorials.evadventure.tests.test_chargen.md.txt create mode 100644 docs/1.0-dev/api/evennia.contrib.grid.ingame_map_display.html create mode 100644 docs/1.0-dev/api/evennia.contrib.grid.ingame_map_display.ingame_map_display.html create mode 100644 docs/1.0-dev/api/evennia.contrib.grid.ingame_map_display.tests.html create mode 100644 docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.tests.test_chargen.html diff --git a/docs/0.9.5/.buildinfo b/docs/0.9.5/.buildinfo index 673d51a327..b744e3519f 100644 --- a/docs/0.9.5/.buildinfo +++ b/docs/0.9.5/.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: feecbf6fb468648c8c58f4d014937fc6 +config: 3af820173b2891ecb000a81806e22587 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/0.9.5/Default-Commands.html b/docs/0.9.5/Default-Commands.html index 48dfa0cb7c..78d5d6de2e 100644 --- a/docs/0.9.5/Default-Commands.html +++ b/docs/0.9.5/Default-Commands.html @@ -55,9 +55,9 @@ with

  • __unloggedin_look_command [look, l] (cmdset: UnloggedinCmdSet, help-category: General)

  • about [version] (cmdset: CharacterCmdSet, help-category: System)

    • -

  • access [groups, hierarchy] (cmdset: CharacterCmdSet, help-category: General)

    • -

  • accounts [account, listaccounts] (cmdset: CharacterCmdSet, help-category: System)

    • -

  • addcom [aliaschan, chanalias] (cmdset: AccountCmdSet, help-category: Comms)

    • +

  • access [hierarchy, groups] (cmdset: CharacterCmdSet, help-category: General)

    • +

  • accounts [listaccounts, account] (cmdset: CharacterCmdSet, help-category: System)

    • +

  • addcom [chanalias, aliaschan] (cmdset: AccountCmdSet, help-category: Comms)

  • alias [setobjalias] (cmdset: CharacterCmdSet, help-category: Building)

  • allcom (cmdset: AccountCmdSet, help-category: Comms)

  • batchcode [batchcodes] (cmdset: CharacterCmdSet, help-category: Building)

    • @@ -67,7 +67,7 @@ with cdesc (cmdset: AccountCmdSet, help-category: Comms)

  • cdestroy (cmdset: AccountCmdSet, help-category: Comms)

  • cemit [cmsg] (cmdset: AccountCmdSet, help-category: Comms)

    • -

  • channels [all channels, chanlist, clist, channellist, comlist] (cmdset: AccountCmdSet, help-category: Comms)

    • +

  • channels [clist, comlist, chanlist, all channels, channellist] (cmdset: AccountCmdSet, help-category: Comms)

  • charcreate (cmdset: AccountCmdSet, help-category: General)

  • chardelete (cmdset: AccountCmdSet, help-category: General)

  • clock (cmdset: AccountCmdSet, help-category: Comms)

    • @@ -77,21 +77,21 @@ with copy (cmdset: CharacterCmdSet, help-category: Building)

  • cpattr (cmdset: CharacterCmdSet, help-category: Building)

  • create (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • create [cre, cr] (cmdset: UnloggedinCmdSet, help-category: General)

    • +

  • create [cr, cre] (cmdset: UnloggedinCmdSet, help-category: General)

  • cwho (cmdset: AccountCmdSet, help-category: Comms)

    • -

  • delcom [delchanalias, delaliaschan] (cmdset: AccountCmdSet, help-category: Comms)

    • +

  • delcom [delaliaschan, delchanalias] (cmdset: AccountCmdSet, help-category: Comms)

  • desc [describe] (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • destroy [del, delete] (cmdset: CharacterCmdSet, help-category: Building)

    • +

  • destroy [delete, del] (cmdset: CharacterCmdSet, help-category: Building)

  • dig (cmdset: CharacterCmdSet, help-category: Building)

  • drop (cmdset: CharacterCmdSet, help-category: General)

  • encoding [encode] (cmdset: UnloggedinCmdSet, help-category: General)

    • -

  • examine [exam, ex] (cmdset: AccountCmdSet, help-category: Building)

    • +

  • examine [ex, exam] (cmdset: AccountCmdSet, help-category: Building)

  • find [locate, search] (cmdset: CharacterCmdSet, help-category: Building)

  • get [grab] (cmdset: CharacterCmdSet, help-category: General)

  • give (cmdset: CharacterCmdSet, help-category: General)

  • grapevine2chan (cmdset: AccountCmdSet, help-category: Comms)

  • help [?] (cmdset: AccountCmdSet, help-category: General)

    • -

  • help [?, h] (cmdset: UnloggedinCmdSet, help-category: General)

    • +

  • help [h, ?] (cmdset: UnloggedinCmdSet, help-category: General)

  • home (cmdset: CharacterCmdSet, help-category: General)

  • ic [puppet] (cmdset: AccountCmdSet, help-category: General)

  • info (cmdset: UnloggedinCmdSet, help-category: General)

    • @@ -100,12 +100,12 @@ with ircstatus (cmdset: AccountCmdSet, help-category: Comms)

  • link (cmdset: CharacterCmdSet, help-category: Building)

  • lock [locks] (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • look [ls, l] (cmdset: AccountCmdSet, help-category: General)

    • -

  • look [ls, l] (cmdset: CharacterCmdSet, help-category: General)

    • +

  • look [l, ls] (cmdset: AccountCmdSet, help-category: General)

    • +

  • look [l, ls] (cmdset: CharacterCmdSet, help-category: General)

  • mvattr (cmdset: CharacterCmdSet, help-category: Building)

  • name [rename] (cmdset: CharacterCmdSet, help-category: Building)

  • nick [nickname, nicks] (cmdset: AccountCmdSet, help-category: General)

    • -

  • objects [listobjs, stats, listobjects, db] (cmdset: CharacterCmdSet, help-category: System)

    • +

  • objects [listobjs, stats, db, listobjects] (cmdset: CharacterCmdSet, help-category: System)

  • ooc [unpuppet] (cmdset: AccountCmdSet, help-category: General)

  • open (cmdset: CharacterCmdSet, help-category: Building)

  • option [options] (cmdset: AccountCmdSet, help-category: General)

    • @@ -123,7 +123,7 @@ with screenreader (cmdset: UnloggedinCmdSet, help-category: General)

  • script [addscript] (cmdset: CharacterCmdSet, help-category: Building)

  • scripts [listscripts, globalscript] (cmdset: CharacterCmdSet, help-category: System)

    • -

  • server [serverprocess, serverload] (cmdset: CharacterCmdSet, help-category: System)

    • +

  • server [serverload, serverprocess] (cmdset: CharacterCmdSet, help-category: System)

  • service [services] (cmdset: CharacterCmdSet, help-category: System)

  • sessions (cmdset: SessionCmdSet, help-category: General)

  • set (cmdset: CharacterCmdSet, help-category: Building)

    • @@ -138,7 +138,7 @@ with tickers (cmdset: CharacterCmdSet, help-category: System)

  • time [uptime] (cmdset: CharacterCmdSet, help-category: System)

  • tunnel [tun] (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • typeclass [update, parent, swap, type] (cmdset: CharacterCmdSet, help-category: Building)

    • +

  • typeclass [type, parent, swap, update] (cmdset: CharacterCmdSet, help-category: Building)

  • unlink (cmdset: CharacterCmdSet, help-category: Building)

  • whisper (cmdset: CharacterCmdSet, help-category: General)

  • who [doing] (cmdset: AccountCmdSet, help-category: General)

    • diff --git a/docs/0.9.5/_sources/Default-Commands.md.txt b/docs/0.9.5/_sources/Default-Commands.md.txt index 290cee846e..e153f4d343 100644 --- a/docs/0.9.5/_sources/Default-Commands.md.txt +++ b/docs/0.9.5/_sources/Default-Commands.md.txt @@ -16,9 +16,9 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**__unloggedin_look_command** [look, l]](evennia.commands.default.unloggedin.CmdUnconnectedLook) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**about** [version]](evennia.commands.default.system.CmdAbout) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) -- [**access** [groups, hierarchy]](evennia.commands.default.general.CmdAccess) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) -- [**accounts** [account, listaccounts]](evennia.commands.default.system.CmdAccounts) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) -- [**addcom** [aliaschan, chanalias]](evennia.commands.default.comms.CmdAddCom) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) +- [**access** [hierarchy, groups]](evennia.commands.default.general.CmdAccess) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) +- [**accounts** [listaccounts, account]](evennia.commands.default.system.CmdAccounts) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) +- [**addcom** [chanalias, aliaschan]](evennia.commands.default.comms.CmdAddCom) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**alias** [setobjalias]](evennia.commands.default.building.CmdSetObjAlias) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**allcom**](evennia.commands.default.comms.CmdAllCom) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**batchcode** [batchcodes]](evennia.commands.default.batchprocess.CmdBatchCode) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) @@ -28,7 +28,7 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**cdesc**](evennia.commands.default.comms.CmdCdesc) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**cdestroy**](evennia.commands.default.comms.CmdCdestroy) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**cemit** [cmsg]](evennia.commands.default.comms.CmdCemit) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) -- [**channels** [all channels, chanlist, clist, channellist, comlist]](evennia.commands.default.comms.CmdChannels) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) +- [**channels** [clist, comlist, chanlist, all channels, channellist]](evennia.commands.default.comms.CmdChannels) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**charcreate**](evennia.commands.default.account.CmdCharCreate) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**chardelete**](evennia.commands.default.account.CmdCharDelete) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**clock**](evennia.commands.default.comms.CmdClock) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) @@ -38,21 +38,21 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**copy**](evennia.commands.default.building.CmdCopy) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**cpattr**](evennia.commands.default.building.CmdCpAttr) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**create**](evennia.commands.default.building.CmdCreate) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**create** [cre, cr]](evennia.commands.default.unloggedin.CmdUnconnectedCreate) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) +- [**create** [cr, cre]](evennia.commands.default.unloggedin.CmdUnconnectedCreate) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**cwho**](evennia.commands.default.comms.CmdCWho) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) -- [**delcom** [delchanalias, delaliaschan]](evennia.commands.default.comms.CmdDelCom) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) +- [**delcom** [delaliaschan, delchanalias]](evennia.commands.default.comms.CmdDelCom) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**desc** [describe]](evennia.commands.default.building.CmdDesc) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**destroy** [del, delete]](evennia.commands.default.building.CmdDestroy) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) +- [**destroy** [delete, del]](evennia.commands.default.building.CmdDestroy) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**dig**](evennia.commands.default.building.CmdDig) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**drop**](evennia.commands.default.general.CmdDrop) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**encoding** [encode]](evennia.commands.default.unloggedin.CmdUnconnectedEncoding) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) -- [**examine** [exam, ex]](evennia.commands.default.building.CmdExamine) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Building_) +- [**examine** [ex, exam]](evennia.commands.default.building.CmdExamine) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Building_) - [**find** [locate, search]](evennia.commands.default.building.CmdFind) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**get** [grab]](evennia.commands.default.general.CmdGet) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**give**](evennia.commands.default.general.CmdGive) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**grapevine2chan**](evennia.commands.default.comms.CmdGrapevine2Chan) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**help** [?]](evennia.commands.default.help.CmdHelp) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) -- [**help** [?, h]](evennia.commands.default.unloggedin.CmdUnconnectedHelp) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) +- [**help** [h, ?]](evennia.commands.default.unloggedin.CmdUnconnectedHelp) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**home**](evennia.commands.default.general.CmdHome) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**ic** [puppet]](evennia.commands.default.account.CmdIC) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**info**](evennia.commands.default.unloggedin.CmdUnconnectedInfo) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) @@ -61,12 +61,12 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**ircstatus**](evennia.commands.default.comms.CmdIRCStatus) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**link**](evennia.commands.default.building.CmdLink) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**lock** [locks]](evennia.commands.default.building.CmdLock) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**look** [ls, l]](evennia.commands.default.account.CmdOOCLook) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) -- [**look** [ls, l]](evennia.commands.default.general.CmdLook) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) +- [**look** [l, ls]](evennia.commands.default.account.CmdOOCLook) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) +- [**look** [l, ls]](evennia.commands.default.general.CmdLook) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**mvattr**](evennia.commands.default.building.CmdMvAttr) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**name** [rename]](evennia.commands.default.building.CmdName) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**nick** [nickname, nicks]](evennia.commands.default.general.CmdNick) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) -- [**objects** [listobjs, stats, listobjects, db]](evennia.commands.default.system.CmdObjects) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) +- [**objects** [listobjs, stats, db, listobjects]](evennia.commands.default.system.CmdObjects) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**ooc** [unpuppet]](evennia.commands.default.account.CmdOOC) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**open**](evennia.commands.default.building.CmdOpen) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**option** [options]](evennia.commands.default.account.CmdOption) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) @@ -84,7 +84,7 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**screenreader**](evennia.commands.default.unloggedin.CmdUnconnectedScreenreader) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**script** [addscript]](evennia.commands.default.building.CmdScript) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**scripts** [listscripts, globalscript]](evennia.commands.default.system.CmdScripts) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) -- [**server** [serverprocess, serverload]](evennia.commands.default.system.CmdServerLoad) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) +- [**server** [serverload, serverprocess]](evennia.commands.default.system.CmdServerLoad) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**service** [services]](evennia.commands.default.system.CmdService) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**sessions**](evennia.commands.default.account.CmdSessions) (cmdset: [SessionCmdSet](evennia.commands.default.cmdset_session.SessionCmdSet), help-category: _General_) - [**set**](evennia.commands.default.building.CmdSetAttribute) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) @@ -99,7 +99,7 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**tickers**](evennia.commands.default.system.CmdTickers) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**time** [uptime]](evennia.commands.default.system.CmdTime) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**tunnel** [tun]](evennia.commands.default.building.CmdTunnel) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**typeclass** [update, parent, swap, type]](evennia.commands.default.building.CmdTypeclass) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) +- [**typeclass** [type, parent, swap, update]](evennia.commands.default.building.CmdTypeclass) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**unlink**](evennia.commands.default.building.CmdUnLink) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**whisper**](evennia.commands.default.general.CmdWhisper) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**who** [doing]](evennia.commands.default.account.CmdWho) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) diff --git a/docs/0.9.5/api/evennia.commands.default.account.html b/docs/0.9.5/api/evennia.commands.default.account.html index d998c2f3e5..b0883f258d 100644 --- a/docs/0.9.5/api/evennia.commands.default.account.html +++ b/docs/0.9.5/api/evennia.commands.default.account.html @@ -72,7 +72,7 @@ method. Otherwise all text will be returned to all connected sessions.

    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    diff --git a/docs/0.9.5/api/evennia.commands.default.building.html b/docs/0.9.5/api/evennia.commands.default.building.html index e2ea2cd9dc..2a84edbbb1 100644 --- a/docs/0.9.5/api/evennia.commands.default.building.html +++ b/docs/0.9.5/api/evennia.commands.default.building.html @@ -496,7 +496,7 @@ You can specify the /force switch to bypass this confirmation.

    -aliases = ['del', 'delete']
    +aliases = ['delete', 'del']
    @@ -1186,7 +1186,7 @@ server settings.

    -aliases = ['update', 'parent', 'swap', 'type']
    +aliases = ['type', 'parent', 'swap', 'update']
    @@ -1355,7 +1355,7 @@ If object is not specified, the current location is examined.

    -aliases = ['exam', 'ex']
    +aliases = ['ex', 'exam']
    diff --git a/docs/0.9.5/api/evennia.commands.default.comms.html b/docs/0.9.5/api/evennia.commands.default.comms.html index 81ca1ac74e..485e6ffb3f 100644 --- a/docs/0.9.5/api/evennia.commands.default.comms.html +++ b/docs/0.9.5/api/evennia.commands.default.comms.html @@ -66,7 +66,7 @@ aliases to an already joined channel.

    -aliases = ['aliaschan', 'chanalias']
    +aliases = ['chanalias', 'aliaschan']
    @@ -118,7 +118,7 @@ for that channel.

    -aliases = ['delchanalias', 'delaliaschan']
    +aliases = ['delaliaschan', 'delchanalias']
    @@ -221,7 +221,7 @@ Use addcom/delcom to join and leave channels

    -aliases = ['all channels', 'chanlist', 'clist', 'channellist', 'comlist']
    +aliases = ['clist', 'comlist', 'chanlist', 'all channels', 'channellist']
    diff --git a/docs/0.9.5/api/evennia.commands.default.general.html b/docs/0.9.5/api/evennia.commands.default.general.html index 5eaadb0926..7d32425741 100644 --- a/docs/0.9.5/api/evennia.commands.default.general.html +++ b/docs/0.9.5/api/evennia.commands.default.general.html @@ -109,7 +109,7 @@ look *<account&g
    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    @@ -647,7 +647,7 @@ which permission groups you are a member of.

    -aliases = ['groups', 'hierarchy']
    +aliases = ['hierarchy', 'groups']
    diff --git a/docs/0.9.5/api/evennia.commands.default.system.html b/docs/0.9.5/api/evennia.commands.default.system.html index a9b03d65d5..868e9d6ed4 100644 --- a/docs/0.9.5/api/evennia.commands.default.system.html +++ b/docs/0.9.5/api/evennia.commands.default.system.html @@ -351,7 +351,7 @@ given, <nr> defaults to 10.

    -aliases = ['listobjs', 'stats', 'listobjects', 'db']
    +aliases = ['listobjs', 'stats', 'db', 'listobjects']
    @@ -558,7 +558,7 @@ the released memory will instead be re-used by the program.

    -aliases = ['serverprocess', 'serverload']
    +aliases = ['serverload', 'serverprocess']
    @@ -611,7 +611,7 @@ If not given, <nr> defaults to 10.

    -aliases = ['account', 'listaccounts']
    +aliases = ['listaccounts', 'account']
    diff --git a/docs/0.9.5/api/evennia.commands.default.unloggedin.html b/docs/0.9.5/api/evennia.commands.default.unloggedin.html index 0207566631..62ba845749 100644 --- a/docs/0.9.5/api/evennia.commands.default.unloggedin.html +++ b/docs/0.9.5/api/evennia.commands.default.unloggedin.html @@ -115,7 +115,7 @@ create “account name” “pass word”

    -aliases = ['cre', 'cr']
    +aliases = ['cr', 'cre']
    @@ -254,7 +254,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    diff --git a/docs/0.9.5/api/evennia.contrib.chargen.html b/docs/0.9.5/api/evennia.contrib.chargen.html index e7f84087a5..d12901c845 100644 --- a/docs/0.9.5/api/evennia.contrib.chargen.html +++ b/docs/0.9.5/api/evennia.contrib.chargen.html @@ -79,7 +79,7 @@ at them with this command.

    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    diff --git a/docs/0.9.5/api/evennia.contrib.email_login.html b/docs/0.9.5/api/evennia.contrib.email_login.html index 0253eaf64b..8962dac44c 100644 --- a/docs/0.9.5/api/evennia.contrib.email_login.html +++ b/docs/0.9.5/api/evennia.contrib.email_login.html @@ -123,7 +123,7 @@ there is no object yet before the account has logged in)

    -aliases = ['cre', 'cr']
    +aliases = ['cr', 'cre']
    @@ -252,7 +252,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    diff --git a/docs/0.9.5/api/evennia.contrib.ingame_python.commands.html b/docs/0.9.5/api/evennia.contrib.ingame_python.commands.html index 0af38e6f08..43cb95ffd7 100644 --- a/docs/0.9.5/api/evennia.contrib.ingame_python.commands.html +++ b/docs/0.9.5/api/evennia.contrib.ingame_python.commands.html @@ -54,7 +54,7 @@
    -aliases = ['@callback', '@callbacks', '@calls']
    +aliases = ['@calls', '@callback', '@callbacks']
    diff --git a/docs/0.9.5/api/evennia.contrib.rpsystem.html b/docs/0.9.5/api/evennia.contrib.rpsystem.html index 7efd4eb780..80729fb150 100644 --- a/docs/0.9.5/api/evennia.contrib.rpsystem.html +++ b/docs/0.9.5/api/evennia.contrib.rpsystem.html @@ -775,7 +775,7 @@ Using the command without arguments will list all current recogs.

    -aliases = ['forget', 'recognize']
    +aliases = ['recognize', 'forget']
    diff --git a/docs/0.9.5/api/evennia.contrib.tutorial_examples.cmdset_red_button.html b/docs/0.9.5/api/evennia.contrib.tutorial_examples.cmdset_red_button.html index 76c8d4ad75..583166be95 100644 --- a/docs/0.9.5/api/evennia.contrib.tutorial_examples.cmdset_red_button.html +++ b/docs/0.9.5/api/evennia.contrib.tutorial_examples.cmdset_red_button.html @@ -107,7 +107,7 @@ push the lid of the button away.

    -aliases = ['press button', 'press', 'push']
    +aliases = ['press', 'press button', 'push']
    @@ -284,7 +284,7 @@ of causing the lamp to break.

    -aliases = ['feel', 'get', 'examine', 'l', 'ex', 'listen']
    +aliases = ['listen', 'get', 'feel', 'ex', 'examine', 'l']
    diff --git a/docs/0.9.5/api/evennia.contrib.tutorial_world.objects.html b/docs/0.9.5/api/evennia.contrib.tutorial_world.objects.html index c5f1a9f2de..015d847cab 100644 --- a/docs/0.9.5/api/evennia.contrib.tutorial_world.objects.html +++ b/docs/0.9.5/api/evennia.contrib.tutorial_world.objects.html @@ -353,7 +353,7 @@ of the object. We overload it with our own version.

    -aliases = ['burn', 'light']
    +aliases = ['light', 'burn']
    @@ -479,7 +479,7 @@ shift green root up/down

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

    -aliases = ['press button', 'push button', 'button']
    +aliases = ['push button', 'press button', 'button']
    @@ -692,7 +692,7 @@ parry - forgoes your attack but will make you harder to hit on next

    -aliases = ['slash', 'chop', 'parry', 'fight', 'thrust', 'pierce', 'defend', 'bash', 'hit', 'kill', 'stab']
    +aliases = ['defend', 'parry', 'slash', 'hit', 'bash', 'stab', 'pierce', 'fight', 'thrust', 'kill', 'chop']
    diff --git a/docs/0.9.5/api/evennia.contrib.tutorial_world.rooms.html b/docs/0.9.5/api/evennia.contrib.tutorial_world.rooms.html index db336584a0..564b95732c 100644 --- a/docs/0.9.5/api/evennia.contrib.tutorial_world.rooms.html +++ b/docs/0.9.5/api/evennia.contrib.tutorial_world.rooms.html @@ -675,7 +675,7 @@ if they fall off the bridge.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    @@ -822,7 +822,7 @@ to find something.

    -aliases = ['feel', 'fiddle', 'l', 'feel around', 'search']
    +aliases = ['feel around', 'search', 'feel', 'l', 'fiddle']
    diff --git a/docs/0.9.5/api/evennia.utils.eveditor.html b/docs/0.9.5/api/evennia.utils.eveditor.html index 66765ad7a3..2e8cfd4de7 100644 --- a/docs/0.9.5/api/evennia.utils.eveditor.html +++ b/docs/0.9.5/api/evennia.utils.eveditor.html @@ -267,7 +267,7 @@ indentation.

    -aliases = [':>', ':S', ':<', ':f', ':w', ':wq', ':uu', ':', ':u', ':::', ':A', ':s', ':h', ':=', ':x', ':!', ':y', ':DD', ':q!', ':dd', ':fd', '::', ':UU', ':r', ':i', ':echo', ':I', ':fi', ':p', ':j', ':q', ':dw']
    +aliases = [':dw', ':uu', ':fi', ':u', ':', ':<', ':y', ':dd', ':j', ':f', ':A', ':q', ':h', ':S', ':s', '::', ':w', ':I', ':r', ':=', ':::', ':x', ':DD', ':echo', ':p', ':!', ':q!', ':fd', ':>', ':UU', ':wq', ':i']
    diff --git a/docs/0.9.5/api/evennia.utils.evmore.html b/docs/0.9.5/api/evennia.utils.evmore.html index 222988fc19..d1df618373 100644 --- a/docs/0.9.5/api/evennia.utils.evmore.html +++ b/docs/0.9.5/api/evennia.utils.evmore.html @@ -77,7 +77,7 @@ the caller.msg() construct every time the page is updated.

    -aliases = ['end', 'top', 'abort', 't', 'e', 'back', 'b', 'a', 'next', 'q', 'quit', 'n']
    +aliases = ['next', 'abort', 'e', 'n', 'q', 'top', 'back', 'a', 'b', 'quit', 't', 'end']
    diff --git a/docs/1.0-dev/.buildinfo b/docs/1.0-dev/.buildinfo index ff6fba463f..982993b9a2 100644 --- a/docs/1.0-dev/.buildinfo +++ b/docs/1.0-dev/.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: a80c283e5ab04b0c23fe542729d4352a +config: 8c9f4b59db1258692e62f50298da9a3e tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/1.0-dev/Contribs/Contribs-Overview.html b/docs/1.0-dev/Contribs/Contribs-Overview.html index 5dac34ab70..f9d8a67579 100644 --- a/docs/1.0-dev/Contribs/Contribs-Overview.html +++ b/docs/1.0-dev/Contribs/Contribs-Overview.html @@ -342,7 +342,7 @@ supported by new lo You can easily alter it to add special characters, room colors etc. The map shown is dynamically generated on use, and supports all compass directions and up/down. Other directions are ignored.

    -

    Read the documentation - Browse the Code

    +

    Read the documentation - Browse the Code

    Contrib: mapbuilder

    diff --git a/docs/1.0-dev/_modules/evennia/contrib/grid/ingame_map_display/ingame_map_display.html b/docs/1.0-dev/_modules/evennia/contrib/grid/ingame_map_display/ingame_map_display.html new file mode 100644 index 0000000000..b459d0c22d --- /dev/null +++ b/docs/1.0-dev/_modules/evennia/contrib/grid/ingame_map_display/ingame_map_display.html @@ -0,0 +1,428 @@ + + + + + + + + evennia.contrib.grid.ingame_map_display.ingame_map_display — Evennia 1.0-dev documentation + + + + + + + + + + + + + +
    +
    +
    +
    + +

    Source code for evennia.contrib.grid.ingame_map_display.ingame_map_display

    +"""
+Basic Map - helpme 2022
+
+This adds an ascii `map` to a given room which can be viewed with the `map` command.
+You can easily alter it to add special characters, room colors etc. The map shown is
+dynamically generated on use, and supports all compass directions and up/down. Other
+directions are ignored.
+
+If you don't expect the map to be updated frequently, you could choose to save the
+calculated map as a .ndb value on the room and render that instead of running mapping
+calculations anew each time.
+
+An example map:
+```
+       |
+     -[-]-
+       |
+       |
+-[-]--[-]--[-]--[-]
+  |    |    |    |
+       |    |    |
+     -[-]--[-]  [-]
+       | \/ |    |
+     \ | /\ |
+     -[-]--[-]
+```
+
+Installation:
+
+Adding the `MapDisplayCmdSet` to the default character cmdset will add the `map` command.
+
+Specifically, in `mygame/commands/default_cmdsets.py`:
+
+```
+...
+from evennia.contrib.grid.ingame_map_display import MapDisplayCmdSet  # <---
+
+class CharacterCmdset(default_cmds.Character_CmdSet):
+    ...
+    def at_cmdset_creation(self):
+        ...
+        self.add(MapDisplayCmdSet)  # <---
+
+```
+
+Then `reload` to make the new commands available.
+
+Additional Settings:
+
+In order to change your default map size, you can add to `mygame/server/settings.py`:
+
+BASIC_MAP_SIZE = 5
+
+This changes the default map width/height. 2-5 for most clients is sensible.
+
+If you don't want the player to be able to specify the size of the map, ignore any
+arguments passed into the Map command.
+"""
+import time
+from django.conf import settings
+from evennia import CmdSet
+from evennia.commands.default.muxcommand import MuxCommand
+
+_BASIC_MAP_SIZE = settings.BASIC_MAP_SIZE if hasattr(settings, 'BASIC_MAP_SIZE') else 2
+_MAX_MAP_SIZE = settings.BASIC_MAP_SIZE if hasattr(settings, 'MAX_MAP_SIZE') else 10
+
+# _COMPASS_DIRECTIONS specifies which way to move the pointer on the x/y axes and what characters to use to depict the exits on the map.
+_COMPASS_DIRECTIONS = {
+    'north': (0, -3, ' | '),
+    'south': (0, 3, ' | '),
+    'east': (3, 0, '-'),
+    'west': (-3, 0, '-'),
+    'northeast': (3, -3, '/'),
+    'northwest': (-3, -3, '\\'),
+    'southeast': (3, 3, '\\'),
+    'southwest': (-3, 3, '/'),
+    'up': (0, 0, '^'),
+    'down': (0, 0, 'v')
+}
+
+
+
    [docs]class Map(object):
+
    [docs]    def __init__(self, caller, size=_BASIC_MAP_SIZE, location=None):
+        """
+        Initializes the map.
+
+        Args:
+            caller (object): Any object, though generally a puppeted character.
+            size (int): The seed size of the map, which will be multiplied to get the final grid size.
+            location (object): The location at the map's center (will default to caller.location if none provided).
+        """
+        self.start_time = time.time()
+        self.caller = caller
+        self.max_width = int(size * 2 + 1) * 5   # This must be an odd number
+        self.max_length = int(size * 2 + 1) * 3  # This must be an odd number
+        self.has_mapped = {}
+        self.curX = None
+        self.curY = None
+        self.size = size
+        self.location = location or caller.location
    
+
+
    [docs]    def create_grid(self):
+        """
+        Create the empty grid for the map based on the configured size
+
+        Returns:
+            list: The created grid, a list of lists.
+        """
+        board = []
+        for row in range(self.max_length):
+            board.append([])
+            for column in range(int(self.max_width/5)):
+                board[row].extend([' ', '   ', ' '])
+        return board
    
+
+
    [docs]    def exit_name_as_ordinal(self, ex):
+        """
+        Get the exit name as a compass direction if possible
+
+        Args:
+            ex (Exit): The current exit being mapped.
+        Returns:
+            string: The exit name as a compass direction or an empty string.
+        """
+        exit_name = ex.name
+        if exit_name not in _COMPASS_DIRECTIONS:
+            compass_aliases = [direction in ex.aliases.all() for direction in _COMPASS_DIRECTIONS.keys()]
+            if compass_aliases[0]:
+                exit_name = compass_aliases[0]
+            if exit_name not in _COMPASS_DIRECTIONS:
+                return ''
+        return exit_name
    
+
+
    [docs]    def update_pos(self, room, exit_name):
+        """
+        Update the position pointer.
+
+        Args:
+            room (Room): The current location.
+            exit_name (str): The name of the exit to to use in this room. This must
+                be a valid compass direction, or an error will be raised.
+        Raises:
+            KeyError: If providing a non-compass exit name.
+        """
+        # Update the pointer
+        self.curX, self.curY = self.has_mapped[room][0], self.has_mapped[room][1]
+
+        # Move the pointer depending on which direction the exit lies
+        # exit_name has already been validated as an ordinal direction at this point
+        self.curY += _COMPASS_DIRECTIONS[exit_name][0]
+        self.curX += _COMPASS_DIRECTIONS[exit_name][1]
    
+
+
    [docs]    def has_drawn(self, room):
+        """
+        Checks if the given room has already been drawn or not
+
+        Args:
+            room (Room): Room to check.
+        Returns:
+            bool: Whether or not the room has been drawn.
+        """
+        return True if room in self.has_mapped.keys() else False
    
+
+
    [docs]    def draw_room_on_map(self, room, max_distance):
+        """
+        Draw the room and its exits on the map recursively
+
+        Args:
+            room (Room): The room to draw out.
+            max_distance (int): How extensive the map is.
+        """
+        self.draw(room)
+        self.draw_exits(room)
+
+        if max_distance == 0:
+            return
+
+        # Check if the caller has access to the room in question. If not, don't draw it.
+        # Additionally, if the name of the exit is not ordinal but an alias of it is, use that.
+        for ex in [x for x in room.exits if x.access(self.caller, "traverse")]:
+            ex_name = self.exit_name_as_ordinal(ex)
+            if not ex_name or ex_name in ['up', 'down']:
+                continue
+            if self.has_drawn(ex.destination):
+                continue
+
+            self.update_pos(room, ex_name.lower())
+            self.draw_room_on_map(ex.destination, max_distance - 1)
    
+
+
    [docs]    def draw_exits(self, room):
+        """
+        Draw a given room's exit paths
+
+        Args:
+            room (Room): The room to draw exits of.
+        """
+        x, y = self.curX, self.curY
+        for ex in room.exits:
+            ex_name = self.exit_name_as_ordinal(ex)
+            if not ex_name:
+                continue
+
+            ex_character = _COMPASS_DIRECTIONS[ex_name][2]
+            delta_x = int(_COMPASS_DIRECTIONS[ex_name][1]/3)
+            delta_y = int(_COMPASS_DIRECTIONS[ex_name][0]/3)
+
+            # Make modifications if the exit has BOTH up and down exits
+            if ex_name == 'up':
+                if 'v' in self.grid[x][y]:
+                    self.render_room(room, x, y, p1='^', p2='v')
+                else:
+                    self.render_room(room, x, y, here='^')
+            elif ex_name == 'down':
+                if '^' in self.grid[x][y]:
+                    self.render_room(room, x, y, p1='^', p2='v')
+                else:
+                    self.render_room(room, x, y, here='v')
+            else:
+                self.grid[x + delta_x][y + delta_y] = ex_character
    
+
+
    [docs]    def draw(self, room):
+        """
+        Draw the map starting from a given room and add it to the cache of mapped rooms
+
+        Args:
+            room (Room): The room to render.
+        """
+        # draw initial caller location on map first!
+        if room == self.location:
+            self.start_loc_on_grid(room)
+            self.has_mapped[room] = [self.curX, self.curY]
+        else:
+            # map all other rooms
+            self.has_mapped[room] = [self.curX, self.curY]
+            self.render_room(room, self.curX, self.curY)
    
+
+
    [docs]    def render_room(self, room, x, y, p1='[', p2=']', here=None):
+        """
+        Draw a given room with ascii characters
+
+        Args:
+            room (Room): The room to render.
+            x (int): The x-value of the room on the grid (horizontally, east/west).
+            y (int): The y-value of the room on the grid (vertically, north/south).
+            p1 (str): The first character of the 3-character room depiction.
+            p2 (str): The last character of the 3-character room depiction.
+            here (str): Defaults to none, a special character depicting the room.
+        """
+        # Note: This is where you would set colors, symbols etc.
+        # Render the room
+        you = list("[ ]")
+
+        you[0] = f"{p1}|n"
+        you[1] = f"{here if here else you[1]}"
+        if room == self.caller.location:
+            you[1] = '|[x|co|n'  # Highlight the location you are currently in
+        you[2] = f"{p2}|n"
+
+        self.grid[x][y] = "".join(you)
    
+
+
    [docs]    def start_loc_on_grid(self, room):
+        """
+        Set the starting location on the grid based on the maximum width and length
+
+        Args:
+            room (Room): The room to begin with.
+        """
+        x = int((self.max_width * 0.6 - 1) / 2)
+        y = int((self.max_length - 1) / 2)
+
+        self.render_room(room, x, y)
+        self.curX, self.curY = x, y
    
+
+
    [docs]    def show_map(self, debug=False):
+        """
+        Create and show the map, piecing it all together in the end
+
+        Args:
+            debug (bool): Whether or not to return the time taken to build the map.
+        """
+        map_string = ""
+        self.grid = self.create_grid()
+        self.draw_room_on_map(self.location, self.size)
+
+        for row in self.grid:
+            map_row = "".join(row)
+            if map_row.strip() != "":
+                map_string += f"{map_row}\n"
+
+        elapsed = time.time() - self.start_time
+        if debug:
+            map_string += f"\nTook {elapsed}ms to render the map.\n"
+
+        return "%s" % map_string
    
+
+
+
    [docs]class CmdMap(MuxCommand):
+    """
+    Check the local map around you.
+
+    Usage: map (optional size)
+    """
+    key = "map"
+
+
    [docs]    def func(self):
+        size = _BASIC_MAP_SIZE
+        max_size = _MAX_MAP_SIZE
+        if self.args.isnumeric():
+            size = min(max_size, int(self.args))
+
+        # You can run show_map(debug=True) to see how long it takes.
+        map_here = Map(self.caller, size=size).show_map()
+        self.caller.msg((map_here, {"type": "map"}))
    
+
+
+# CmdSet for easily install all commands
+
    [docs]class MapDisplayCmdSet(CmdSet):
+    """
+    The map command.
+    """
+
+
    [docs]    def at_cmdset_creation(self):
+        self.add(CmdMap)
    
+
    + +
    +
    +
    +
    + +
    +
    + + + + \ No newline at end of file diff --git a/docs/1.0-dev/_modules/evennia/contrib/tutorials/evadventure/tests/test_chargen.html b/docs/1.0-dev/_modules/evennia/contrib/tutorials/evadventure/tests/test_chargen.html new file mode 100644 index 0000000000..36261d280a --- /dev/null +++ b/docs/1.0-dev/_modules/evennia/contrib/tutorials/evadventure/tests/test_chargen.html @@ -0,0 +1,169 @@ + + + + + + + + evennia.contrib.tutorials.evadventure.tests.test_chargen — Evennia 1.0-dev documentation + + + + + + + + + + + + + +
    +
    +
    +
    + +

    Source code for evennia.contrib.tutorials.evadventure.tests.test_chargen

    +"""
+Test chargen.
+
+"""
+
+from unittest.mock import MagicMock, patch
+
+from evennia import create_object
+from evennia.utils.test_resources import BaseEvenniaTest
+from parameterized import parameterized
+
+from .. import chargen, enums, objects
+
+
+
    [docs]class EvAdventureCharacterGenerationTest(BaseEvenniaTest):
+    """
+    Test the Character generator in the rule engine.
+
+    """
+
+
    [docs]    @patch("evennia.contrib.tutorials.evadventure.rules.randint")
+    def setUp(self, mock_randint):
+        super().setUp()
+        mock_randint.return_value = 10
+        self.chargen = chargen.TemporaryCharacterSheet()
    
+
+
    [docs]    def test_base_chargen(self):
+        self.assertEqual(self.chargen.strength, 10)  # not realistic, due to mock
+        self.assertEqual(self.chargen.armor, "gambeson")
+        self.assertEqual(self.chargen.shield, "shield")
+        self.assertEqual(
+            self.chargen.backpack, ["ration", "ration", "waterskin", "waterskin", "drill", "twine"]
+        )
    
+
+
    [docs]    def test_build_desc(self):
+        self.assertEqual(
+            self.chargen.desc,
+            "You are scrawny with a broken face, pockmarked skin, greased hair, hoarse speech, and "
+            "stained clothing. You were a Herbalist, but you were exiled and ended up a knave. You "
+            "are honest but also irascible. You tend towards neutrality.",
+        )
    
+
+
    [docs]    @patch("evennia.contrib.tutorials.evadventure.chargen.spawn")
+    def test_apply(self, mock_spawn):
+
+        gambeson = create_object(objects.EvAdventureArmor, key="gambeson")
+        mock_spawn.return_value = gambeson
+
+        character = self.chargen.apply()
+
+        self.assertIn("Herbalist", character.db.desc)
+        self.assertEqual(
+            character.equipment.all(),
+            [
+                (None, enums.WieldLocation.WEAPON_HAND),
+                (None, enums.WieldLocation.SHIELD_HAND),
+                (None, enums.WieldLocation.TWO_HANDS),
+                (gambeson, enums.WieldLocation.BODY),
+                (None, enums.WieldLocation.HEAD),
+            ],
+        )
+
+        gambeson.delete()
+        character.delete()
    
+
    + +
    +
    +
    +
    + +
    +
    + + + + \ No newline at end of file diff --git a/docs/1.0-dev/_modules/index.html b/docs/1.0-dev/_modules/index.html index 7be8b1cd57..6f0c32f152 100644 --- a/docs/1.0-dev/_modules/index.html +++ b/docs/1.0-dev/_modules/index.html @@ -130,6 +130,7 @@
  • evennia.contrib.game_systems.turnbattle.tests
  • evennia.contrib.grid.extended_room.extended_room
  • evennia.contrib.grid.extended_room.tests
    • +
  • evennia.contrib.grid.ingame_map_display.ingame_map_display
  • evennia.contrib.grid.simpledoor.simpledoor
  • evennia.contrib.grid.simpledoor.tests
  • evennia.contrib.grid.slow_exit.slow_exit
    • @@ -174,6 +175,7 @@
  • evennia.contrib.tutorials.evadventure.shops
  • evennia.contrib.tutorials.evadventure.tests.mixins
  • evennia.contrib.tutorials.evadventure.tests.test_characters
    • +
  • evennia.contrib.tutorials.evadventure.tests.test_chargen
  • evennia.contrib.tutorials.evadventure.tests.test_combat
  • evennia.contrib.tutorials.evadventure.tests.test_commands
  • evennia.contrib.tutorials.evadventure.tests.test_dungeon
    • diff --git a/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.ingame_map_display.md.txt b/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.ingame_map_display.md.txt new file mode 100644 index 0000000000..24af76bca2 --- /dev/null +++ b/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.ingame_map_display.md.txt @@ -0,0 +1,10 @@ +```{eval-rst} +evennia.contrib.grid.ingame\_map\_display.ingame\_map\_display +===================================================================== + +.. automodule:: evennia.contrib.grid.ingame_map_display.ingame_map_display + :members: + :undoc-members: + :show-inheritance: + +``` \ No newline at end of file diff --git a/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.md.txt b/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.md.txt new file mode 100644 index 0000000000..d90d389c2c --- /dev/null +++ b/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.md.txt @@ -0,0 +1,18 @@ +```{eval-rst} +evennia.contrib.grid.ingame\_map\_display +================================================= + +.. automodule:: evennia.contrib.grid.ingame_map_display + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.grid.ingame_map_display.ingame_map_display + evennia.contrib.grid.ingame_map_display.tests + +``` \ No newline at end of file diff --git a/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.tests.md.txt b/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.tests.md.txt new file mode 100644 index 0000000000..f301581fc4 --- /dev/null +++ b/docs/1.0-dev/_sources/api/evennia.contrib.grid.ingame_map_display.tests.md.txt @@ -0,0 +1,10 @@ +```{eval-rst} +evennia.contrib.grid.ingame\_map\_display.tests +====================================================== + +.. automodule:: evennia.contrib.grid.ingame_map_display.tests + :members: + :undoc-members: + :show-inheritance: + +``` \ No newline at end of file diff --git a/docs/1.0-dev/_sources/api/evennia.contrib.grid.md.txt b/docs/1.0-dev/_sources/api/evennia.contrib.grid.md.txt index 2000a6de80..a0bab4c7fc 100644 --- a/docs/1.0-dev/_sources/api/evennia.contrib.grid.md.txt +++ b/docs/1.0-dev/_sources/api/evennia.contrib.grid.md.txt @@ -12,6 +12,7 @@ evennia.contrib.grid :maxdepth: 6 evennia.contrib.grid.extended_room + evennia.contrib.grid.ingame_map_display evennia.contrib.grid.mapbuilder evennia.contrib.grid.simpledoor evennia.contrib.grid.slow_exit diff --git a/docs/1.0-dev/_sources/api/evennia.contrib.tutorials.evadventure.tests.md.txt b/docs/1.0-dev/_sources/api/evennia.contrib.tutorials.evadventure.tests.md.txt index 7521957b62..3507cac214 100644 --- a/docs/1.0-dev/_sources/api/evennia.contrib.tutorials.evadventure.tests.md.txt +++ b/docs/1.0-dev/_sources/api/evennia.contrib.tutorials.evadventure.tests.md.txt @@ -14,6 +14,7 @@ evennia.contrib.tutorials.evadventure.tests evennia.contrib.tutorials.evadventure.tests.mixins evennia.contrib.tutorials.evadventure.tests.test_characters + evennia.contrib.tutorials.evadventure.tests.test_chargen evennia.contrib.tutorials.evadventure.tests.test_combat evennia.contrib.tutorials.evadventure.tests.test_commands evennia.contrib.tutorials.evadventure.tests.test_dungeon diff --git a/docs/1.0-dev/_sources/api/evennia.contrib.tutorials.evadventure.tests.test_chargen.md.txt b/docs/1.0-dev/_sources/api/evennia.contrib.tutorials.evadventure.tests.test_chargen.md.txt new file mode 100644 index 0000000000..c7f7b274db --- /dev/null +++ b/docs/1.0-dev/_sources/api/evennia.contrib.tutorials.evadventure.tests.test_chargen.md.txt @@ -0,0 +1,10 @@ +```{eval-rst} +evennia.contrib.tutorials.evadventure.tests.test\_chargen +================================================================ + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_chargen + :members: + :undoc-members: + :show-inheritance: + +``` \ No newline at end of file diff --git a/docs/1.0-dev/api/evennia-api.html b/docs/1.0-dev/api/evennia-api.html index 23d1492fcb..993a463493 100644 --- a/docs/1.0-dev/api/evennia-api.html +++ b/docs/1.0-dev/api/evennia-api.html @@ -240,6 +240,11 @@
  • evennia.contrib.grid.extended_room.tests
    • +
  • evennia.contrib.grid.ingame_map_display +
  • evennia.contrib.grid.mapbuilder
    • evennia.contrib.grid.mapbuilder.mapbuilder
    • evennia.contrib.grid.mapbuilder.tests
      • @@ -374,6 +379,7 @@
    • evennia.contrib.tutorials.evadventure.tests
      • evennia.contrib.tutorials.evadventure.tests.mixins
      • evennia.contrib.tutorials.evadventure.tests.test_characters
        • +
      • evennia.contrib.tutorials.evadventure.tests.test_chargen
      • evennia.contrib.tutorials.evadventure.tests.test_combat
      • evennia.contrib.tutorials.evadventure.tests.test_commands
      • evennia.contrib.tutorials.evadventure.tests.test_dungeon
        • diff --git a/docs/1.0-dev/api/evennia.commands.default.account.html b/docs/1.0-dev/api/evennia.commands.default.account.html index f1fc66fbaa..4b41f8be9e 100644 --- a/docs/1.0-dev/api/evennia.commands.default.account.html +++ b/docs/1.0-dev/api/evennia.commands.default.account.html @@ -84,7 +84,7 @@ method. Otherwise all text will be returned to all connected sessions.

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

        -search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}
        +search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}
        diff --git a/docs/1.0-dev/api/evennia.commands.default.building.html b/docs/1.0-dev/api/evennia.commands.default.building.html index 17c6ebe435..41cc74bb0c 100644 --- a/docs/1.0-dev/api/evennia.commands.default.building.html +++ b/docs/1.0-dev/api/evennia.commands.default.building.html @@ -1296,7 +1296,7 @@ server settings.

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

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

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

        -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 '}
        +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 '}
        @@ -549,7 +549,7 @@ placing it in their inventory.

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

        -search_index_entry = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}
        +search_index_entry = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}
        @@ -724,7 +724,7 @@ which permission groups you are a member of.

        -aliases = ['groups', 'hierarchy']
        +aliases = ['hierarchy', 'groups']
        @@ -755,7 +755,7 @@ which permission groups you are a member of.

        -search_index_entry = {'aliases': 'groups hierarchy', 'category': 'general', 'key': 'access', 'no_prefix': ' groups hierarchy', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}
        +search_index_entry = {'aliases': 'hierarchy groups', 'category': 'general', 'key': 'access', 'no_prefix': ' hierarchy groups', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}
        diff --git a/docs/1.0-dev/api/evennia.commands.default.tests.html b/docs/1.0-dev/api/evennia.commands.default.tests.html index b3d8532b4c..ca3eb0007f 100644 --- a/docs/1.0-dev/api/evennia.commands.default.tests.html +++ b/docs/1.0-dev/api/evennia.commands.default.tests.html @@ -853,7 +853,7 @@ main test suite started with

        Test the batch processor.

        -red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpk6g0ewch/bb1375aa7b7ea2773edf2a64b970a47e21f4aad5/evennia/contrib/tutorials/red_button/red_button.py'>
        +red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpt439vk98/caa46997884d347a53675565c8f3a9d08abb7de2/evennia/contrib/tutorials/red_button/red_button.py'>
        diff --git a/docs/1.0-dev/api/evennia.commands.default.unloggedin.html b/docs/1.0-dev/api/evennia.commands.default.unloggedin.html index 3bcc7004ec..352050c34d 100644 --- a/docs/1.0-dev/api/evennia.commands.default.unloggedin.html +++ b/docs/1.0-dev/api/evennia.commands.default.unloggedin.html @@ -187,7 +187,7 @@ version is a bit more complicated.

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

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

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

        -search_index_entry = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}
        +search_index_entry = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}
        diff --git a/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html b/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html index fb3471ba3f..ac01996c82 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html @@ -197,7 +197,7 @@ version is a bit more complicated.

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

        -search_index_entry = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'no_prefix': ' q qu', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
        +search_index_entry = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'no_prefix': ' qu q', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
        @@ -242,7 +242,7 @@ All it does is display the connect screen.

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

        -search_index_entry = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}
        +search_index_entry = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}
        diff --git a/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html b/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html index f7befa7b2d..8513a49ffc 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html @@ -67,7 +67,7 @@
        -aliases = ['@callback', '@calls', '@callbacks']
        +aliases = ['@calls', '@callbacks', '@callback']
        @@ -148,7 +148,7 @@ on user permission.

        -search_index_entry = {'aliases': '@callback @calls @callbacks', 'category': 'building', 'key': '@call', 'no_prefix': 'call callback calls callbacks', 'tags': '', 'text': '\n Command to edit callbacks.\n '}
        +search_index_entry = {'aliases': '@calls @callbacks @callback', 'category': 'building', 'key': '@call', 'no_prefix': 'call calls callbacks callback', 'tags': '', 'text': '\n Command to edit callbacks.\n '}
        diff --git a/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html b/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html index 6f6e7aade1..c6d7e4ad02 100644 --- a/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html @@ -162,7 +162,7 @@ the operation will be general or on the room.

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

        -search_index_entry = {'aliases': 'abort q chicken out quit', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' abort q 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': 'quit chicken out q abort', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' quit chicken out q 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 '}
        @@ -207,7 +207,7 @@ set in self.parse())

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

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

        -aliases = ['whisper', 'shout', ';']
        +aliases = ['shout', 'whisper', ';']
        @@ -351,7 +351,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 '}
        @@ -379,7 +379,7 @@ emote /me points to /box and /lever.

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

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

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

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

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

        -search_index_entry = {'aliases': 'i inventory give inv', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' i inventory give inv', 'tags': '', 'text': '\n Use 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': '\n Use focus / examine instead.\n\n '}
        diff --git a/docs/1.0-dev/api/evennia.contrib.game_systems.clothing.clothing.html b/docs/1.0-dev/api/evennia.contrib.game_systems.clothing.clothing.html index 735d68fcf6..3304dc8c6d 100644 --- a/docs/1.0-dev/api/evennia.contrib.game_systems.clothing.clothing.html +++ b/docs/1.0-dev/api/evennia.contrib.game_systems.clothing.clothing.html @@ -643,7 +643,7 @@ inv

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

        -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 '}
        +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 '}
        diff --git a/docs/1.0-dev/api/evennia.contrib.game_systems.turnbattle.tb_basic.html b/docs/1.0-dev/api/evennia.contrib.game_systems.turnbattle.tb_basic.html index a0cfe3814c..8556688b9e 100644 --- a/docs/1.0-dev/api/evennia.contrib.game_systems.turnbattle.tb_basic.html +++ b/docs/1.0-dev/api/evennia.contrib.game_systems.turnbattle.tb_basic.html @@ -623,7 +623,7 @@ if there are still any actions you can take.

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

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

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

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

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

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

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

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

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

        -search_index_entry = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
        +search_index_entry = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}
        diff --git a/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html b/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html index d284ddea0f..e97c9c1631 100644 --- a/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html +++ b/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html @@ -291,7 +291,7 @@ look *<account&g
        -aliases = ['ls', 'l']
        +aliases = ['l', 'ls']
        @@ -311,7 +311,7 @@ look *<account&g
        -search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}
        +search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}
        diff --git a/docs/1.0-dev/api/evennia.contrib.grid.extended_room.tests.html b/docs/1.0-dev/api/evennia.contrib.grid.extended_room.tests.html index 36f3b7a87a..0ae9638687 100644 --- a/docs/1.0-dev/api/evennia.contrib.grid.extended_room.tests.html +++ b/docs/1.0-dev/api/evennia.contrib.grid.extended_room.tests.html @@ -17,7 +17,7 @@ - +