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

Formatted docstring in Google Style.

Browse source
This commit is contained in:
tajmone 2015-04-07 17:54:56 +02:00
parent a074b072a5
commit b7ace5ce88
1 changed files with 12 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

23
evennia/objects/objects.py
View file

@ -483,8 +483,8 @@ class DefaultObject(ObjectDB):
Args: Args:
destination (Object): Reference to the object to move to. This destination (Object): Reference to the object to move to. This
can also be an exit object, in which case the can also be an exit object, in which case the
destination property is used as destination. destination property is used as destination.
quiet (bool): If true, turn off the calling of the emit hooks quiet (bool): If true, turn off the calling of the emit hooks
(announce_move_to/from etc) (announce_move_to/from etc)
emit_to_obj (Object): object to receive error messages emit_to_obj (Object): object to receive error messages
@ -494,13 +494,14 @@ class DefaultObject(ObjectDB):
to_none (bool): Allow destination to be None. Note that no hooks are run when to_none (bool): Allow destination to be None. Note that no hooks are run when
moving to a None location. If you want to run hooks, run them manually moving to a None location. If you want to run hooks, run them manually
(and make sure they can manage None locations). (and make sure they can manage None locations).
move_hooks (bool): If False, turn off the calling of move-related hooks (at_before/after_move etc) move_hooks (bool): If False, turn off the calling of move-related hooks
with quiet=True, this is as quiet a move as can be done. (at_before/after_move etc) with quiet=True, this is as quiet a move
as can be done.
Returns: Returns:
result (bool): True/False depending on if there were problems with the move. result (bool): True/False depending on if there were problems with the move.
This method may also return various error messages to the This method may also return various error messages to the
emit_to_obj. `emit_to_obj`.
Notes: Notes:
No access checks are done in this method, these should be handled before No access checks are done in this method, these should be handled before
@ -509,12 +510,12 @@ class DefaultObject(ObjectDB):
The `DefaultObject` hooks called (if `move_hooks=True`) are, in order: The `DefaultObject` hooks called (if `move_hooks=True`) are, in order:
1. `self.at_before_move(destination)` (if this returns False, move is aborted) 1. `self.at_before_move(destination)` (if this returns False, move is aborted)
1. `source_location.at_object_leave(self, destination)` 2. `source_location.at_object_leave(self, destination)`
1. `self.announce_move_from(destination)` 3. `self.announce_move_from(destination)`
1. (move happens here) 4. (move happens here)
1. `self.announce_move_to(source_location)` 5. `self.announce_move_to(source_location)`
1. `destination.at_object_receive(self, source_location)` 6. `destination.at_object_receive(self, source_location)`
1. `self.at_after_move(source_location)` 7. `self.at_after_move(source_location)`
""" """
def logerr(string=""): def logerr(string=""):