bastd.ui.party

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides party related UI."""
  4
  5from __future__ import annotations
  6
  7import math
  8from typing import TYPE_CHECKING, cast
  9
 10import _ba
 11import ba
 12from bastd.ui import popup
 13
 14if TYPE_CHECKING:
 15    from typing import Sequence, Any
 16
 17
 18class PartyWindow(ba.Window):
 19    """Party list/chat window."""
 20
 21    def __del__(self) -> None:
 22        _ba.set_party_window_open(False)
 23
 24    def __init__(self, origin: Sequence[float] = (0, 0)):
 25        _ba.set_party_window_open(True)
 26        self._r = 'partyWindow'
 27        self._popup_type: str | None = None
 28        self._popup_party_member_client_id: int | None = None
 29        self._popup_party_member_is_host: bool | None = None
 30        self._width = 500
 31        uiscale = ba.app.ui.uiscale
 32        self._height = (365 if uiscale is ba.UIScale.SMALL else
 33                        480 if uiscale is ba.UIScale.MEDIUM else 600)
 34        super().__init__(root_widget=ba.containerwidget(
 35            size=(self._width, self._height),
 36            transition='in_scale',
 37            color=(0.40, 0.55, 0.20),
 38            parent=_ba.get_special_widget('overlay_stack'),
 39            on_outside_click_call=self.close_with_sound,
 40            scale_origin_stack_offset=origin,
 41            scale=(2.0 if uiscale is ba.UIScale.SMALL else
 42                   1.35 if uiscale is ba.UIScale.MEDIUM else 1.0),
 43            stack_offset=(0, -10) if uiscale is ba.UIScale.SMALL else (
 44                240, 0) if uiscale is ba.UIScale.MEDIUM else (330, 20)))
 45
 46        self._cancel_button = ba.buttonwidget(parent=self._root_widget,
 47                                              scale=0.7,
 48                                              position=(30, self._height - 47),
 49                                              size=(50, 50),
 50                                              label='',
 51                                              on_activate_call=self.close,
 52                                              autoselect=True,
 53                                              color=(0.45, 0.63, 0.15),
 54                                              icon=ba.gettexture('crossOut'),
 55                                              iconscale=1.2)
 56        ba.containerwidget(edit=self._root_widget,
 57                           cancel_button=self._cancel_button)
 58
 59        self._menu_button = ba.buttonwidget(
 60            parent=self._root_widget,
 61            scale=0.7,
 62            position=(self._width - 60, self._height - 47),
 63            size=(50, 50),
 64            label='...',
 65            autoselect=True,
 66            button_type='square',
 67            on_activate_call=ba.WeakCall(self._on_menu_button_press),
 68            color=(0.55, 0.73, 0.25),
 69            iconscale=1.2)
 70
 71        info = _ba.get_connection_to_host_info()
 72        if info.get('name', '') != '':
 73            title = ba.Lstr(value=info['name'])
 74        else:
 75            title = ba.Lstr(resource=self._r + '.titleText')
 76
 77        self._title_text = ba.textwidget(parent=self._root_widget,
 78                                         scale=0.9,
 79                                         color=(0.5, 0.7, 0.5),
 80                                         text=title,
 81                                         size=(0, 0),
 82                                         position=(self._width * 0.5,
 83                                                   self._height - 29),
 84                                         maxwidth=self._width * 0.7,
 85                                         h_align='center',
 86                                         v_align='center')
 87
 88        self._empty_str = ba.textwidget(parent=self._root_widget,
 89                                        scale=0.75,
 90                                        size=(0, 0),
 91                                        position=(self._width * 0.5,
 92                                                  self._height - 65),
 93                                        maxwidth=self._width * 0.85,
 94                                        h_align='center',
 95                                        v_align='center')
 96
 97        self._scroll_width = self._width - 50
 98        self._scrollwidget = ba.scrollwidget(parent=self._root_widget,
 99                                             size=(self._scroll_width,
100                                                   self._height - 200),
101                                             position=(30, 80),
102                                             color=(0.4, 0.6, 0.3))
103        self._columnwidget = ba.columnwidget(parent=self._scrollwidget,
104                                             border=2,
105                                             margin=0)
106        ba.widget(edit=self._menu_button, down_widget=self._columnwidget)
107
108        self._muted_text = ba.textwidget(
109            parent=self._root_widget,
110            position=(self._width * 0.5, self._height * 0.5),
111            size=(0, 0),
112            h_align='center',
113            v_align='center',
114            text=ba.Lstr(resource='chatMutedText'))
115        self._chat_texts: list[ba.Widget] = []
116
117        # add all existing messages if chat is not muted
118        if not ba.app.config.resolve('Chat Muted'):
119            msgs = _ba.get_chat_messages()
120            for msg in msgs:
121                self._add_msg(msg)
122
123        self._text_field = txt = ba.textwidget(
124            parent=self._root_widget,
125            editable=True,
126            size=(530, 40),
127            position=(44, 39),
128            text='',
129            maxwidth=494,
130            shadow=0.3,
131            flatness=1.0,
132            description=ba.Lstr(resource=self._r + '.chatMessageText'),
133            autoselect=True,
134            v_align='center',
135            corner_scale=0.7)
136
137        ba.widget(edit=self._scrollwidget,
138                  autoselect=True,
139                  left_widget=self._cancel_button,
140                  up_widget=self._cancel_button,
141                  down_widget=self._text_field)
142        ba.widget(edit=self._columnwidget,
143                  autoselect=True,
144                  up_widget=self._cancel_button,
145                  down_widget=self._text_field)
146        ba.containerwidget(edit=self._root_widget, selected_child=txt)
147        btn = ba.buttonwidget(parent=self._root_widget,
148                              size=(50, 35),
149                              label=ba.Lstr(resource=self._r + '.sendText'),
150                              button_type='square',
151                              autoselect=True,
152                              position=(self._width - 70, 35),
153                              on_activate_call=self._send_chat_message)
154        ba.textwidget(edit=txt, on_return_press_call=btn.activate)
155        self._name_widgets: list[ba.Widget] = []
156        self._roster: list[dict[str, Any]] | None = None
157        self._update_timer = ba.Timer(1.0,
158                                      ba.WeakCall(self._update),
159                                      repeat=True,
160                                      timetype=ba.TimeType.REAL)
161        self._update()
162
163    def on_chat_message(self, msg: str) -> None:
164        """Called when a new chat message comes through."""
165        if not ba.app.config.resolve('Chat Muted'):
166            self._add_msg(msg)
167
168    def _add_msg(self, msg: str) -> None:
169        txt = ba.textwidget(parent=self._columnwidget,
170                            text=msg,
171                            h_align='left',
172                            v_align='center',
173                            size=(0, 13),
174                            scale=0.55,
175                            maxwidth=self._scroll_width * 0.94,
176                            shadow=0.3,
177                            flatness=1.0)
178        self._chat_texts.append(txt)
179        if len(self._chat_texts) > 40:
180            first = self._chat_texts.pop(0)
181            first.delete()
182        ba.containerwidget(edit=self._columnwidget, visible_child=txt)
183
184    def _on_menu_button_press(self) -> None:
185        is_muted = ba.app.config.resolve('Chat Muted')
186        uiscale = ba.app.ui.uiscale
187        popup.PopupMenuWindow(
188            position=self._menu_button.get_screen_space_center(),
189            scale=(2.3 if uiscale is ba.UIScale.SMALL else
190                   1.65 if uiscale is ba.UIScale.MEDIUM else 1.23),
191            choices=['unmute' if is_muted else 'mute'],
192            choices_display=[
193                ba.Lstr(
194                    resource='chatUnMuteText' if is_muted else 'chatMuteText')
195            ],
196            current_choice='unmute' if is_muted else 'mute',
197            delegate=self)
198        self._popup_type = 'menu'
199
200    def _update(self) -> None:
201        # pylint: disable=too-many-locals
202        # pylint: disable=too-many-branches
203        # pylint: disable=too-many-statements
204        # pylint: disable=too-many-nested-blocks
205
206        # update muted state
207        if ba.app.config.resolve('Chat Muted'):
208            ba.textwidget(edit=self._muted_text, color=(1, 1, 1, 0.3))
209            # clear any chat texts we're showing
210            if self._chat_texts:
211                while self._chat_texts:
212                    first = self._chat_texts.pop()
213                    first.delete()
214        else:
215            ba.textwidget(edit=self._muted_text, color=(1, 1, 1, 0.0))
216
217        # update roster section
218        roster = _ba.get_game_roster()
219        if roster != self._roster:
220            self._roster = roster
221
222            # clear out old
223            for widget in self._name_widgets:
224                widget.delete()
225            self._name_widgets = []
226            if not self._roster:
227                top_section_height = 60
228                ba.textwidget(edit=self._empty_str,
229                              text=ba.Lstr(resource=self._r + '.emptyText'))
230                ba.scrollwidget(edit=self._scrollwidget,
231                                size=(self._width - 50,
232                                      self._height - top_section_height - 110),
233                                position=(30, 80))
234            else:
235                columns = 1 if len(
236                    self._roster) == 1 else 2 if len(self._roster) == 2 else 3
237                rows = int(math.ceil(float(len(self._roster)) / columns))
238                c_width = (self._width * 0.9) / max(3, columns)
239                c_width_total = c_width * columns
240                c_height = 24
241                c_height_total = c_height * rows
242                for y in range(rows):
243                    for x in range(columns):
244                        index = y * columns + x
245                        if index < len(self._roster):
246                            t_scale = 0.65
247                            pos = (self._width * 0.53 - c_width_total * 0.5 +
248                                   c_width * x - 23,
249                                   self._height - 65 - c_height * y - 15)
250
251                            # if there are players present for this client, use
252                            # their names as a display string instead of the
253                            # client spec-string
254                            try:
255                                if self._roster[index]['players']:
256                                    # if there's just one, use the full name;
257                                    # otherwise combine short names
258                                    if len(self._roster[index]
259                                           ['players']) == 1:
260                                        p_str = self._roster[index]['players'][
261                                            0]['name_full']
262                                    else:
263                                        p_str = ('/'.join([
264                                            entry['name'] for entry in
265                                            self._roster[index]['players']
266                                        ]))
267                                        if len(p_str) > 25:
268                                            p_str = p_str[:25] + '...'
269                                else:
270                                    p_str = self._roster[index][
271                                        'display_string']
272                            except Exception:
273                                ba.print_exception(
274                                    'Error calcing client name str.')
275                                p_str = '???'
276
277                            widget = ba.textwidget(parent=self._root_widget,
278                                                   position=(pos[0], pos[1]),
279                                                   scale=t_scale,
280                                                   size=(c_width * 0.85, 30),
281                                                   maxwidth=c_width * 0.85,
282                                                   color=(1, 1,
283                                                          1) if index == 0 else
284                                                   (1, 1, 1),
285                                                   selectable=True,
286                                                   autoselect=True,
287                                                   click_activate=True,
288                                                   text=ba.Lstr(value=p_str),
289                                                   h_align='left',
290                                                   v_align='center')
291                            self._name_widgets.append(widget)
292
293                            # in newer versions client_id will be present and
294                            # we can use that to determine who the host is.
295                            # in older versions we assume the first client is
296                            # host
297                            if self._roster[index]['client_id'] is not None:
298                                is_host = self._roster[index][
299                                    'client_id'] == -1
300                            else:
301                                is_host = (index == 0)
302
303                            # FIXME: Should pass client_id to these sort of
304                            #  calls; not spec-string (perhaps should wait till
305                            #  client_id is more readily available though).
306                            ba.textwidget(edit=widget,
307                                          on_activate_call=ba.Call(
308                                              self._on_party_member_press,
309                                              self._roster[index]['client_id'],
310                                              is_host, widget))
311                            pos = (self._width * 0.53 - c_width_total * 0.5 +
312                                   c_width * x,
313                                   self._height - 65 - c_height * y)
314
315                            # Make the assumption that the first roster
316                            # entry is the server.
317                            # FIXME: Shouldn't do this.
318                            if is_host:
319                                twd = min(
320                                    c_width * 0.85,
321                                    _ba.get_string_width(
322                                        p_str, suppress_warning=True) *
323                                    t_scale)
324                                self._name_widgets.append(
325                                    ba.textwidget(
326                                        parent=self._root_widget,
327                                        position=(pos[0] + twd + 1,
328                                                  pos[1] - 0.5),
329                                        size=(0, 0),
330                                        h_align='left',
331                                        v_align='center',
332                                        maxwidth=c_width * 0.96 - twd,
333                                        color=(0.1, 1, 0.1, 0.5),
334                                        text=ba.Lstr(resource=self._r +
335                                                     '.hostText'),
336                                        scale=0.4,
337                                        shadow=0.1,
338                                        flatness=1.0))
339                ba.textwidget(edit=self._empty_str, text='')
340                ba.scrollwidget(edit=self._scrollwidget,
341                                size=(self._width - 50,
342                                      max(100, self._height - 139 -
343                                          c_height_total)),
344                                position=(30, 80))
345
346    def popup_menu_selected_choice(self, popup_window: popup.PopupMenuWindow,
347                                   choice: str) -> None:
348        """Called when a choice is selected in the popup."""
349        del popup_window  # unused
350        if self._popup_type == 'partyMemberPress':
351            if self._popup_party_member_is_host:
352                ba.playsound(ba.getsound('error'))
353                ba.screenmessage(
354                    ba.Lstr(resource='internal.cantKickHostError'),
355                    color=(1, 0, 0))
356            else:
357                assert self._popup_party_member_client_id is not None
358
359                # Ban for 5 minutes.
360                result = _ba.disconnect_client(
361                    self._popup_party_member_client_id, ban_time=5 * 60)
362                if not result:
363                    ba.playsound(ba.getsound('error'))
364                    ba.screenmessage(
365                        ba.Lstr(resource='getTicketsWindow.unavailableText'),
366                        color=(1, 0, 0))
367        elif self._popup_type == 'menu':
368            if choice in ('mute', 'unmute'):
369                cfg = ba.app.config
370                cfg['Chat Muted'] = (choice == 'mute')
371                cfg.apply_and_commit()
372                self._update()
373        else:
374            print(f'unhandled popup type: {self._popup_type}')
375
376    def popup_menu_closing(self, popup_window: popup.PopupWindow) -> None:
377        """Called when the popup is closing."""
378
379    def _on_party_member_press(self, client_id: int, is_host: bool,
380                               widget: ba.Widget) -> None:
381        # if we're the host, pop up 'kick' options for all non-host members
382        if _ba.get_foreground_host_session() is not None:
383            kick_str = ba.Lstr(resource='kickText')
384        else:
385            # kick-votes appeared in build 14248
386            if (_ba.get_connection_to_host_info().get('build_number', 0) <
387                    14248):
388                return
389            kick_str = ba.Lstr(resource='kickVoteText')
390        uiscale = ba.app.ui.uiscale
391        popup.PopupMenuWindow(
392            position=widget.get_screen_space_center(),
393            scale=(2.3 if uiscale is ba.UIScale.SMALL else
394                   1.65 if uiscale is ba.UIScale.MEDIUM else 1.23),
395            choices=['kick'],
396            choices_display=[kick_str],
397            current_choice='kick',
398            delegate=self)
399        self._popup_type = 'partyMemberPress'
400        self._popup_party_member_client_id = client_id
401        self._popup_party_member_is_host = is_host
402
403    def _send_chat_message(self) -> None:
404        _ba.chatmessage(cast(str, ba.textwidget(query=self._text_field)))
405        ba.textwidget(edit=self._text_field, text='')
406
407    def close(self) -> None:
408        """Close the window."""
409        ba.containerwidget(edit=self._root_widget, transition='out_scale')
410
411    def close_with_sound(self) -> None:
412        """Close the window and make a lovely sound."""
413        ba.playsound(ba.getsound('swish'))
414        self.close()