Change text optional kwarg type name to lowercase to match all other communications variables. Expand msg_contents to handle a tuple.

evennia/commands/default/general.py

@@ -417,7 +417,7 @@ class CmdSay(COMMAND_DEFAULT_CLASS):
 
         # Build the string to emit to neighbors.
         emit_string = '%s says, "%s|n"' % (caller.name, speech)
-        caller.location.msg_contents((emit_string, {"type": "Say"}), 
+        caller.location.msg_contents(text=(emit_string, {"type": "say"}),
                                      exclude=caller, from_obj=caller)
 
 
@@ -460,7 +460,7 @@ class CmdWhisper(COMMAND_DEFAULT_CLASS):
 
         # Build the string to emit to receiver.
         emit_string = '%s whispers, "%s|n"' % (caller.name, speech)
-        receiver.msg((emit_string, {"type": "Whisper"}), from_obj=caller)
+        receiver.msg(text=(emit_string, {"type": "whisper"}), from_obj=caller)
 
 
 class CmdPose(COMMAND_DEFAULT_CLASS):
@@ -503,7 +503,7 @@ class CmdPose(COMMAND_DEFAULT_CLASS):
             self.caller.msg(msg)
         else:
             msg = "%s%s" % (self.caller.name, self.args)
-            self.caller.location.msg_contents((msg, {"type": "Pose"}), 
+            self.caller.location.msg_contents(text=(msg, {"type": "pose"}),
                                               from_obj=self.caller)
 
 

evennia/objects/objects.py

@@ -21,7 +21,7 @@ from evennia.commands.cmdsethandler import CmdSetHandler
 from evennia.commands import cmdhandler
 from evennia.utils import logger
 from evennia.utils.utils import (variable_from_module, lazy_property,
-                                 make_iter, to_unicode, calledby)
+                                 make_iter, to_unicode, calledby, is_iter)
 
 _MULTISESSION_MODE = settings.MULTISESSION_MODE
 
@@ -547,21 +547,28 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
         for obj in contents:
             func(obj, **kwargs)
 
-    def msg_contents(self, message, exclude=None, from_obj=None, mapping=None, **kwargs):
+    def msg_contents(self, text=None, exclude=None, from_obj=None, mapping=None, **kwargs):
         """
         Emits a message to all objects inside this object.
 
-        Args:
+        Argsu:
-            message (str): Message to send.
+            text (str or tuple): Message to send. If a tuple, this should be
+                on the valid OOB outmessage form `(message, {kwargs})`,
+                where kwargs are optional data passed to the `text`
+                outputfunc.
             exclude (list, optional): A list of objects not to send to.
             from_obj (Object, optional): An object designated as the
                 "sender" of the message. See `DefaultObject.msg()` for
                 more info.
             mapping (dict, optional): A mapping of formatting keys
                 `{"key":<object>, "key2":<object2>,...}. The keys
-                must match `{key}` markers in `message` and will be
+                must match `{key}` markers in the `text` if this is a string or
+                in the internal `message` if `text` is a tuple. These
+                formatting statements will be
                 replaced by the return of `<object>.get_display_name(looker)`
-                for every looker that is messaged.
+                for every looker in contents that receives the
+                message. This allows for every object to potentially
+                get its own customized string.
         Kwargs:
             Keyword arguments will be passed on to `obj.msg()` for all
             messaged objects.
@@ -575,15 +582,23 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
             not have `get_display_name()`, its string value will be used.
 
         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:
 
-            action = 'kicks'
             char.location.msg_contents(
-                "{attacker} {action} {defender}",
+                "{attacker} kicks {defender}",
-                mapping=dict(attacker=char, defender=npc, action=action),
+                mapping=dict(attacker=char, defender=npc), exclude=(char, npc))
-                exclude=(char, npc))
+
+            This will result in everyone in the room seeing 'Char kicks NPC'
+            where everyone may potentially see different results for Char and Npc
+            depending on the results of `char.get_display_name(looker)` and
+            `npc.get_display_name(looker)` for each particular onlooker
 
         """
+        # we also accept an outcommand on the form (message, {kwargs})
+        is_outcmd = text and is_iter(text)
+        inmessage = text[0] if is_outcmd else text
+        outkwargs = text[1] if is_outcmd and len(text) > 1 else {}
+
         contents = self.contents
         if exclude:
             exclude = make_iter(exclude)
@@ -593,9 +608,11 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
                 substitutions = {t: sub.get_display_name(obj)
                                  if hasattr(sub, 'get_display_name')
                                  else str(sub) for t, sub in mapping.items()}
-                obj.msg(message.format(**substitutions), from_obj=from_obj, **kwargs)
+                outmessage = inmessage.format(**substitutions)
             else:
-                obj.msg(message, from_obj=from_obj, **kwargs)
+                outmessage = inmessage
+
+            obj.msg(text=((outmessage,), outkwargs), 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):