bastd.ui.profile.browser

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""UI functionality related to browsing player profiles."""
  4
  5from __future__ import annotations
  6
  7from typing import TYPE_CHECKING
  8
  9import ba
 10import ba.internal
 11
 12if TYPE_CHECKING:
 13    from typing import Any
 14
 15
 16class ProfileBrowserWindow(ba.Window):
 17    """Window for browsing player profiles."""
 18
 19    def __init__(
 20        self,
 21        transition: str = 'in_right',
 22        in_main_menu: bool = True,
 23        selected_profile: str | None = None,
 24        origin_widget: ba.Widget | None = None,
 25    ):
 26        # pylint: disable=too-many-statements
 27        # pylint: disable=too-many-locals
 28        self._in_main_menu = in_main_menu
 29        if self._in_main_menu:
 30            back_label = ba.Lstr(resource='backText')
 31        else:
 32            back_label = ba.Lstr(resource='doneText')
 33        uiscale = ba.app.ui.uiscale
 34        self._width = 700.0 if uiscale is ba.UIScale.SMALL else 600.0
 35        x_inset = 50.0 if uiscale is ba.UIScale.SMALL else 0.0
 36        self._height = (
 37            360.0
 38            if uiscale is ba.UIScale.SMALL
 39            else 385.0
 40            if uiscale is ba.UIScale.MEDIUM
 41            else 410.0
 42        )
 43
 44        # If we're being called up standalone, handle pause/resume ourself.
 45        if not self._in_main_menu:
 46            ba.app.pause()
 47
 48        # If they provided an origin-widget, scale up from that.
 49        scale_origin: tuple[float, float] | None
 50        if origin_widget is not None:
 51            self._transition_out = 'out_scale'
 52            scale_origin = origin_widget.get_screen_space_center()
 53            transition = 'in_scale'
 54        else:
 55            self._transition_out = 'out_right'
 56            scale_origin = None
 57
 58        self._r = 'playerProfilesWindow'
 59
 60        # Ensure we've got an account-profile in cases where we're signed in.
 61        ba.app.accounts_v1.ensure_have_account_player_profile()
 62
 63        top_extra = 20 if uiscale is ba.UIScale.SMALL else 0
 64
 65        super().__init__(
 66            root_widget=ba.containerwidget(
 67                size=(self._width, self._height + top_extra),
 68                transition=transition,
 69                scale_origin_stack_offset=scale_origin,
 70                scale=(
 71                    2.2
 72                    if uiscale is ba.UIScale.SMALL
 73                    else 1.6
 74                    if uiscale is ba.UIScale.MEDIUM
 75                    else 1.0
 76                ),
 77                stack_offset=(0, -14)
 78                if uiscale is ba.UIScale.SMALL
 79                else (0, 0),
 80            )
 81        )
 82
 83        self._back_button = btn = ba.buttonwidget(
 84            parent=self._root_widget,
 85            position=(40 + x_inset, self._height - 59),
 86            size=(120, 60),
 87            scale=0.8,
 88            label=back_label,
 89            button_type='back' if self._in_main_menu else None,
 90            autoselect=True,
 91            on_activate_call=self._back,
 92        )
 93        ba.containerwidget(edit=self._root_widget, cancel_button=btn)
 94
 95        ba.textwidget(
 96            parent=self._root_widget,
 97            position=(self._width * 0.5, self._height - 36),
 98            size=(0, 0),
 99            text=ba.Lstr(resource=self._r + '.titleText'),
100            maxwidth=300,
101            color=ba.app.ui.title_color,
102            scale=0.9,
103            h_align='center',
104            v_align='center',
105        )
106
107        if self._in_main_menu:
108            ba.buttonwidget(
109                edit=btn,
110                button_type='backSmall',
111                size=(60, 60),
112                label=ba.charstr(ba.SpecialChar.BACK),
113            )
114
115        scroll_height = self._height - 140.0
116        self._scroll_width = self._width - (188 + x_inset * 2)
117        v = self._height - 84.0
118        h = 50 + x_inset
119        b_color = (0.6, 0.53, 0.63)
120
121        scl = (
122            1.055
123            if uiscale is ba.UIScale.SMALL
124            else 1.18
125            if uiscale is ba.UIScale.MEDIUM
126            else 1.3
127        )
128        v -= 70.0 * scl
129        self._new_button = ba.buttonwidget(
130            parent=self._root_widget,
131            position=(h, v),
132            size=(80, 66.0 * scl),
133            on_activate_call=self._new_profile,
134            color=b_color,
135            button_type='square',
136            autoselect=True,
137            textcolor=(0.75, 0.7, 0.8),
138            text_scale=0.7,
139            label=ba.Lstr(resource=self._r + '.newButtonText'),
140        )
141        v -= 70.0 * scl
142        self._edit_button = ba.buttonwidget(
143            parent=self._root_widget,
144            position=(h, v),
145            size=(80, 66.0 * scl),
146            on_activate_call=self._edit_profile,
147            color=b_color,
148            button_type='square',
149            autoselect=True,
150            textcolor=(0.75, 0.7, 0.8),
151            text_scale=0.7,
152            label=ba.Lstr(resource=self._r + '.editButtonText'),
153        )
154        v -= 70.0 * scl
155        self._delete_button = ba.buttonwidget(
156            parent=self._root_widget,
157            position=(h, v),
158            size=(80, 66.0 * scl),
159            on_activate_call=self._delete_profile,
160            color=b_color,
161            button_type='square',
162            autoselect=True,
163            textcolor=(0.75, 0.7, 0.8),
164            text_scale=0.7,
165            label=ba.Lstr(resource=self._r + '.deleteButtonText'),
166        )
167
168        v = self._height - 87
169
170        ba.textwidget(
171            parent=self._root_widget,
172            position=(self._width * 0.5, self._height - 71),
173            size=(0, 0),
174            text=ba.Lstr(resource=self._r + '.explanationText'),
175            color=ba.app.ui.infotextcolor,
176            maxwidth=self._width * 0.83,
177            scale=0.6,
178            h_align='center',
179            v_align='center',
180        )
181
182        self._scrollwidget = ba.scrollwidget(
183            parent=self._root_widget,
184            highlight=False,
185            position=(140 + x_inset, v - scroll_height),
186            size=(self._scroll_width, scroll_height),
187        )
188        ba.widget(
189            edit=self._scrollwidget,
190            autoselect=True,
191            left_widget=self._new_button,
192        )
193        ba.containerwidget(
194            edit=self._root_widget, selected_child=self._scrollwidget
195        )
196        self._columnwidget = ba.columnwidget(
197            parent=self._scrollwidget, border=2, margin=0
198        )
199        v -= 255
200        self._profiles: dict[str, dict[str, Any]] | None = None
201        self._selected_profile = selected_profile
202        self._profile_widgets: list[ba.Widget] = []
203        self._refresh()
204        self._restore_state()
205
206    def _new_profile(self) -> None:
207        # pylint: disable=cyclic-import
208        from bastd.ui.profile.edit import EditProfileWindow
209        from bastd.ui.purchase import PurchaseWindow
210
211        # Limit to a handful profiles if they don't have pro-options.
212        max_non_pro_profiles = ba.internal.get_v1_account_misc_read_val(
213            'mnpp', 5
214        )
215        assert self._profiles is not None
216        if (
217            not ba.app.accounts_v1.have_pro_options()
218            and len(self._profiles) >= max_non_pro_profiles
219        ):
220            PurchaseWindow(
221                items=['pro'],
222                header_text=ba.Lstr(
223                    resource='unlockThisProfilesText',
224                    subs=[('${NUM}', str(max_non_pro_profiles))],
225                ),
226            )
227            return
228
229        # Clamp at 100 profiles (otherwise the server will and that's less
230        # elegant looking).
231        if len(self._profiles) > 100:
232            ba.screenmessage(
233                ba.Lstr(
234                    translate=(
235                        'serverResponses',
236                        'Max number of profiles reached.',
237                    )
238                ),
239                color=(1, 0, 0),
240            )
241            ba.playsound(ba.getsound('error'))
242            return
243
244        self._save_state()
245        ba.containerwidget(edit=self._root_widget, transition='out_left')
246        ba.app.ui.set_main_menu_window(
247            EditProfileWindow(
248                existing_profile=None, in_main_menu=self._in_main_menu
249            ).get_root_widget()
250        )
251
252    def _delete_profile(self) -> None:
253        # pylint: disable=cyclic-import
254        from bastd.ui import confirm
255
256        if self._selected_profile is None:
257            ba.playsound(ba.getsound('error'))
258            ba.screenmessage(
259                ba.Lstr(resource='nothingIsSelectedErrorText'), color=(1, 0, 0)
260            )
261            return
262        if self._selected_profile == '__account__':
263            ba.playsound(ba.getsound('error'))
264            ba.screenmessage(
265                ba.Lstr(resource=self._r + '.cantDeleteAccountProfileText'),
266                color=(1, 0, 0),
267            )
268            return
269        confirm.ConfirmWindow(
270            ba.Lstr(
271                resource=self._r + '.deleteConfirmText',
272                subs=[('${PROFILE}', self._selected_profile)],
273            ),
274            self._do_delete_profile,
275            350,
276        )
277
278    def _do_delete_profile(self) -> None:
279        ba.internal.add_transaction(
280            {'type': 'REMOVE_PLAYER_PROFILE', 'name': self._selected_profile}
281        )
282        ba.internal.run_transactions()
283        ba.playsound(ba.getsound('shieldDown'))
284        self._refresh()
285
286        # Select profile list.
287        ba.containerwidget(
288            edit=self._root_widget, selected_child=self._scrollwidget
289        )
290
291    def _edit_profile(self) -> None:
292        # pylint: disable=cyclic-import
293        from bastd.ui.profile.edit import EditProfileWindow
294
295        if self._selected_profile is None:
296            ba.playsound(ba.getsound('error'))
297            ba.screenmessage(
298                ba.Lstr(resource='nothingIsSelectedErrorText'), color=(1, 0, 0)
299            )
300            return
301        self._save_state()
302        ba.containerwidget(edit=self._root_widget, transition='out_left')
303        ba.app.ui.set_main_menu_window(
304            EditProfileWindow(
305                self._selected_profile, in_main_menu=self._in_main_menu
306            ).get_root_widget()
307        )
308
309    def _select(self, name: str, index: int) -> None:
310        del index  # Unused.
311        self._selected_profile = name
312
313    def _back(self) -> None:
314        # pylint: disable=cyclic-import
315        from bastd.ui.account.settings import AccountSettingsWindow
316
317        self._save_state()
318        ba.containerwidget(
319            edit=self._root_widget, transition=self._transition_out
320        )
321        if self._in_main_menu:
322            ba.app.ui.set_main_menu_window(
323                AccountSettingsWindow(transition='in_left').get_root_widget()
324            )
325
326        # If we're being called up standalone, handle pause/resume ourself.
327        else:
328            ba.app.resume()
329
330    def _refresh(self) -> None:
331        # pylint: disable=too-many-locals
332        from efro.util import asserttype
333        from ba.internal import (
334            PlayerProfilesChangedMessage,
335            get_player_profile_colors,
336            get_player_profile_icon,
337        )
338
339        old_selection = self._selected_profile
340
341        # Delete old.
342        while self._profile_widgets:
343            self._profile_widgets.pop().delete()
344        self._profiles = ba.app.config.get('Player Profiles', {})
345        assert self._profiles is not None
346        items = list(self._profiles.items())
347        items.sort(key=lambda x: asserttype(x[0], str).lower())
348        index = 0
349        account_name: str | None
350        if ba.internal.get_v1_account_state() == 'signed_in':
351            account_name = ba.internal.get_v1_account_display_string()
352        else:
353            account_name = None
354        widget_to_select = None
355        for p_name, _ in items:
356            if p_name == '__account__' and account_name is None:
357                continue
358            color, _highlight = get_player_profile_colors(p_name)
359            scl = 1.1
360            tval = (
361                account_name
362                if p_name == '__account__'
363                else get_player_profile_icon(p_name) + p_name
364            )
365            assert isinstance(tval, str)
366            txtw = ba.textwidget(
367                parent=self._columnwidget,
368                position=(0, 32),
369                size=((self._width - 40) / scl, 28),
370                text=ba.Lstr(value=tval),
371                h_align='left',
372                v_align='center',
373                on_select_call=ba.WeakCall(self._select, p_name, index),
374                maxwidth=self._scroll_width * 0.92,
375                corner_scale=scl,
376                color=ba.safecolor(color, 0.4),
377                always_highlight=True,
378                on_activate_call=ba.Call(self._edit_button.activate),
379                selectable=True,
380            )
381            if index == 0:
382                ba.widget(edit=txtw, up_widget=self._back_button)
383            ba.widget(edit=txtw, show_buffer_top=40, show_buffer_bottom=40)
384            self._profile_widgets.append(txtw)
385
386            # Select/show this one if it was previously selected
387            # (but defer till after this loop since our height is
388            # still changing).
389            if p_name == old_selection:
390                widget_to_select = txtw
391
392            index += 1
393
394        if widget_to_select is not None:
395            ba.columnwidget(
396                edit=self._columnwidget,
397                selected_child=widget_to_select,
398                visible_child=widget_to_select,
399            )
400
401        # If there's a team-chooser in existence, tell it the profile-list
402        # has probably changed.
403        session = ba.internal.get_foreground_host_session()
404        if session is not None:
405            session.handlemessage(PlayerProfilesChangedMessage())
406
407    def _save_state(self) -> None:
408        try:
409            sel = self._root_widget.get_selected_child()
410            if sel == self._new_button:
411                sel_name = 'New'
412            elif sel == self._edit_button:
413                sel_name = 'Edit'
414            elif sel == self._delete_button:
415                sel_name = 'Delete'
416            elif sel == self._scrollwidget:
417                sel_name = 'Scroll'
418            else:
419                sel_name = 'Back'
420            ba.app.ui.window_states[type(self)] = sel_name
421        except Exception:
422            ba.print_exception(f'Error saving state for {self}.')
423
424    def _restore_state(self) -> None:
425        try:
426            sel_name = ba.app.ui.window_states.get(type(self))
427            if sel_name == 'Scroll':
428                sel = self._scrollwidget
429            elif sel_name == 'New':
430                sel = self._new_button
431            elif sel_name == 'Delete':
432                sel = self._delete_button
433            elif sel_name == 'Edit':
434                sel = self._edit_button
435            elif sel_name == 'Back':
436                sel = self._back_button
437            else:
438                # By default we select our scroll widget if we have profiles;
439                # otherwise our new widget.
440                if not self._profile_widgets:
441                    sel = self._new_button
442                else:
443                    sel = self._scrollwidget
444            ba.containerwidget(edit=self._root_widget, selected_child=sel)
445        except Exception:
446            ba.print_exception(f'Error restoring state for {self}.')