moved msg_contents to DefaultObject

evennia/objects/objects.py

@@ -535,7 +535,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
         for obj in contents:
             func(obj, **kwargs)
 
-    def msg_contents(self, message, exclude=None, from_obj=None, **kwargs):
+    def msg_contents(self, message, exclude=None, from_obj=None, mapping=None, **kwargs):
         """
         Emits a message to all objects inside this object.
 
@@ -545,15 +545,38 @@ 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
 
         Kwargs:
             Keyword arguments will be passed on to `obj.msg()` for all
             messaged objects.
 
+        Notes:
+            The `mapping` argument is required if `message` contains
+            {}-style format syntax. The keys of `mapping` should match
+            named format tokens, and its values will have their
+            `get_display_name()` function called for  each object in
+            the room before substitution.
+
+        Example:
+            Say char is a Character object and npc is an NPC object.
+
+            char.location.msg_contents(
+                "{attacker} attacks {defender}",
+                mapping=dict(attacker=char, defender=npc),
+                exclude=(char, npc))
         """
-        def msg(obj, message, from_obj, **kwargs):
-            obj.msg(message, from_obj=from_obj, **kwargs)
-        self.for_contents(msg, exclude=exclude, from_obj=from_obj, message=message, **kwargs)
+        contents = self.contents
+        if exclude:
+            exclude = make_iter(exclude)
+            contents = [obj for obj in contents if obj not in exclude]
+        for obj in contents:
+            if mapping:
+                substitutions = {t: sub.get_display_name(obj) for t, sub in mapping.items()}
+                obj.msg(message.format(**substitutions), from_obj=from_obj, **kwargs)
+            else:
+                obj.msg(message, from_obj=from_obj, **kwargs)
 
     def move_to(self, destination, quiet=False,
                 emit_to_obj=None, use_destination=True, to_none=False, move_hooks=True):