From ba30ca7bb4eb795db35a89a094e7a37a3eb380a7 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Fri, 25 Nov 2022 10:59:06 +0000 Subject: [PATCH] Updated HTML docs. --- docs/1.0-dev/.buildinfo | 2 +- docs/1.0-dev/Contribs/Contrib-Wilderness.html | 29 +- docs/1.0-dev/Contribs/Contribs-Overview.html | 2 +- .../contrib/grid/wilderness/tests.html | 35 ++- .../contrib/grid/wilderness/wilderness.html | 247 ++++++++++-------- .../Contribs/Contrib-Wilderness.md.txt | 30 ++- .../Contribs/Contribs-Overview.md.txt | 2 +- .../evennia.commands.default.building.html | 8 +- .../api/evennia.commands.default.comms.html | 8 +- .../api/evennia.commands.default.general.html | 8 +- .../api/evennia.commands.default.system.html | 4 +- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 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 | 8 +- ...rib.full_systems.evscaperoom.commands.html | 20 +- ...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 +- ...evennia.contrib.grid.wilderness.tests.html | 5 + ...ia.contrib.grid.wilderness.wilderness.html | 103 +++++--- ...ontrib.tutorials.evadventure.commands.html | 8 +- ...ntrib.tutorials.red_button.red_button.html | 16 +- ...trib.tutorials.tutorial_world.objects.html | 16 +- ...ontrib.tutorials.tutorial_world.rooms.html | 8 +- ...utils.git_integration.git_integration.html | 4 +- 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 | 26 +- docs/1.0-dev/objects.inv | Bin 158420 -> 158454 bytes docs/1.0-dev/searchindex.js | 2 +- 36 files changed, 378 insertions(+), 279 deletions(-) diff --git a/docs/1.0-dev/.buildinfo b/docs/1.0-dev/.buildinfo index 735ea2b9af..ea4ebdc5ed 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: 2eeb79a22425d211c179db63d3a233a2 +config: e1de877408fb891981531ac3470de428 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/1.0-dev/Contribs/Contrib-Wilderness.html b/docs/1.0-dev/Contribs/Contrib-Wilderness.html index dbbfbd4c6e..79d8a2d247 100644 --- a/docs/1.0-dev/Contribs/Contrib-Wilderness.html +++ b/docs/1.0-dev/Contribs/Contrib-Wilderness.html @@ -114,7 +114,7 @@

This contrib provides a wilderness map without actually creating a large number of rooms - as you move, you instead end up back in the same room but its description changes. This means you can make huge areas with little database use as -long as the rooms are relatively similar (name/desc changing).

+long as the rooms are relatively similar (e.g. only the names/descs changing).

Installation

This contrib does not provide any new commands. Instead the default py command @@ -136,6 +136,10 @@ specify the name, a script named “default” will be created and used.

All coordinates used by the wilderness map are in the format of (x, y) tuples. x goes from left to right and y goes from bottom to top. So (0, 0) is the bottom left corner of the map.

+
+

You can also add a wilderness by defining a WildernessScript in your GLOBAL_SCRIPT +settings. If you do, make sure define the map provider.

+

Customisation

@@ -143,9 +147,12 @@ is the bottom left corner of the map.

new wilderness map it is possible to give a “map provider”: this is a python object that is smart enough to create the map.

The default provider, WildernessMapProvider, just creates a grid area that -is unlimited in size. -This WildernessMapProvider can be subclassed to create more interesting +is unlimited in size.

+

WildernessMapProvider can be subclassed to create more interesting maps and also to customize the room/exit typeclass used.

+

The WildernessScript also has an optional preserve_items property, which +when set to True will not recycle rooms that contain any objects. By default, +a wilderness room is recycled whenever there are no players left in it.

There is also no command that allows players to enter the wilderness. This still needs to be added: it can be a command or an exit, depending on your needs.

@@ -197,7 +204,7 @@ provided as a string: a “.” symbol is a location we can walk on.

desc = "This is a room in the pyramid." if y == 3 : desc = "You can see far and wide from the top of the pyramid." - room.db.desc = desc + room.ndb.desc = desc

Now we can use our new pyramid-shaped wilderness map. From inside Evennia we @@ -209,12 +216,14 @@ py from evennia.contrib import wilderness; wilderness.enter_wilderness(me, coord

Implementation details

-

When a character moves into the wilderness, they get their own room. If they -move, instead of moving the character, the room changes to match the new -coordinates. If a character meets another character in the wilderness, then -their room merges. When one of the character leaves again, they each get their -own separate rooms. Rooms are created as needed. Unneeded rooms are stored away -to avoid the overhead cost of creating new rooms again in the future.

+

When a character moves into the wilderness, they get their own room. If +they move, instead of moving the character, the room changes to match the +new coordinates.

+

If a character meets another character in the wilderness, then their room +merges. When one of the character leaves again, they each get their own +separate rooms.

+

Rooms are created as needed. Unneeded rooms are stored away to avoid the +overhead cost of creating new rooms again in the future.

This document page is generated from evennia/contrib/grid/wilderness/README.md. Changes to this file will be overwritten, so edit that file rather than this one.

diff --git a/docs/1.0-dev/Contribs/Contribs-Overview.html b/docs/1.0-dev/Contribs/Contribs-Overview.html index 900fdac2b4..67db94f2f3 100644 --- a/docs/1.0-dev/Contribs/Contribs-Overview.html +++ b/docs/1.0-dev/Contribs/Contribs-Overview.html @@ -599,7 +599,7 @@ and abort an ongoing traversal, respectively.

This contrib provides a wilderness map without actually creating a large number of rooms - as you move, you instead end up back in the same room but its description changes. This means you can make huge areas with little database use as -long as the rooms are relatively similar (name/desc changing).

+long as the rooms are relatively similar (e.g. only the names/descs changing).

Read the documentation - Browse the Code

diff --git a/docs/1.0-dev/_modules/evennia/contrib/grid/wilderness/tests.html b/docs/1.0-dev/_modules/evennia/contrib/grid/wilderness/tests.html index 8ec94b0fb4..0306505417 100644 --- a/docs/1.0-dev/_modules/evennia/contrib/grid/wilderness/tests.html +++ b/docs/1.0-dev/_modules/evennia/contrib/grid/wilderness/tests.html @@ -114,14 +114,14 @@ wilderness.enter_wilderness(self.char1) self.assertIsInstance(self.char1.location, wilderness.WildernessRoom) w = self.get_wilderness_script() - self.assertEqual(w.db.itemcoordinates[self.char1], (0, 0)) + self.assertEqual(w.itemcoordinates[self.char1], (0, 0))
[docs] def test_enter_wilderness_custom_coordinates(self): wilderness.create_wilderness() wilderness.enter_wilderness(self.char1, coordinates=(1, 2)) self.assertIsInstance(self.char1.location, wilderness.WildernessRoom) w = self.get_wilderness_script() - self.assertEqual(w.db.itemcoordinates[self.char1], (1, 2))
+ self.assertEqual(w.itemcoordinates[self.char1], (1, 2))
[docs] def test_enter_wilderness_custom_name(self): name = "customnname" @@ -211,9 +211,36 @@ "west": (0, 1), "northwest": (0, 2), } - for (direction, correct_loc) in directions.items(): # Not compatible with Python 3 + for direction, correct_loc in directions.items(): new_loc = wilderness.get_new_coordinates(loc, direction) - self.assertEqual(new_loc, correct_loc, direction)
+ self.assertEqual(new_loc, correct_loc, direction) + +
[docs] def test_preserve_items(self): + wilderness.create_wilderness() + w = self.get_wilderness_script() + + # move char and obj to wilderness + wilderness.enter_wilderness(self.char1) + wilderness.enter_wilderness(self.obj1) + + # move to a new room + w.move_obj(self.char1, (1, 1)) + # the room should be remapped and 0,0 should not exist + self.assertTrue((0, 0) not in w.db.rooms) + self.assertEqual(1, len(w.db.rooms)) + # verify obj1 moved to None + self.assertIsNone(self.obj1.location) + + # now change to preserve items + w.preserve_items = True + wilderness.enter_wilderness(self.obj1, (1, 1)) + # move the character again + w.move_obj(self.char1, (0, 1)) + # check that the previous room was preserved + self.assertIn((1, 1), w.db.rooms) + self.assertEqual(2, len(w.db.rooms)) + # and verify that obj1 is still at 1,1 + self.assertEqual(self.obj1.location, w.db.rooms[(1, 1)])
diff --git a/docs/1.0-dev/_modules/evennia/contrib/grid/wilderness/wilderness.html b/docs/1.0-dev/_modules/evennia/contrib/grid/wilderness/wilderness.html index 500b6e65c4..7cc3e12a86 100644 --- a/docs/1.0-dev/_modules/evennia/contrib/grid/wilderness/wilderness.html +++ b/docs/1.0-dev/_modules/evennia/contrib/grid/wilderness/wilderness.html @@ -112,10 +112,11 @@ new wilderness map it is possible to give a "map provider": this is a python object that is smart enough to create the map. -The default provider, `WildernessMapProvider`, just creates a grid area that +The default provider, `WildernessMapProvider`, creates a grid area that is unlimited in size. -This `WildernessMapProvider` can be subclassed to create more interesting -maps and also to customize the room/exit typeclass used. + +`WildernessMapProvider` can be subclassed to create more interesting maps +and also to customize the room/exit typeclass used. There is also no command that allows players to enter the wilderness. This still needs to be added: it can be a command or an exit, depending on your @@ -169,7 +170,7 @@ desc = "This is a room in the pyramid." if y == 3 : desc = "You can see far and wide from the top of the pyramid." - room.db.desc = desc + room.ndb.desc = desc ``` Now we can use our new pyramid-shaped wilderness map. From inside Evennia we @@ -183,9 +184,11 @@ When a character moves into the wilderness, they get their own room. If they move, instead of moving the character, the room changes to match the new coordinates. + If a character meets another character in the wilderness, then their room merges. When one of the character leaves again, they each get their own separate rooms. + Rooms are created as needed. Unneeded rooms are stored away to avoid the overhead cost of creating new rooms again in the future. @@ -199,9 +202,9 @@ create_script, ) from evennia.utils import inherits_from +from evennia.typeclasses.attributes import AttributeProperty - -
[docs]def create_wilderness(name="default", mapprovider=None): +
[docs]def create_wilderness(name="default", mapprovider=None, preserve_items=False): """ Creates a new wilderness map. Does nothing if a wilderness map already exists with the same name. @@ -221,7 +224,9 @@ if not mapprovider: mapprovider = WildernessMapProvider() script = create_script(WildernessScript, key=name) - script.db.mapprovider = mapprovider
+ script.db.mapprovider = mapprovider + if preserve_items: + script.preserve_items = True
[docs]def enter_wilderness(obj, coordinates=(0, 0), name="default"): @@ -239,10 +244,12 @@ Returns: bool: True if obj successfully moved into the wilderness. """ - if not WildernessScript.objects.filter(db_key=name).exists(): + script = WildernessScript.objects.filter(db_key=name) + if not script.exists(): return False + else: + script = script[0] - script = WildernessScript.objects.get(db_key=name) if script.is_valid_coordinates(coordinates): script.move_obj(obj, coordinates) return True @@ -283,6 +290,18 @@ into storage when they are not needed anymore. """ + # Stores the MapProvider class + mapprovider = AttributeProperty() + + # Stores a dictionary of items on the map with their coordinates + # The key is the item, the value are the coordinates as (x, y) tuple. + itemcoordinates = AttributeProperty() + + # Determines whether or not rooms are recycled despite containing non-player objects + # True means that leaving behind a non-player object will prevent the room from being recycled + # in order to preserve the object + preserve_items = AttributeProperty(default=False) +
[docs] def at_script_creation(self): """ Only called once, when the script is created. This is a default Evennia @@ -302,39 +321,17 @@ # allows quick retrieval if a new room is needed without having to # create it. self.db.unused_rooms = []
- - @property - def mapprovider(self): + +
[docs] def at_server_start(self): """ - Shortcut property to the map provider. - - Returns: - MapProvider: the mapprovider used with this wilderness - """ - return self.db.mapprovider - - @property - def itemcoordinates(self): - """ - Returns a dictionary with the coordinates of every item inside this - wilderness map. The key is the item, the value are the coordinates as - (x, y) tuple. - - Returns: - {item: coordinates} - """ - return self.db.itemcoordinates - -
[docs] def at_start(self): - """ - Called when the script is started and also after server reloads. + Called after the server is started or reloaded. """ for coordinates, room in self.db.rooms.items(): room.ndb.wildernessscript = self room.ndb.active_coordinates = coordinates - for item in list(self.db.itemcoordinates.keys()): - # Items deleted from the wilderness leave None type 'ghosts' - # that must be cleaned out + for item in self.db.itemcoordinates.keys(): + # Items deleted while in the wilderness can leave None-type 'ghosts' + # These need to be cleaned up if item is None: del self.db.itemcoordinates[item] continue @@ -381,16 +378,8 @@ Returns: [Object, ]: list of Objects at coordinates """ - result = [] - for item, item_coordinates in list(self.itemcoordinates.items()): - # Items deleted from the wilderness leave None type 'ghosts' - # that must be cleaned out - if item is None: - del self.db.itemcoordinates[item] - continue - if coordinates == item_coordinates: - result.append(item) - return result
+ result = [ item for item, item_coords in self.itemcoordinates.items() if item_coords == coordinates and item is not None ] + return list(result)
[docs] def move_obj(self, obj, new_coordinates): """ @@ -408,45 +397,53 @@ # appear in its old room should that room be deleted. obj.location = None - try: - # See if we already have a room for that location - room = self.db.rooms[new_coordinates] + # By default, we'll assume we won't be making a new room and change this flag if necessary. + create_room = False + + # See if we already have a room for that location + if room := self.db.rooms.get(new_coordinates): # There is. Try to destroy the old_room if it is not needed anymore self._destroy_room(old_room) - except KeyError: + else: # There is no room yet at new_location - if (old_room and not inherits_from(old_room, WildernessRoom)) or (not old_room): - # Obj doesn't originally come from a wilderness room. - # We'll create a new one then. - room = self._create_room(new_coordinates, obj) - else: - # Obj does come from another wilderness room - create_new_room = False + # Is the old room in a wilderness? + if hasattr(old_room, "wilderness"): + # Yes. Is it in THIS wilderness? + if old_room.wilderness == self: + # Should we preserve rooms with any objects? + if self.preserve_items: + # Yes - check if ANY objects besides the exits are in old_room + if len([ob for ob in old_room.contents if not inherits_from(ob, WildernessExit)]): + # There is, so we'll create a new room + room = self._create_room(new_coordinates, obj) + else: + # The room is empty, so we'll reuse it + room = old_room + else: + # Only preserve rooms if there are players behind + if len([ob for ob in old_room.contents if ob.has_account]): + # There is still a player there; create a new room + room = self._create_room(new_coordinates, obj) + else: + # The room is empty of players, so we'll reuse it + room = old_room - if old_room.wilderness != self: - # ... but that other wilderness room belongs to another - # wilderness map - create_new_room = True + # It's in a different wilderness + else: + # It does, so we make sure to leave the other wilderness properly old_room.wilderness.at_post_object_leave(obj) - else: - for item in old_room.contents: - if item.has_account: - # There is still a player in the old room. - # Let's create a new room and not touch that old - # room. - create_new_room = True - break - - if create_new_room: - # Create a new room to hold obj, not touching any obj's in - # the old room + # We'll also need to create a new room in this wilderness room = self._create_room(new_coordinates, obj) - else: - # The old_room is empty: we are just going to reuse that - # room instead of creating a new one - room = old_room - room.set_active_coordinates(new_coordinates, obj) + else: + # Obj comes from outside the wilderness entirely + # We need to make a new room + room = self._create_room(new_coordinates, obj) + + # Set `room` to the new coordinates, however it was made + room.set_active_coordinates(new_coordinates, obj) + + # Put obj back, now in the correct room obj.location = room obj.ndb.wilderness = self
@@ -503,7 +500,11 @@ def _destroy_room(self, room): """ Moves a room back to storage. If room is not a WildernessRoom or there - is a player inside the room, then this does nothing. + is something left inside the room, then this does nothing. + + Implementation note: If `preserve_items` is False (the default) then any + objects left in the rooms will be moved to None. You may want to implement + your own cleanup or recycling routine for these objects. Args: room (WildernessRoom): the room to put in storage @@ -511,25 +512,30 @@ if not room or not inherits_from(room, WildernessRoom): return + # Check the contents of the room before recycling for item in room.contents: if item.has_account: - # There is still a character in that room. We can't get rid of - # it just yet - break - else: - # No characters left in the room. + # There is still a player in this room, we can't delete it yet. + return - # Clear the location of every obj in that room first - for item in room.contents: - if item.destination and item.destination == room: - # Ignore the exits, they stay in the room - continue - item.location = None + if not (item.destination and item.destination == room): + # There is still a non-exit object in the room. Should we preserve it? + if self.preserve_items: + # Yes, so we can't get rid of the room just yet + return - # Then delete its reference - del self.db.rooms[room.ndb.active_coordinates] - # And finally put this room away in storage - self.db.unused_rooms.append(room) + # If we get here, the room can be recycled + # Clear the location of any objects left in that room first + for item in room.contents: + if item.destination and item.destination == room: + # Ignore the exits, they stay in the room + continue + item.location = None + + # Then delete its coordinate reference + del self.db.rooms[room.ndb.active_coordinates] + # And finally put this room away in storage + self.db.unused_rooms.append(room)
[docs] def at_post_object_leave(self, obj): """ @@ -538,13 +544,13 @@ Args: obj (object): the object that left """ - # Remove that obj from the wilderness's coordinates dict - loc = self.db.itemcoordinates[obj] - del self.db.itemcoordinates[obj] - - # And see if we can put that room away into storage. - room = self.db.rooms[loc] - self._destroy_room(room)
+ # Try removing the object from the coordinates system + if loc := self.db.itemcoordinates.pop(obj, None): + # The object was removed successfully + # Make sure there was a room at that location + if room := self.db.rooms.get(loc): + # If so, try to clean up the room + self._destroy_room(room)
[docs]class WildernessRoom(DefaultRoom): @@ -600,21 +606,13 @@ # n, ne, ... exits. return - itemcoords = self.wilderness.db.itemcoordinates + itemcoords = self.wilderness.itemcoordinates if moved_obj in itemcoords: # This object was already in the wilderness. We need to make sure # it goes to the correct room it belongs to. - # Otherwise the following issue can come up: - # 1) Player 1 and Player 2 share a room - # 2) Player 1 disconnects - # 3) Player 2 moves around - # 4) Player 1 reconnects - # Player 1 will end up in player 2's room, which has the wrong - # coordinates - coordinates = itemcoords[moved_obj] # Setting the location to None is important here so that we always - # get a "fresh" room + # get a "fresh" room if it was in the wrong place moved_obj.location = None self.wilderness.move_obj(moved_obj, coordinates) else: @@ -642,14 +640,16 @@ obj (Object): the object that moved into this room and caused the coordinates to change """ - # Remove the reference for the old coordinates... + # Remove any reference for the old coordinates... rooms = self.wilderness.db.rooms - del rooms[self.coordinates] + if self.coordinates: + del rooms[self.coordinates] # ...and add it for the new coordinates. self.ndb.active_coordinates = new_coordinates rooms[self.coordinates] = self - # Every obj inside this room will get its location set to None + # Any object inside this room will get its location set to None + # unless it's a wilderness exit for item in self.contents: if not item.destination or item.destination != item.location: item.location = None @@ -678,6 +678,7 @@
[docs] def get_display_name(self, looker, **kwargs): """ Displays the name of the object in a viewer-aware manner. + This is a core evennia hook. Args: looker (TypedObject): The object or account that is looking @@ -701,8 +702,22 @@ name = self.location_name name += " {0}".format(self.coordinates) - return name
+ return name + +
[docs] def get_display_desc(self, looker, **kwargs): + """ + Displays the description of the room. This is a core evennia hook. + + Allows the room's description to be customized in an ndb value, + avoiding having to write to the database on moving. + """ + # Check if a new description was prepared by the map provider + if self.ndb.active_desc: + # There is one: use it + return self.ndb.active_desc + # Otherwise, use the normal description hook. + return super().get_display_desc(looker, **kwargs)
[docs]class WildernessExit(DefaultExit): """ diff --git a/docs/1.0-dev/_sources/Contribs/Contrib-Wilderness.md.txt b/docs/1.0-dev/_sources/Contribs/Contrib-Wilderness.md.txt index bac22e1f6e..8a53fd7bcc 100644 --- a/docs/1.0-dev/_sources/Contribs/Contrib-Wilderness.md.txt +++ b/docs/1.0-dev/_sources/Contribs/Contrib-Wilderness.md.txt @@ -5,7 +5,7 @@ Contribution by titeuf87, 2017 This contrib provides a wilderness map without actually creating a large number of rooms - as you move, you instead end up back in the same room but its description changes. This means you can make huge areas with little database use as -long as the rooms are relatively similar (name/desc changing). +long as the rooms are relatively similar (e.g. only the names/descs changing). ## Installation @@ -29,6 +29,9 @@ All coordinates used by the wilderness map are in the format of `(x, y)` tuples. x goes from left to right and y goes from bottom to top. So `(0, 0)` is the bottom left corner of the map. +> You can also add a wilderness by defining a WildernessScript in your GLOBAL_SCRIPT +> settings. If you do, make sure define the map provider. + ## Customisation The defaults, while useable, are meant to be customised. When creating a @@ -37,9 +40,14 @@ python object that is smart enough to create the map. The default provider, `WildernessMapProvider`, just creates a grid area that is unlimited in size. -This `WildernessMapProvider` can be subclassed to create more interesting + +`WildernessMapProvider` can be subclassed to create more interesting maps and also to customize the room/exit typeclass used. +The `WildernessScript` also has an optional `preserve_items` property, which +when set to `True` will not recycle rooms that contain any objects. By default, +a wilderness room is recycled whenever there are no players left in it. + There is also no command that allows players to enter the wilderness. This still needs to be added: it can be a command or an exit, depending on your needs. @@ -94,7 +102,7 @@ class PyramidMapProvider(wilderness.WildernessMapProvider): desc = "This is a room in the pyramid." if y == 3 : desc = "You can see far and wide from the top of the pyramid." - room.db.desc = desc + room.ndb.desc = desc ``` Now we can use our new pyramid-shaped wilderness map. From inside Evennia we @@ -105,12 +113,16 @@ create a new wilderness (with the name "default") but using our new map provider ## Implementation details -When a character moves into the wilderness, they get their own room. If they -move, instead of moving the character, the room changes to match the new -coordinates. If a character meets another character in the wilderness, then -their room merges. When one of the character leaves again, they each get their -own separate rooms. Rooms are created as needed. Unneeded rooms are stored away -to avoid the overhead cost of creating new rooms again in the future. +When a character moves into the wilderness, they get their own room. If +they move, instead of moving the character, the room changes to match the +new coordinates. + +If a character meets another character in the wilderness, then their room +merges. When one of the character leaves again, they each get their own +separate rooms. + +Rooms are created as needed. Unneeded rooms are stored away to avoid the +overhead cost of creating new rooms again in the future. ---- diff --git a/docs/1.0-dev/_sources/Contribs/Contribs-Overview.md.txt b/docs/1.0-dev/_sources/Contribs/Contribs-Overview.md.txt index 5a5fe67a53..5c30caea58 100644 --- a/docs/1.0-dev/_sources/Contribs/Contribs-Overview.md.txt +++ b/docs/1.0-dev/_sources/Contribs/Contribs-Overview.md.txt @@ -463,7 +463,7 @@ _Contribution by titeuf87, 2017_ This contrib provides a wilderness map without actually creating a large number of rooms - as you move, you instead end up back in the same room but its description changes. This means you can make huge areas with little database use as -long as the rooms are relatively similar (name/desc changing). +long as the rooms are relatively similar (e.g. only the names/descs changing). [Read the documentation](./Contrib-Wilderness.md) - [Browse the Code](evennia.contrib.grid.wilderness) 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 06db7747d2..44ff96846b 100644 --- a/docs/1.0-dev/api/evennia.commands.default.building.html +++ b/docs/1.0-dev/api/evennia.commands.default.building.html @@ -592,7 +592,7 @@ You can specify the /force switch to bypass this confirmation.

-aliases = ['@delete', '@del']
+aliases = ['@del', '@delete']
@@ -633,7 +633,7 @@ You can specify the /force switch to bypass this confirmation.

-search_index_entry = {'aliases': '@delete @del', 'category': 'building', 'key': '@destroy', 'no_prefix': 'destroy delete del', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}
+search_index_entry = {'aliases': '@del @delete', 'category': 'building', 'key': '@destroy', 'no_prefix': 'destroy del delete', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}
@@ -1345,7 +1345,7 @@ server settings.

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

-search_index_entry = {'aliases': '@type @swap @update @typeclasses @parent', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass type swap 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': '@typeclasses @update @parent @type @swap', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass typeclasses update parent type swap', '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.comms.html b/docs/1.0-dev/api/evennia.commands.default.comms.html index c2f746c095..c78ef6328f 100644 --- a/docs/1.0-dev/api/evennia.commands.default.comms.html +++ b/docs/1.0-dev/api/evennia.commands.default.comms.html @@ -256,7 +256,7 @@ ban mychannel1,mychannel2= EvilUser : Was banned for spamming.

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

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

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

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

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

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

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

-search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
+search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
diff --git a/docs/1.0-dev/api/evennia.commands.default.system.html b/docs/1.0-dev/api/evennia.commands.default.system.html index 972851c8a4..e450185933 100644 --- a/docs/1.0-dev/api/evennia.commands.default.system.html +++ b/docs/1.0-dev/api/evennia.commands.default.system.html @@ -683,7 +683,7 @@ See |luhttps://ww
-aliases = ['@delays', '@task']
+aliases = ['@task', '@delays']
@@ -729,7 +729,7 @@ to all the variables defined therein.

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

Test the batch processor.

-red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpk82ky06k/62c2558e985dde08c5adcf4fac22b6a2ef5e778f/evennia/contrib/tutorials/red_button/red_button.py'>
+red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmprttw_f_s/0096df1e3ee772477e1fa108545329384f32ff54/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 0cdc30fe15..4c82193240 100644 --- a/docs/1.0-dev/api/evennia.commands.default.unloggedin.html +++ b/docs/1.0-dev/api/evennia.commands.default.unloggedin.html @@ -122,7 +122,7 @@ connect “account name” “pass word”

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

-search_index_entry = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn co con', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}
+search_index_entry = {'aliases': 'conn con co', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn con co', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}
@@ -236,7 +236,7 @@ version is a bit more complicated.

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

-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 '}
+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 '}
@@ -335,7 +335,7 @@ for simplicity. It shows a pane of info.

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

-search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
+search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
diff --git a/docs/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 bd7fc8fe56..a9e029b763 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 @@ -139,7 +139,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.

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

-search_index_entry = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn co con', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}
+search_index_entry = {'aliases': 'conn con co', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn con co', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}
@@ -246,7 +246,7 @@ version is a bit more complicated.

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

-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 '}
+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 '}
@@ -335,7 +335,7 @@ for simplicity. It shows a pane of info.

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

-search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
+search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
diff --git a/docs/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 bb080d9107..8f64615a91 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 @@ -116,7 +116,7 @@
-aliases = ['@calls', '@callback', '@callbacks']
+aliases = ['@calls', '@callbacks', '@callback']
@@ -197,7 +197,7 @@ on user permission.

-search_index_entry = {'aliases': '@calls @callback @callbacks', 'category': 'building', 'key': '@call', 'no_prefix': 'call calls callback 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.base_systems.mux_comms_cmds.mux_comms_cmds.html b/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html index 4c48a7e43f..4a6704c4be 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html @@ -160,7 +160,7 @@ aliases to an already joined channel.

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

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

-aliases = ['delchanalias', 'delaliaschan']
+aliases = ['delaliaschan', 'delchanalias']
@@ -248,7 +248,7 @@ for that channel.

-search_index_entry = {'aliases': 'delchanalias delaliaschan', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delchanalias delaliaschan', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}
+search_index_entry = {'aliases': 'delaliaschan delchanalias', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delaliaschan delchanalias', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}
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 322baef978..fcbee393f0 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 @@ -211,7 +211,7 @@ the operation will be general or on the room.

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

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

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

-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 '}
+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 '}
@@ -490,7 +490,7 @@ looks and what actions is available.

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

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

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

-search_index_entry = {'aliases': 'inv give inventory i', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inv give inventory i', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
+search_index_entry = {'aliases': 'inventory give i inv', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inventory give i inv', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
@@ -626,7 +626,7 @@ set in self.parse())

-aliases = ['@dig', '@open']
+aliases = ['@open', '@dig']
@@ -649,7 +649,7 @@ to all the variables defined therein.

-search_index_entry = {'aliases': '@dig @open', 'category': 'general', 'key': 'open', 'no_prefix': ' dig open', 'tags': '', 'text': '\n Interact with an object in focus.\n\n Usage:\n <action> [arg]\n\n '}
+search_index_entry = {'aliases': '@open @dig', 'category': 'general', 'key': 'open', 'no_prefix': ' open dig', 'tags': '', 'text': '\n Interact with an object in focus.\n\n Usage:\n <action> [arg]\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 9755fdb7f3..669695bb9f 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 @@ -692,7 +692,7 @@ inv

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

-search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
+search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
diff --git a/docs/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 25ebb9630c..28d785b62d 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 @@ -672,7 +672,7 @@ if there are still any actions you can take.

-aliases = ['hold', 'wait']
+aliases = ['wait', 'hold']
@@ -698,7 +698,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 0fb36afa54..85e1ac5c29 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 @@ -567,7 +567,7 @@ if there are still any actions you can take.

-aliases = ['hold', 'wait']
+aliases = ['wait', 'hold']
@@ -587,7 +587,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 b491101cea..1228c03d81 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 @@ -690,7 +690,7 @@ if there are still any actions you can take.

-aliases = ['hold', 'wait']
+aliases = ['wait', 'hold']
@@ -710,7 +710,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 41ea08d804..3bfc041b0b 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 @@ -469,7 +469,7 @@ if there are still any actions you can take.

-aliases = ['hold', 'wait']
+aliases = ['wait', 'hold']
@@ -489,7 +489,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 eca07b30fa..80df9f0e01 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 @@ -929,7 +929,7 @@ if there are still any actions you can take.

-aliases = ['hold', 'wait']
+aliases = ['wait', 'hold']
@@ -949,7 +949,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.wilderness.tests.html b/docs/1.0-dev/api/evennia.contrib.grid.wilderness.tests.html index c80c2ca4d3..976109eafb 100644 --- a/docs/1.0-dev/api/evennia.contrib.grid.wilderness.tests.html +++ b/docs/1.0-dev/api/evennia.contrib.grid.wilderness.tests.html @@ -159,6 +159,11 @@ test_get_new_coordinates()[source]
+
+
+test_preserve_items()[source]
+
+
diff --git a/docs/1.0-dev/api/evennia.contrib.grid.wilderness.wilderness.html b/docs/1.0-dev/api/evennia.contrib.grid.wilderness.wilderness.html index e48c377ab4..653c328259 100644 --- a/docs/1.0-dev/api/evennia.contrib.grid.wilderness.wilderness.html +++ b/docs/1.0-dev/api/evennia.contrib.grid.wilderness.wilderness.html @@ -143,10 +143,10 @@ is the bottom left corner of the map.

The defaults, while useable, are meant to be customised. When creating a new wilderness map it is possible to give a “map provider”: this is a python object that is smart enough to create the map.

-

The default provider, WildernessMapProvider, just creates a grid area that -is unlimited in size. -This WildernessMapProvider can be subclassed to create more interesting -maps and also to customize the room/exit typeclass used.

+

The default provider, WildernessMapProvider, creates a grid area that +is unlimited in size.

+

WildernessMapProvider can be subclassed to create more interesting maps +and also to customize the room/exit typeclass used.

There is also no command that allows players to enter the wilderness. This still needs to be added: it can be a command or an exit, depending on your needs.

@@ -199,7 +199,7 @@ provided as a string: a “.” symbol is a location we can walk on.

desc = "This is a room in the pyramid." if y == 3 : desc = "You can see far and wide from the top of the pyramid." - room.db.desc = desc + room.ndb.desc = desc

Now we can use our new pyramid-shaped wilderness map. From inside Evennia we @@ -214,16 +214,16 @@ py from evennia.contrib import wilderness; wilderness.enter_wilderness(me, coord

When a character moves into the wilderness, they get their own room. If they move, instead of moving the character, the room changes to match the -new coordinates. -If a character meets another character in the wilderness, then their room +new coordinates.

+

If a character meets another character in the wilderness, then their room merges. When one of the character leaves again, they each get their own -separate rooms. -Rooms are created as needed. Unneeded rooms are stored away to avoid the +separate rooms.

+

Rooms are created as needed. Unneeded rooms are stored away to avoid the overhead cost of creating new rooms again in the future.

-evennia.contrib.grid.wilderness.wilderness.create_wilderness(name='default', mapprovider=None)[source]
+evennia.contrib.grid.wilderness.wilderness.create_wilderness(name='default', mapprovider=None, preserve_items=False)[source]

Creates a new wilderness map. Does nothing if a wilderness map already exists with the same name.

@@ -285,6 +285,48 @@ default one

coordinates of every item currently inside the wilderness is stored. This script is responsible for creating rooms as needed and storing rooms away into storage when they are not needed anymore.

+
+
+mapprovider
+

Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’ +on the class level. Note that while one can set a lock on the Attribute, +there is no way to check said lock when accessing via the property - use +the full AttributeHandler if you need to do access checks.

+

Example:

+
class Character(DefaultCharacter):
+    foo = AttributeProperty(default="Bar")
+
+
+
+ +
+
+itemcoordinates
+

Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’ +on the class level. Note that while one can set a lock on the Attribute, +there is no way to check said lock when accessing via the property - use +the full AttributeHandler if you need to do access checks.

+

Example:

+
class Character(DefaultCharacter):
+    foo = AttributeProperty(default="Bar")
+
+
+
+ +
+
+preserve_items
+

Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’ +on the class level. Note that while one can set a lock on the Attribute, +there is no way to check said lock when accessing via the property - use +the full AttributeHandler if you need to do access checks.

+

Example:

+
class Character(DefaultCharacter):
+    foo = AttributeProperty(default="Bar")
+
+
+
+
at_script_creation()[source]
@@ -293,33 +335,9 @@ hook.

-
-property mapprovider
-

Shortcut property to the map provider.

-
-
Returns
-

MapProvider – the mapprovider used with this wilderness

-
-
-
- -
-
-property itemcoordinates
-

Returns a dictionary with the coordinates of every item inside this -wilderness map. The key is the item, the value are the coordinates as -(x, y) tuple.

-
-
Returns
-

{item – coordinates}

-
-
-
- -
-
-at_start()[source]
-

Called when the script is started and also after server reloads.

+
+at_server_start()[source]
+

Called after the server is started or reloaded.

@@ -512,7 +530,8 @@ coordinates to change

get_display_name(looker, **kwargs)[source]
-

Displays the name of the object in a viewer-aware manner.

+

Displays the name of the object in a viewer-aware manner. +This is a core evennia hook.

Parameters

looker (TypedObject) – The object or account that is looking @@ -536,6 +555,14 @@ searching, and is expected to produce something useful for builders.

+
+
+get_display_desc(looker, **kwargs)[source]
+

Displays the description of the room. This is a core evennia hook.

+

Allows the room’s description to be customized in an ndb value, +avoiding having to write to the database on moving.

+
+
exception DoesNotExist
diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html b/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html index 3790a76f77..86b5f2e8c6 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html @@ -256,7 +256,7 @@ set in self.parse())

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

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

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

-search_index_entry = {'aliases': 'unwield unwear', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwield unwear', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}
+search_index_entry = {'aliases': 'unwear unwield', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwear unwield', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}
diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html b/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html index 2d7628c033..54de6087ea 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html @@ -153,7 +153,7 @@ such as when closing the lid and un-blinding a character.

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

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

-aliases = ['smash lid', 'break lid', 'smash']
+aliases = ['break lid', 'smash lid', 'smash']
@@ -279,7 +279,7 @@ break.

-search_index_entry = {'aliases': 'smash lid break lid smash', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' smash lid break lid smash', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}
+search_index_entry = {'aliases': 'break lid smash lid smash', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' break lid smash lid smash', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}
@@ -379,7 +379,7 @@ be mutually exclusive.

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

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

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

-search_index_entry = {'aliases': 'get examine ex feel listen l', 'category': 'general', 'key': 'look', 'no_prefix': ' get examine ex feel listen l', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}
+search_index_entry = {'aliases': 'listen feel l ex get examine', 'category': 'general', 'key': 'look', 'no_prefix': ' listen feel l ex get examine', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}
diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html index f9caa7c0d3..efa2f455db 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html @@ -425,7 +425,7 @@ of the object. We overload it with our own version.

-aliases = ['light', 'burn']
+aliases = ['burn', 'light']
@@ -452,7 +452,7 @@ to sit on a “lightable” object, we operate only on self.obj.

-search_index_entry = {'aliases': 'light burn', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' light burn', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}
+search_index_entry = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' burn light', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}
@@ -556,7 +556,7 @@ shift green root up/down

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

-search_index_entry = {'aliases': 'push pull shiftroot move', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' push pull shiftroot move', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}
+search_index_entry = {'aliases': 'shiftroot pull push move', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' shiftroot pull push move', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}
@@ -609,7 +609,7 @@ yellow/green - horizontal roots

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

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

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

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

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

-search_index_entry = {'aliases': 'h ?', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}
+search_index_entry = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}
@@ -968,7 +968,7 @@ to find something.

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

-search_index_entry = {'aliases': 'search feel feel around fiddle l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' search feel feel around fiddle l', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}
+search_index_entry = {'aliases': 'search fiddle feel around feel l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' search fiddle feel around feel l', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}
diff --git a/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html b/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html index 7b786db07d..9f9e20a974 100644 --- a/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html +++ b/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html @@ -208,7 +208,7 @@ git evennia pull - Pull the latest evennia code.

-directory = '/tmp/tmpk82ky06k/62c2558e985dde08c5adcf4fac22b6a2ef5e778f/evennia'
+directory = '/tmp/tmprttw_f_s/0096df1e3ee772477e1fa108545329384f32ff54/evennia'
@@ -269,7 +269,7 @@ git pull - Pull the latest code from your current branch.

-directory = '/tmp/tmpk82ky06k/62c2558e985dde08c5adcf4fac22b6a2ef5e778f/evennia/game_template'
+directory = '/tmp/tmprttw_f_s/0096df1e3ee772477e1fa108545329384f32ff54/evennia/game_template'
diff --git a/docs/1.0-dev/api/evennia.utils.eveditor.html b/docs/1.0-dev/api/evennia.utils.eveditor.html index ded518f180..6707993b8d 100644 --- a/docs/1.0-dev/api/evennia.utils.eveditor.html +++ b/docs/1.0-dev/api/evennia.utils.eveditor.html @@ -336,7 +336,7 @@ indentation.

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

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

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

-search_index_entry = {'aliases': 'y a no n abort __nomatch_command yes', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' y a no n abort __nomatch_command yes', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}
+search_index_entry = {'aliases': 'a no __nomatch_command abort yes n y', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' a no __nomatch_command abort yes n 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 91065c4934..291bfe421b 100644 --- a/docs/1.0-dev/api/evennia.utils.evmore.html +++ b/docs/1.0-dev/api/evennia.utils.evmore.html @@ -137,7 +137,7 @@ the caller.msg() construct every time the page is updated.

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

-search_index_entry = {'aliases': 'top a t previous n quit e end q abort p next', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' top a t previous n quit e end q abort p next', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
+search_index_entry = {'aliases': 'a end e top t quit previous p q next abort n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' a end e top t quit previous p q next abort n', '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 052f021b4e..ff0f4f588b 100644 --- a/docs/1.0-dev/genindex.html +++ b/docs/1.0-dev/genindex.html @@ -2560,6 +2560,8 @@
  • at_server_start() (evennia.contrib.base_systems.ingame_python.scripts.EventHandler method)
  • get_display_characters() (evennia.objects.objects.DefaultObject method)
    • -
  • get_display_desc() (evennia.contrib.tutorials.evadventure.objects.EvAdventureObject method) +
  • get_display_desc() (evennia.contrib.grid.wilderness.wilderness.WildernessRoom method)
    • @@ -10200,11 +10202,11 @@
  • get_events() (evennia.contrib.base_systems.ingame_python.scripts.EventHandler method)
  • get_exit() (evennia.contrib.grid.xyzgrid.xyzgrid.XYZGrid method) -
    • -
  • get_exit_spawn_name() (evennia.contrib.grid.xyzgrid.xymap_legend.MapNode method)