From 8b7da799c570a0b3f3647b864bcdd34845d38854 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Wed, 31 May 2023 20:31:18 +0000 Subject: [PATCH] Updated HTML docs. --- docs/1.0/.buildinfo | 2 +- docs/1.0/Contribs/Contrib-Extended-Room.html | 187 ++- docs/1.0/Contribs/Contribs-Overview.html | 14 +- docs/1.0/_modules/evennia.html | 4 +- .../grid/extended_room/extended_room.html | 1097 +++++++++++------ .../contrib/grid/extended_room/tests.html | 464 +++++-- .../1.0/_modules/evennia/objects/objects.html | 12 +- .../evennia/prototypes/prototypes.html | 8 +- .../Contribs/Contrib-Extended-Room.md.txt | 189 ++- .../Contribs/Contribs-Overview.md.txt | 14 +- .../api/evennia.commands.default.account.html | 4 +- .../evennia.commands.default.building.html | 12 +- .../api/evennia.commands.default.general.html | 16 +- .../api/evennia.commands.default.system.html | 4 +- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 16 +- ....base_systems.email_login.email_login.html | 16 +- ...b.base_systems.ingame_python.commands.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 4 +- ...rib.full_systems.evscaperoom.commands.html | 20 +- ...ontrib.game_systems.clothing.clothing.html | 4 +- ...trib.grid.extended_room.extended_room.html | 899 +++++++++++--- .../evennia.contrib.grid.extended_room.html | 2 +- ...nnia.contrib.grid.extended_room.tests.html | 176 ++- .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...ontrib.tutorials.evadventure.commands.html | 4 +- ...contrib.tutorials.evadventure.objects.html | 2 +- ...ntrib.tutorials.red_button.red_button.html | 16 +- ...trib.tutorials.tutorial_world.objects.html | 12 +- ...ontrib.tutorials.tutorial_world.rooms.html | 8 +- ...utils.git_integration.git_integration.html | 4 +- docs/1.0/api/evennia.html | 1 + docs/1.0/api/evennia.objects.objects.html | 2 +- docs/1.0/api/evennia.utils.eveditor.html | 4 +- docs/1.0/api/evennia.utils.evmenu.html | 4 +- docs/1.0/api/evennia.utils.evmore.html | 4 +- docs/1.0/genindex.html | 200 ++- docs/1.0/objects.inv | Bin 162683 -> 163072 bytes docs/1.0/searchindex.js | 2 +- 39 files changed, 2543 insertions(+), 894 deletions(-) diff --git a/docs/1.0/.buildinfo b/docs/1.0/.buildinfo index f42458da6a..a1866234bd 100644 --- a/docs/1.0/.buildinfo +++ b/docs/1.0/.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: a663ca462a05237cb244e4619fee97ec +config: c7a0d3d722a6c1a8b84f4632fae3f454 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/1.0/Contribs/Contrib-Extended-Room.html b/docs/1.0/Contribs/Contrib-Extended-Room.html index 93802f4cc7..222e023c62 100644 --- a/docs/1.0/Contribs/Contrib-Extended-Room.html +++ b/docs/1.0/Contribs/Contrib-Extended-Room.html @@ -62,11 +62,12 @@

Table of Contents

Returns
-

str – The desc display string..

+

str – The desc display string.

diff --git a/docs/1.0/api/evennia.utils.eveditor.html b/docs/1.0/api/evennia.utils.eveditor.html index 30886a0ae7..29f2f13bc9 100644 --- a/docs/1.0/api/evennia.utils.eveditor.html +++ b/docs/1.0/api/evennia.utils.eveditor.html @@ -336,7 +336,7 @@ indentation.

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

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

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

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

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

-search_index_entry = {'aliases': 'end next quit previous e top q a p n t abort', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' end next quit previous e top q a p n t abort', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
+search_index_entry = {'aliases': 'n end top t previous p e q abort quit a next', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' n end top t previous p e q abort quit a next', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
diff --git a/docs/1.0/genindex.html b/docs/1.0/genindex.html index 7550ae483a..d2edaba7c5 100644 --- a/docs/1.0/genindex.html +++ b/docs/1.0/genindex.html @@ -721,6 +721,10 @@
  • (evennia.contrib.base_systems.components.holder.ComponentHandler method)
    • +
  • add_desc() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method) +
    • +
  • add_detail() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method) +
  • add_event() (evennia.contrib.base_systems.ingame_python.scripts.EventHandler method)
  • add_fieldsets (evennia.web.admin.accounts.AccountAdmin attribute) @@ -748,6 +752,8 @@
  • add_object_listeners_and_responders() (evennia.contrib.base_systems.components.signals.SignalsHandler method)
  • add_responder() (evennia.contrib.base_systems.components.signals.SignalsHandler method) +
    • +
  • add_room_state() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method)
  • add_row() (evennia.utils.evtable.EvTable method)
    • @@ -1197,6 +1203,8 @@
  • (evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime attribute)
  • (evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook attribute) +
    • +
  • (evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomState attribute)
  • (evennia.contrib.grid.ingame_map_display.ingame_map_display.CmdMap attribute)
    • @@ -1414,6 +1422,8 @@
  • all_connected_accounts() (evennia.server.sessionhandler.ServerSessionHandler method) +
    • +
  • all_desc() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method)
  • all_display() (evennia.scripts.tickerhandler.TickerHandler method)
    • @@ -1553,12 +1563,12 @@
  • apply() (evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet method)
    • + + - +
  • base_room_desc (evennia.contrib.grid.extended_room.tests.TestExtendedRoom attribute) + +
  • BaseApplicable (class in evennia.contrib.full_systems.evscaperoom.objects) @@ -2954,11 +2970,11 @@
  • BaseTypeclassFilterSet (class in evennia.web.api.filters) -
    • -
  • BasicCombatRules (class in evennia.contrib.game_systems.turnbattle.tb_basic)
    • - +
  • desc_add_lamp_broken (evennia.contrib.tutorials.red_button.red_button.RedButton attribute) +
    • +
  • desc_autumn (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom attribute)
  • desc_closed_lid (evennia.contrib.tutorials.red_button.red_button.RedButton attribute)
  • desc_open_lid (evennia.contrib.tutorials.red_button.red_button.RedButton attribute) +
    • +
  • desc_spring (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom attribute) +
    • +
  • desc_summer (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom attribute) +
    • +
  • desc_winter (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom attribute)
  • description (evennia.web.api.views.AccountDBViewSet attribute) @@ -5511,7 +5541,7 @@
  • detail_color (evennia.commands.default.building.CmdExamine attribute)
    • -
  • DETAIL_DESC (evennia.contrib.grid.extended_room.tests.TestExtendedRoom attribute) +
  • details (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom attribute)
  • DEX (evennia.contrib.tutorials.evadventure.enums.Ability attribute)
    • @@ -5869,6 +5899,8 @@
  • editor (evennia.utils.eveditor.CmdEditorBase attribute) @@ -9330,8 +9362,6 @@
  • focus() (evennia.contrib.full_systems.evscaperoom.commands.CmdEvscapeRoom property)
  • for_contents() (evennia.objects.objects.DefaultObject method) -
    • -
  • ForceUTCDatetime (class in evennia.contrib.grid.extended_room.tests)
  • form (evennia.web.admin.accounts.AccountAdmin attribute) @@ -9502,8 +9532,6 @@
  • fromBox() (evennia.server.portal.amp.Compressed method)
  • fromString() (evennia.server.portal.amp.Compressed method) -
    • -
  • fromtimestamp() (evennia.contrib.grid.extended_room.tests.ForceUTCDatetime class method)
  • full_name() (in module evennia.contrib.utils.name_generator.namegen)
    • @@ -9865,6 +9893,8 @@
  • (evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime method)
  • (evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook method) +
    • +
  • (evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomState method)
  • (evennia.contrib.grid.ingame_map_display.ingame_map_display.CmdMap method)
    • @@ -10009,6 +10039,8 @@ -
  • get_detail() (evennia.contrib.tutorials.evadventure.shops.BuyItem method) +
  • get_detail() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method) + +
  • get_direction() (evennia.contrib.grid.xyzgrid.xymap_legend.MapLink method)
  • remove_responder() (evennia.contrib.base_systems.components.signals.SignalsHandler method) +
    • +
  • remove_room_state() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method)
  • remove_sender() (evennia.comms.models.Msg method) @@ -17838,6 +17906,8 @@
  • (in module evennia.utils.utils)
    • +
  • repeat_broadcast_message_to_room() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method) +
  • repeats() (evennia.scripts.models.ScriptDB property)
  • replace() (evennia.locks.lockhandler.LockHandler method) @@ -17852,7 +17922,7 @@