Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improving documentation.

Browse source
This commit is contained in:
Andrew Bastien 2022-07-11 21:52:52 -04:00
parent c99cd45f93
commit 93aae906bf
1 changed files with 14 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

18
evennia/objects/objects.py
View file

@ -858,10 +858,11 @@ class DefaultObject(ObjectDB, metaclass=TypeclassBase):
move_hooks (bool): If False, turn off the calling of move-related hooks move_hooks (bool): If False, turn off the calling of move-related hooks
(at_pre/post_move etc) with quiet=True, this is as quiet a move (at_pre/post_move etc) with quiet=True, this is as quiet a move
as can be done. as can be done.
move_type (str): Will be used for generating the text tuple {"type": move_type}, move_type (str): The "kind of move" being performed, such as "teleport", "traverse",
and can be used for log filtering in hooks. Evennia has only a few "get", "give", or "drop". The value can be arbitrary. By default, it only affects
move_types for move_to to start with, like "teleport", "traverse", the text message generated by announce_move_to and announce_move_from by defining
"get", "give", and "drop". their {"type": move_type} for outgoing text. This can be used for altering
messages and/or overloaded hook behaviors.
Keyword Args: Keyword Args:
Passed on to announce_move_to and announce_move_from hooks. Passed on to announce_move_to and announce_move_from hooks.
@ -1513,6 +1514,9 @@ class DefaultObject(ObjectDB, metaclass=TypeclassBase):
msg (str, optional): a replacement message. msg (str, optional): a replacement message.
mapping (dict, optional): additional mapping objects. mapping (dict, optional): additional mapping objects.
move_type (str): The type of move. "give", "traverse", etc. move_type (str): The type of move. "give", "traverse", etc.
This is an arbitrary string provided to obj.move_to().
Useful for altering messages or altering logic depending
on the kind of movement.
**kwargs (dict): Arbitrary, optional arguments for users **kwargs (dict): Arbitrary, optional arguments for users
overriding the call (unused by default). overriding the call (unused by default).
@ -1560,6 +1564,9 @@ class DefaultObject(ObjectDB, metaclass=TypeclassBase):
msg (str, optional): the replacement message if location. msg (str, optional): the replacement message if location.
mapping (dict, optional): additional mapping objects. mapping (dict, optional): additional mapping objects.
move_type (str): The type of move. "give", "traverse", etc. move_type (str): The type of move. "give", "traverse", etc.
This is an arbitrary string provided to obj.move_to().
Useful for altering messages or altering logic depending
on the kind of movement.
**kwargs (dict): Arbitrary, optional arguments for users **kwargs (dict): Arbitrary, optional arguments for users
overriding the call (unused by default). overriding the call (unused by default).
@ -1655,6 +1662,9 @@ class DefaultObject(ObjectDB, metaclass=TypeclassBase):
source_location (Object): Where `moved_object` came from. source_location (Object): Where `moved_object` came from.
Note that this could be `None`. Note that this could be `None`.
move_type (str): The type of move. "give", "traverse", etc. move_type (str): The type of move. "give", "traverse", etc.
This is an arbitrary string provided to obj.move_to().
Useful for altering messages or altering logic depending
on the kind of movement.
**kwargs (dict): Arbitrary, optional arguments for users **kwargs (dict): Arbitrary, optional arguments for users
overriding the call (unused by default). overriding the call (unused by default).