mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
Fix ObjManipCommand docstring. Update Changelog
This commit is contained in:
parent
dcc4dce7e1
commit
b0fff26a4f
3 changed files with 35 additions and 29 deletions
11
CHANGELOG.md
11
CHANGELOG.md
|
|
@ -5,13 +5,24 @@
|
|||
- [Feature][pull3470]: New `exit_order` kwarg to
|
||||
`DefaultObject.get_display_exits` to easier customize the order in which
|
||||
standard exits are displayed in a room (chiizujin)
|
||||
- [Feature][pull3498]: Properly update Evennia's screen width when client
|
||||
changes width (assuming client supports NAWS properly) (michaelfaith84)
|
||||
- [Fix][pull3495]: Fix rate in Trait contribs not updating after reload (jaborsh)
|
||||
- [Fix][pull3491]: Fix traceback in EvEditor when searching with malformed regex (chiizujin)
|
||||
- [Fix][pull3489]: Superuser could break wilderness contrib exits (t34lbytes)
|
||||
- [Fix][pull3496]: EvEditor would not correctly show search&replace feedback
|
||||
when replacing colors (Chiizujin)
|
||||
- [Fix][pull3499]: Dig/tunnel commands didn't echo the typeclass of the newly
|
||||
created room properly (chiizujin)
|
||||
- [Docs]: Doc fixes (Griatch, chiizujin)
|
||||
|
||||
[pull3470]: https://github.com/evennia/evennia/pull/3470
|
||||
[pull3495]: https://github.com/evennia/evennia/pull/3495
|
||||
[pull3491]: https://github.com/evennia/evennia/pull/3491
|
||||
[pull3489]: https://github.com/evennia/evennia/pull/3489
|
||||
[pull3496]: https://github.com/evennia/evennia/pull/3496
|
||||
[pull3498]: https://github.com/evennia/evennia/pull/3498
|
||||
[pull3499]: https://github.com/evennia/evennia/pull/3499
|
||||
|
||||
|
||||
## Evennia 4.1.1
|
||||
|
|
|
|||
|
|
@ -5,13 +5,13 @@ Building and world design commands
|
|||
import re
|
||||
import typing
|
||||
|
||||
import evennia
|
||||
from django.conf import settings
|
||||
from django.core.paginator import Paginator
|
||||
from django.db.models import Max, Min, Q
|
||||
|
||||
import evennia
|
||||
from evennia import InterruptCommand
|
||||
from evennia.commands.cmdhandler import generate_cmdset_providers, get_and_merge_cmdsets
|
||||
from evennia.commands.cmdhandler import (generate_cmdset_providers,
|
||||
get_and_merge_cmdsets)
|
||||
from evennia.locks.lockhandler import LockException
|
||||
from evennia.objects.models import ObjectDB
|
||||
from evennia.prototypes import menus as olc_menus
|
||||
|
|
@ -24,18 +24,10 @@ from evennia.utils.dbserialize import deserialize
|
|||
from evennia.utils.eveditor import EvEditor
|
||||
from evennia.utils.evmore import EvMore
|
||||
from evennia.utils.evtable import EvTable
|
||||
from evennia.utils.utils import (
|
||||
class_from_module,
|
||||
crop,
|
||||
dbref,
|
||||
display_len,
|
||||
format_grid,
|
||||
get_all_typeclasses,
|
||||
inherits_from,
|
||||
interactive,
|
||||
list_to_string,
|
||||
variable_from_module,
|
||||
)
|
||||
from evennia.utils.utils import (class_from_module, crop, dbref, display_len,
|
||||
format_grid, get_all_typeclasses,
|
||||
inherits_from, interactive, list_to_string,
|
||||
variable_from_module)
|
||||
|
||||
COMMAND_DEFAULT_CLASS = class_from_module(settings.COMMAND_DEFAULT_CLASS)
|
||||
|
||||
|
|
@ -178,26 +170,30 @@ class ObjManipCommand(COMMAND_DEFAULT_CLASS):
|
|||
|
||||
def get_object_typeclass(
|
||||
self, obj_type: str = "object", typeclass: str = None, method: str = "cmd_create", **kwargs
|
||||
) -> tuple[typing.Optional["Builder"], list[str]]:
|
||||
) -> tuple[typing.Optional['Typeclass'], list[str]]:
|
||||
"""
|
||||
This hook is called by build commands to determine which typeclass to use for a specific purpose. For instance,
|
||||
when using dig, the system can use this to autodetect which kind of Room typeclass to use based on where the
|
||||
builder is currently located.
|
||||
|
||||
Note: Although intended to be used with typeclasses, as long as this hook returns a class with a create method,
|
||||
which accepts the same API as DefaultObject.create(), build commands and other places should take it.
|
||||
This hook is called by build commands to determine which typeclass to use for a specific
|
||||
purpose.
|
||||
|
||||
Args:
|
||||
obj_type (str, optional): The type of object that is being created. Defaults to "object". Evennia provides
|
||||
"room", "exit", and "character" by default, but this can be extended.
|
||||
typeclass (str, optional): The typeclass that was requested by the player. Defaults to None.
|
||||
Can also be an actual class.
|
||||
obj_type (str, optional): The type of object that is being created. Defaults to
|
||||
"object". Evennia provides "room", "exit", and "character" by default, but this can be
|
||||
extended.
|
||||
typeclass (str, optional): The typeclass that was requested by the player. Defaults to
|
||||
None. Can also be an actual class.
|
||||
method (str, optional): The method that is calling this hook. Defaults to "cmd_create".
|
||||
Others are "cmd_dig", "cmd_open", "cmd_tunnel", etc.
|
||||
|
||||
Returns:
|
||||
results_tuple (tuple[Optional[Builder], list[str]]): A tuple containing the typeclass to use and a list of
|
||||
errors. (which might be empty.)
|
||||
tuple: A tuple containing the typeclass to use and a list of errors. (which might be
|
||||
empty.)
|
||||
|
||||
Notes:
|
||||
Although intended to be used with typeclasses, as long as this hook returns a class with
|
||||
a create method, which accepts the same API as DefaultObject.create(), build commands
|
||||
and other places should take it. While not used by default, one could picture using this
|
||||
for things like autodetecting which room to build next based on the current location.
|
||||
|
||||
"""
|
||||
|
||||
found_typeclass = typeclass or self.default_typeclasses.get(obj_type, None)
|
||||
|
|
|
|||
|
|
@ -9,7 +9,6 @@ Communication commands:
|
|||
|
||||
from django.conf import settings
|
||||
from django.db.models import Q
|
||||
|
||||
from evennia.accounts import bots
|
||||
from evennia.accounts.models import AccountDB
|
||||
from evennia.comms.comms import DefaultChannel
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue