Skip to content

Make SayText, SayText2 and TextMsg messages reliable by default #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ayuto merged 3 commits into from
Jul 11, 2018
Merged

Make SayText, SayText2 and TextMsg messages reliable by default #249

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7de65fa
Implement UserMessageCreator.send_reliable()
jsza Jun 22, 2018
9784284
Revert "Implement UserMessageCreator.send_reliable()"
jsza Jun 28, 2018
b79c3aa
Make SayText, SayText2 and TextMsg messages reliable by default.
jsza Jun 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion addons/source-python/packages/source-python/messages/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,12 @@ class AttrDict(dict):


class UserMessageCreator(AttrDict):
"""Provide an easy interface to create user messages."""
"""Provide an easy interface to create user messages.

:attr bool reliable: Whether to send message using reliable channel.
"""

reliable = False

def __init__(self, **kwargs):
"""Initialize the usermessage creator.
Expand Down Expand Up @@ -81,6 +86,7 @@ def _send(self, player_indexes, translated_kwargs):
:param AttrDict translated_kwargs: The translated arguments.
"""
recipients = RecipientFilter(*player_indexes)
recipients.reliable = self.reliable
user_message = UserMessage(recipients, self.message_name)

if user_message.is_protobuf():
Expand Down Expand Up @@ -206,6 +212,7 @@ def send(self, *player_indexes):
# this length, we need to sent it in several parts.
if UserMessage.is_protobuf():
recipients = RecipientFilter(*player_indexes)
recipients.reliable = self.reliable
user_message = UserMessage(recipients, self.message_name)
self.protobuf(user_message.buffer, self)
user_message.send()
Expand All @@ -223,6 +230,7 @@ def bitbuf(self, player_indexes, kwargs):
menu_string = kwargs.menu_string
length = len(menu_string)
recipients = RecipientFilter(*player_indexes)
recipients.reliable = self.reliable
while True:
user_message = UserMessage(recipients, self.message_name)

Expand All @@ -246,6 +254,7 @@ class SayText2(UserMessageCreator):

message_name = 'SayText2'
translatable_fields = ['message', 'param1', 'param2', 'param3', 'param4']
reliable = True

def __init__(
self, message, index=0, chat=False,
Expand Down Expand Up @@ -301,6 +310,7 @@ class SayText(UserMessageCreator):

message_name = 'SayText'
translatable_fields = ['message']
reliable = True

def __init__(self, message, index=0, chat=False):
"""Initialize the SayText instance."""
Expand Down Expand Up @@ -372,6 +382,7 @@ class TextMsg(UserMessageCreator):

message_name = 'TextMsg'
translatable_fields = ['message', 'param1', 'param2', 'param3', 'param4']
reliable = True

def __init__(
self, message, destination=HudDestination.CENTER,
Expand Down