From 47fa88e0fcba8f98701f7b3abf7df059deace353 Mon Sep 17 00:00:00 2001 From: Griatch Date: Tue, 20 Sep 2016 16:30:23 +0200 Subject: [PATCH] Slight rephrasing of a docstring. --- evennia/objects/objects.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 5f3a234d1b..f2d21ca6e6 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -545,9 +545,11 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): from_obj (Object, optional): An object designated as the "sender" of the message. See `DefaultObject.msg()` for more info. - mapping (dict, optional): A dictionary of token-object - pairs allowng display name substitution. See Notes - + mapping (dict, optional): A mapping of formatting keys + `{"key":, "key2":,...}. The keys + must match `{key}` markers in `message` and will be + replaced by the return of `.get_display_name(looker)` + for every looker that is messaged. Kwargs: Keyword arguments will be passed on to `obj.msg()` for all messaged objects. @@ -560,7 +562,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): the room before substitution. Example: - Say char is a Character object and npc is an NPC object. + Say char is a Character object and npc is an NPC object: char.location.msg_contents( "{attacker} attacks {defender}",