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

Made channel_prefix honor the emit keyword. Also corrected docstrings of message_transform to correctly note a Msg object is needed instead of a string.

Browse source
This commit is contained in:
Griatch 2016-11-27 12:08:23 +01:00
parent 25cdecc0db
commit 381e91b822
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
evennia/comms/comms.py
View file

@ -201,13 +201,13 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)):
from evennia.comms.channelhandler import CHANNELHANDLER from evennia.comms.channelhandler import CHANNELHANDLER
CHANNELHANDLER.update() CHANNELHANDLER.update()
def message_transform(self, msg, emit=False, prefix=True, def message_transform(self, msgobj, emit=False, prefix=True,
sender_strings=None, external=False): sender_strings=None, external=False):
""" """
Generates the formatted string sent to listeners on a channel. Generates the formatted string sent to listeners on a channel.
Args: Args:
msg (str): Message to send. msgobj (Msg): Message object to send.
emit (bool, optional): In emit mode the message is not associated emit (bool, optional): In emit mode the message is not associated
with a specific sender name. with a specific sender name.
prefix (bool, optional): Prefix `msg` with a text given by `self.channel_prefix`. prefix (bool, optional): Prefix `msg` with a text given by `self.channel_prefix`.
@ -216,13 +216,13 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)):
""" """
if sender_strings or external: if sender_strings or external:
body = self.format_external(msg, sender_strings, emit=emit) body = self.format_external(msgobj, sender_strings, emit=emit)
else: else:
body = self.format_message(msg, emit=emit) body = self.format_message(msgobj, emit=emit)
if prefix: if prefix:
body = "%s%s" % (self.channel_prefix(msg, emit=emit), body) body = "%s%s" % (self.channel_prefix(msgobj, emit=emit), body)
msg.message = body msgobj.message = body
return msg return msgobj
def distribute_message(self, msgobj, online=False): def distribute_message(self, msgobj, online=False):
""" """
@ -334,13 +334,13 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)):
Args: Args:
msg (str, optional): Prefix text msg (str, optional): Prefix text
emit (bool, optional): Switches to emit mode, which usually emit (bool, optional): Switches to emit mode, which usually
means to ignore any sender information. Not used by default. means to not prefix the channel's info.
Returns: Returns:
prefix (str): The created channel prefix. prefix (str): The created channel prefix.
""" """
return '[%s] ' % self.key return '' if emit else '[%s] ' % self.key
def format_senders(self, senders=None): def format_senders(self, senders=None):
""" """