From e41f2ff6b27b4f5c3f5f291f177bf5e561543cdd Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Sun, 24 Jul 2022 06:52:16 +0000 Subject: [PATCH] Updated HTML docs --- docs/0.9.5/.buildinfo | 2 +- docs/0.9.5/Default-Commands.html | 30 ++++---- docs/0.9.5/_sources/Default-Commands.md.txt | 30 ++++---- .../api/evennia.commands.default.account.html | 2 +- .../api/evennia.commands.default.admin.html | 2 +- ...evennia.commands.default.batchprocess.html | 2 +- .../evennia.commands.default.building.html | 2 +- .../api/evennia.commands.default.comms.html | 2 +- .../api/evennia.commands.default.general.html | 8 +-- .../api/evennia.commands.default.system.html | 6 +- .../evennia.commands.default.unloggedin.html | 8 +-- docs/0.9.5/api/evennia.contrib.chargen.html | 2 +- .../api/evennia.contrib.email_login.html | 8 +-- .../api/evennia.contrib.extended_room.html | 2 +- ...vennia.contrib.ingame_python.commands.html | 2 +- docs/0.9.5/api/evennia.contrib.rpsystem.html | 4 +- ...b.tutorial_examples.cmdset_red_button.html | 6 +- ...vennia.contrib.tutorial_world.objects.html | 4 +- .../evennia.contrib.tutorial_world.rooms.html | 6 +- 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/Howtos/NPC-shop-Tutorial.html | 2 +- docs/1.0-dev/Howtos/Tutorial-Vehicles.html | 4 +- .../evennia/commands/default/building.html | 5 +- .../evennia/commands/default/general.html | 8 +-- .../full_systems/evscaperoom/commands.html | 2 +- .../full_systems/evscaperoom/room.html | 4 +- .../game_systems/clothing/clothing.html | 6 +- .../contrib/grid/slow_exit/slow_exit.html | 2 +- .../contrib/grid/wilderness/wilderness.html | 2 +- .../contrib/rpg/rpsystem/rpsystem.html | 52 +++++++++----- .../evennia/contrib/rpg/rpsystem/tests.html | 35 +++++++-- .../tutorials/tutorial_world/rooms.html | 28 ++++---- .../tutorials/tutorial_world/tests.html | 4 +- .../_modules/evennia/objects/objects.html | 68 +++++++++++++----- .../server/game_index_client/client.html | 1 - .../_sources/Howtos/NPC-shop-Tutorial.md.txt | 2 +- .../_sources/Howtos/Tutorial-Vehicles.md.txt | 4 +- .../api/evennia.commands.default.account.html | 4 +- ...evennia.commands.default.batchprocess.html | 4 +- .../evennia.commands.default.building.html | 8 +-- .../api/evennia.commands.default.general.html | 16 ++--- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 12 ++-- ....base_systems.email_login.email_login.html | 12 ++-- ...b.base_systems.ingame_python.commands.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 4 +- ...rib.full_systems.evscaperoom.commands.html | 24 +++---- ...contrib.full_systems.evscaperoom.room.html | 4 +- ...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 +- ...ia.contrib.grid.wilderness.wilderness.html | 2 +- .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...evennia.contrib.rpg.rpsystem.rpsystem.html | 4 +- .../evennia.contrib.rpg.rpsystem.tests.html | 9 ++- ...ntrib.tutorials.red_button.red_button.html | 16 ++--- ...trib.tutorials.tutorial_world.objects.html | 8 +-- ...ontrib.tutorials.tutorial_world.rooms.html | 34 +++++---- docs/1.0-dev/api/evennia.objects.objects.html | 59 ++++++++++++--- 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 | 14 ++-- docs/1.0-dev/objects.inv | Bin 140925 -> 140934 bytes docs/1.0-dev/searchindex.js | 2 +- 71 files changed, 382 insertions(+), 267 deletions(-) diff --git a/docs/0.9.5/.buildinfo b/docs/0.9.5/.buildinfo index 6c78cf48b4..ba2ddbb3ea 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: d0941aadd143a99f74c117fdcb4a88d1 +config: 5fe7f891b0e577c9ccfd1992bb9ff906 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/0.9.5/Default-Commands.html b/docs/0.9.5/Default-Commands.html index 2a60a06563..b87296f9bb 100644 --- a/docs/0.9.5/Default-Commands.html +++ b/docs/0.9.5/Default-Commands.html @@ -53,27 +53,27 @@ with Batch-Processor’s interactive mode.

Keyword Arguments
@@ -974,13 +979,17 @@ based on the access result.

-at_pre_move(destination, **kwargs)[source]
+at_pre_move(destination, move_type='move', **kwargs)[source]

Called just before starting to move this object to destination.

Parameters

  • destination (Object) – The object we are moving to

    • +

  • move_type (str) – The type of move. “give”, “traverse”, etc. +This is an arbitrary string provided to obj.move_to(). +Useful for altering messages or altering logic depending +on the kind of movement.

  • **kwargs (dict) – Arbitrary, optional arguments for users overriding the call (unused by default).

@@ -996,13 +1005,17 @@ before it is even started.

-at_before_move(destination, **kwargs)
+at_before_move(destination, move_type='move', **kwargs)

Called just before starting to move this object to destination.

Parameters

  • destination (Object) – The object we are moving to

    • +

  • move_type (str) – The type of move. “give”, “traverse”, etc. +This is an arbitrary string provided to obj.move_to(). +Useful for altering messages or altering logic depending +on the kind of movement.

  • **kwargs (dict) – Arbitrary, optional arguments for users overriding the call (unused by default).

@@ -1018,7 +1031,7 @@ before it is even started.

-announce_move_from(destination, msg=None, mapping=None, **kwargs)[source]
+announce_move_from(destination, msg=None, mapping=None, move_type='move', **kwargs)[source]

Called if the move is to be announced. This is called while we are still standing in the old location.

@@ -1028,6 +1041,10 @@ location.

  • destination (Object) – The place we are going to.

  • msg (str, optional) – a replacement message.

  • mapping (dict, optional) – additional mapping objects.

    • +

  • move_type (str) – The type of move. “give”, “traverse”, etc. +This is an arbitrary string provided to obj.move_to(). +Useful for altering messages or altering logic depending +on the kind of movement.

  • **kwargs (dict) – Arbitrary, optional arguments for users overriding the call (unused by default).

    • @@ -1046,7 +1063,7 @@ destination: the location of the object after moving.

    -announce_move_to(source_location, msg=None, mapping=None, **kwargs)[source]
    +announce_move_to(source_location, msg=None, mapping=None, move_type='move', **kwargs)[source]

    Called after the move if the move was not quiet. At this point we are standing in the new location.

    @@ -1055,6 +1072,10 @@ we are standing in the new location.

  • source_location (Object) – The place we came from

  • msg (str, optional) – the replacement message if location.

  • mapping (dict, optional) – additional mapping objects.

    • +

  • move_type (str) – The type of move. “give”, “traverse”, etc. +This is an arbitrary string provided to obj.move_to(). +Useful for altering messages or altering logic depending +on the kind of movement.

  • **kwargs (dict) – Arbitrary, optional arguments for users overriding the call (unused by default).

    • @@ -1074,7 +1095,7 @@ destination: the location of the object after moving.

    -at_post_move(source_location, **kwargs)[source]
    +at_post_move(source_location, move_type='move', **kwargs)[source]

    Called after move has completed, regardless of quiet mode or not. Allows changes to the object due to the location it is now in.

    @@ -1082,6 +1103,10 @@ now in.

    Parameters

    • source_location (Object) – Wwhere we came from. This may be None.

      • +

    • move_type (str) – The type of move. “give”, “traverse”, etc. +This is an arbitrary string provided to obj.move_to(). +Useful for altering messages or altering logic depending +on the kind of movement.

    • **kwargs (dict) – Arbitrary, optional arguments for users overriding the call (unused by default).

    @@ -1091,7 +1116,7 @@ overriding the call (unused by default).

    -at_after_move(source_location, **kwargs)
    +at_after_move(source_location, move_type='move', **kwargs)

    Called after move has completed, regardless of quiet mode or not. Allows changes to the object due to the location it is now in.

    @@ -1099,6 +1124,10 @@ now in.

    Parameters

    • source_location (Object) – Wwhere we came from. This may be None.

      • +

    • move_type (str) – The type of move. “give”, “traverse”, etc. +This is an arbitrary string provided to obj.move_to(). +Useful for altering messages or altering logic depending +on the kind of movement.

    • **kwargs (dict) – Arbitrary, optional arguments for users overriding the call (unused by default).

    @@ -1108,13 +1137,17 @@ overriding the call (unused by default).

    -at_object_leave(moved_obj, target_location, **kwargs)[source]
    +at_object_leave(moved_obj, target_location, move_type='move', **kwargs)[source]

    Called just before an object leaves from inside this object

    Parameters

    • moved_obj (Object) – The object leaving

    • target_location (Object) – Where moved_obj is going.

      • +

    • move_type (str) – The type of move. “give”, “traverse”, etc. +This is an arbitrary string provided to obj.move_to(). +Useful for altering messages or altering logic depending +on the kind of movement.

    • **kwargs (dict) – Arbitrary, optional arguments for users overriding the call (unused by default).

    @@ -1124,7 +1157,7 @@ overriding the call (unused by default).

    -at_object_receive(moved_obj, source_location, **kwargs)[source]
    +at_object_receive(moved_obj, source_location, move_type='move', **kwargs)[source]

    Called after an object has been moved into this object.

    Parameters
    @@ -1132,6 +1165,10 @@ overriding the call (unused by default).

  • moved_obj (Object) – The object moved into this one

  • source_location (Object) – Where moved_object came from. Note that this could be None.

    • +

  • move_type (str) – The type of move. “give”, “traverse”, etc. +This is an arbitrary string provided to obj.move_to(). +Useful for altering messages or altering logic depending +on the kind of movement.

  • **kwargs (dict) – Arbitrary, optional arguments for users overriding the call (unused by default).

    • @@ -1818,13 +1855,13 @@ Character object works).

    -at_post_move(source_location, **kwargs)[source]
    +at_post_move(source_location, move_type='move', **kwargs)[source]

    We make sure to look around after a move.

    -at_after_move(source_location, **kwargs)
    +at_after_move(source_location, move_type='move', **kwargs)

    We make sure to look around after a move.

    diff --git a/docs/1.0-dev/api/evennia.utils.eveditor.html b/docs/1.0-dev/api/evennia.utils.eveditor.html index 54dc0162ef..c3301f18b6 100644 --- a/docs/1.0-dev/api/evennia.utils.eveditor.html +++ b/docs/1.0-dev/api/evennia.utils.eveditor.html @@ -287,7 +287,7 @@ indentation.

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

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

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

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

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

    -search_index_entry = {'aliases': 'q next n abort a t end e p quit top previous', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' q next n abort a t end e p quit top previous', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
    +search_index_entry = {'aliases': 'top t end n a p e abort next q quit previous', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' top t end n a p e abort next q quit previous', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
    diff --git a/docs/1.0-dev/genindex.html b/docs/1.0-dev/genindex.html index e79ef995c6..75a19e4f0f 100644 --- a/docs/1.0-dev/genindex.html +++ b/docs/1.0-dev/genindex.html @@ -14390,12 +14390,8 @@
  • parse_opts() (in module evennia.contrib.utils.tree_select.tree_select)
    • -
  • parse_sdescs_and_recogs() (evennia.contrib.rpg.rpsystem.tests.TestRPSystem method) - -
  • parse_to_any() (evennia.utils.funcparser.FuncParser method)
  • ParseError @@ -18697,6 +18693,8 @@
  • test_parse_for_things() (evennia.contrib.full_systems.evscaperoom.tests.TestUtils method)
  • test_parse_language() (evennia.contrib.rpg.rpsystem.tests.TestRPSystem method) +
    • +
  • test_parse_sdescs_and_recogs() (evennia.contrib.rpg.rpsystem.tests.TestRPSystem method)
  • test_password() (evennia.commands.default.tests.TestAccount method)
    • @@ -18739,6 +18737,8 @@
  • test_pos_shortcut() (evennia.contrib.rpg.traits.tests.TestNumericTraitOperators method)
  • test_pose() (evennia.commands.default.tests.TestGeneral method) +
    • +
  • test_possessive_selfref() (evennia.contrib.rpg.rpsystem.tests.TestRPSystem method)
  • test_pre_craft() (evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase method)
    • @@ -18895,11 +18895,11 @@
  • test_shortest_path_04() (evennia.contrib.grid.xyzgrid.tests.TestMap3 method)
  • test_shortest_path_05() (evennia.contrib.grid.xyzgrid.tests.TestMap3 method) -
    • -
  • test_shortest_path_06() (evennia.contrib.grid.xyzgrid.tests.TestMap3 method)