bauiv1lib.settings.advanced

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""UI functionality for advanced settings."""
  4
  5from __future__ import annotations
  6
  7import os
  8import logging
  9from typing import TYPE_CHECKING
 10
 11from bauiv1lib.popup import PopupMenu
 12import bauiv1 as bui
 13
 14if TYPE_CHECKING:
 15    from typing import Any
 16
 17
 18class AdvancedSettingsWindow(bui.Window):
 19    """Window for editing advanced app settings."""
 20
 21    def __init__(
 22        self,
 23        transition: str = 'in_right',
 24        origin_widget: bui.Widget | None = None,
 25    ):
 26        # pylint: disable=too-many-statements
 27        import threading
 28
 29        if bui.app.classic is None:
 30            raise RuntimeError('This requires classic support.')
 31
 32        # Preload some modules we use in a background thread so we won't
 33        # have a visual hitch when the user taps them.
 34        threading.Thread(target=self._preload_modules).start()
 35
 36        app = bui.app
 37        assert app.classic is not None
 38
 39        # If they provided an origin-widget, scale up from that.
 40        scale_origin: tuple[float, float] | None
 41        if origin_widget is not None:
 42            self._transition_out = 'out_scale'
 43            scale_origin = origin_widget.get_screen_space_center()
 44            transition = 'in_scale'
 45        else:
 46            self._transition_out = 'out_right'
 47            scale_origin = None
 48
 49        uiscale = bui.app.ui_v1.uiscale
 50        self._width = 870.0 if uiscale is bui.UIScale.SMALL else 670.0
 51        x_inset = 100 if uiscale is bui.UIScale.SMALL else 0
 52        self._height = (
 53            390.0
 54            if uiscale is bui.UIScale.SMALL
 55            else 450.0
 56            if uiscale is bui.UIScale.MEDIUM
 57            else 520.0
 58        )
 59        self._lang_status_text: bui.Widget | None = None
 60
 61        self._spacing = 32
 62        self._menu_open = False
 63        top_extra = 10 if uiscale is bui.UIScale.SMALL else 0
 64
 65        super().__init__(
 66            root_widget=bui.containerwidget(
 67                size=(self._width, self._height + top_extra),
 68                transition=transition,
 69                toolbar_visibility='menu_minimal',
 70                scale_origin_stack_offset=scale_origin,
 71                scale=(
 72                    2.06
 73                    if uiscale is bui.UIScale.SMALL
 74                    else 1.4
 75                    if uiscale is bui.UIScale.MEDIUM
 76                    else 1.0
 77                ),
 78                stack_offset=(0, -25)
 79                if uiscale is bui.UIScale.SMALL
 80                else (0, 0),
 81            )
 82        )
 83
 84        self._prev_lang = ''
 85        self._prev_lang_list: list[str] = []
 86        self._complete_langs_list: list | None = None
 87        self._complete_langs_error = False
 88        self._language_popup: PopupMenu | None = None
 89
 90        # In vr-mode, the internal keyboard is currently the *only* option,
 91        # so no need to show this.
 92        self._show_always_use_internal_keyboard = not app.env.vr
 93
 94        self._scroll_width = self._width - (100 + 2 * x_inset)
 95        self._scroll_height = self._height - 115.0
 96        self._sub_width = self._scroll_width * 0.95
 97        self._sub_height = 766.0
 98
 99        if self._show_always_use_internal_keyboard:
100            self._sub_height += 62
101
102        self._show_disable_gyro = app.classic.platform in {'ios', 'android'}
103        if self._show_disable_gyro:
104            self._sub_height += 42
105
106        self._do_vr_test_button = app.env.vr
107        self._do_net_test_button = True
108        self._extra_button_spacing = self._spacing * 2.5
109
110        if self._do_vr_test_button:
111            self._sub_height += self._extra_button_spacing
112        if self._do_net_test_button:
113            self._sub_height += self._extra_button_spacing
114        self._sub_height += self._spacing * 2.0  # plugins
115
116        self._r = 'settingsWindowAdvanced'
117
118        if app.ui_v1.use_toolbars and uiscale is bui.UIScale.SMALL:
119            bui.containerwidget(
120                edit=self._root_widget, on_cancel_call=self._do_back
121            )
122            self._back_button = None
123        else:
124            self._back_button = bui.buttonwidget(
125                parent=self._root_widget,
126                position=(53 + x_inset, self._height - 60),
127                size=(140, 60),
128                scale=0.8,
129                autoselect=True,
130                label=bui.Lstr(resource='backText'),
131                button_type='back',
132                on_activate_call=self._do_back,
133            )
134            bui.containerwidget(
135                edit=self._root_widget, cancel_button=self._back_button
136            )
137
138        self._title_text = bui.textwidget(
139            parent=self._root_widget,
140            position=(0, self._height - 52),
141            size=(self._width, 25),
142            text=bui.Lstr(resource=f'{self._r}.titleText'),
143            color=app.ui_v1.title_color,
144            h_align='center',
145            v_align='top',
146        )
147
148        if self._back_button is not None:
149            bui.buttonwidget(
150                edit=self._back_button,
151                button_type='backSmall',
152                size=(60, 60),
153                label=bui.charstr(bui.SpecialChar.BACK),
154            )
155
156        self._scrollwidget = bui.scrollwidget(
157            parent=self._root_widget,
158            position=(50 + x_inset, 50),
159            simple_culling_v=20.0,
160            highlight=False,
161            size=(self._scroll_width, self._scroll_height),
162            selection_loops_to_parent=True,
163        )
164        bui.widget(edit=self._scrollwidget, right_widget=self._scrollwidget)
165        self._subcontainer = bui.containerwidget(
166            parent=self._scrollwidget,
167            size=(self._sub_width, self._sub_height),
168            background=False,
169            selection_loops_to_parent=True,
170        )
171
172        self._rebuild()
173
174        # Rebuild periodically to pick up language changes/additions/etc.
175        self._rebuild_timer = bui.AppTimer(
176            1.0, bui.WeakCall(self._rebuild), repeat=True
177        )
178
179        # Fetch the list of completed languages.
180        bui.app.classic.master_server_v1_get(
181            'bsLangGetCompleted',
182            {'b': app.env.build_number},
183            callback=bui.WeakCall(self._completed_langs_cb),
184        )
185
186    # noinspection PyUnresolvedReferences
187    @staticmethod
188    def _preload_modules() -> None:
189        """Preload modules we use; avoids hitches (called in bg thread)."""
190        from babase import modutils as _unused2
191        from bauiv1lib import config as _unused1
192        from bauiv1lib.settings import vrtesting as _unused3
193        from bauiv1lib.settings import nettesting as _unused4
194        from bauiv1lib import appinvite as _unused5
195        from bauiv1lib import account as _unused6
196        from bauiv1lib import promocode as _unused7
197        from bauiv1lib import debug as _unused8
198        from bauiv1lib.settings import plugins as _unused9
199
200    def _update_lang_status(self) -> None:
201        if self._complete_langs_list is not None:
202            up_to_date = bui.app.lang.language in self._complete_langs_list
203            bui.textwidget(
204                edit=self._lang_status_text,
205                text=''
206                if bui.app.lang.language == 'Test'
207                else bui.Lstr(
208                    resource=f'{self._r}.translationNoUpdateNeededText'
209                )
210                if up_to_date
211                else bui.Lstr(
212                    resource=f'{self._r}.translationUpdateNeededText'
213                ),
214                color=(0.2, 1.0, 0.2, 0.8)
215                if up_to_date
216                else (1.0, 0.2, 0.2, 0.8),
217            )
218        else:
219            bui.textwidget(
220                edit=self._lang_status_text,
221                text=bui.Lstr(resource=f'{self._r}.translationFetchErrorText')
222                if self._complete_langs_error
223                else bui.Lstr(
224                    resource=f'{self._r}.translationFetchingStatusText'
225                ),
226                color=(1.0, 0.5, 0.2)
227                if self._complete_langs_error
228                else (0.7, 0.7, 0.7),
229            )
230
231    def _rebuild(self) -> None:
232        # pylint: disable=too-many-statements
233        # pylint: disable=too-many-branches
234        # pylint: disable=too-many-locals
235
236        from bauiv1lib.config import ConfigCheckBox
237        from babase.modutils import show_user_scripts
238
239        plus = bui.app.plus
240        assert plus is not None
241
242        available_languages = bui.app.lang.available_languages
243
244        # Don't rebuild if the menu is open or if our language and
245        # language-list hasn't changed.
246
247        # NOTE - although we now support widgets updating their own
248        # translations, we still change the label formatting on the language
249        # menu based on the language so still need this. ...however we could
250        # make this more limited to it only rebuilds that one menu instead
251        # of everything.
252        if self._menu_open or (
253            self._prev_lang == bui.app.config.get('Lang', None)
254            and self._prev_lang_list == available_languages
255        ):
256            return
257        self._prev_lang = bui.app.config.get('Lang', None)
258        self._prev_lang_list = available_languages
259
260        # Clear out our sub-container.
261        children = self._subcontainer.get_children()
262        for child in children:
263            child.delete()
264
265        v = self._sub_height - 35
266
267        v -= self._spacing * 1.2
268
269        # Update our existing back button and title.
270        if self._back_button is not None:
271            bui.buttonwidget(
272                edit=self._back_button, label=bui.Lstr(resource='backText')
273            )
274            bui.buttonwidget(
275                edit=self._back_button, label=bui.charstr(bui.SpecialChar.BACK)
276            )
277
278        bui.textwidget(
279            edit=self._title_text,
280            text=bui.Lstr(resource=f'{self._r}.titleText'),
281        )
282
283        this_button_width = 410
284
285        self._promo_code_button = bui.buttonwidget(
286            parent=self._subcontainer,
287            position=(self._sub_width / 2 - this_button_width / 2, v - 14),
288            size=(this_button_width, 60),
289            autoselect=True,
290            label=bui.Lstr(resource=f'{self._r}.enterPromoCodeText'),
291            text_scale=1.0,
292            on_activate_call=self._on_promo_code_press,
293        )
294        if self._back_button is not None:
295            bui.widget(
296                edit=self._promo_code_button,
297                up_widget=self._back_button,
298                left_widget=self._back_button,
299            )
300        v -= self._extra_button_spacing * 0.8
301
302        assert bui.app.classic is not None
303        bui.textwidget(
304            parent=self._subcontainer,
305            position=(200, v + 10),
306            size=(0, 0),
307            text=bui.Lstr(resource=f'{self._r}.languageText'),
308            maxwidth=150,
309            scale=0.95,
310            color=bui.app.ui_v1.title_color,
311            h_align='right',
312            v_align='center',
313        )
314
315        languages = bui.app.lang.available_languages
316        cur_lang = bui.app.config.get('Lang', None)
317        if cur_lang is None:
318            cur_lang = 'Auto'
319
320        # We have a special dict of language names in that language
321        # so we don't have to go digging through each full language.
322        try:
323            import json
324
325            with open(
326                os.path.join(
327                    bui.app.env.data_directory,
328                    'ba_data',
329                    'data',
330                    'langdata.json',
331                ),
332                encoding='utf-8',
333            ) as infile:
334                lang_names_translated = json.loads(infile.read())[
335                    'lang_names_translated'
336                ]
337        except Exception:
338            logging.exception('Error reading lang data.')
339            lang_names_translated = {}
340
341        langs_translated = {}
342        for lang in languages:
343            langs_translated[lang] = lang_names_translated.get(lang, lang)
344
345        langs_full = {}
346        for lang in languages:
347            lang_translated = bui.Lstr(translate=('languages', lang)).evaluate()
348            if langs_translated[lang] == lang_translated:
349                langs_full[lang] = lang_translated
350            else:
351                langs_full[lang] = (
352                    langs_translated[lang] + ' (' + lang_translated + ')'
353                )
354
355        self._language_popup = PopupMenu(
356            parent=self._subcontainer,
357            position=(210, v - 19),
358            width=150,
359            opening_call=bui.WeakCall(self._on_menu_open),
360            closing_call=bui.WeakCall(self._on_menu_close),
361            autoselect=False,
362            on_value_change_call=bui.WeakCall(self._on_menu_choice),
363            choices=['Auto'] + languages,
364            button_size=(250, 60),
365            choices_display=(
366                [
367                    bui.Lstr(
368                        value=(
369                            bui.Lstr(resource='autoText').evaluate()
370                            + ' ('
371                            + bui.Lstr(
372                                translate=(
373                                    'languages',
374                                    bui.app.lang.default_language,
375                                )
376                            ).evaluate()
377                            + ')'
378                        )
379                    )
380                ]
381                + [bui.Lstr(value=langs_full[l]) for l in languages]
382            ),
383            current_choice=cur_lang,
384        )
385
386        v -= self._spacing * 1.8
387
388        bui.textwidget(
389            parent=self._subcontainer,
390            position=(self._sub_width * 0.5, v + 10),
391            size=(0, 0),
392            text=bui.Lstr(
393                resource=f'{self._r}.helpTranslateText',
394                subs=[('${APP_NAME}', bui.Lstr(resource='titleText'))],
395            ),
396            maxwidth=self._sub_width * 0.9,
397            max_height=55,
398            flatness=1.0,
399            scale=0.65,
400            color=(0.4, 0.9, 0.4, 0.8),
401            h_align='center',
402            v_align='center',
403        )
404        v -= self._spacing * 1.9
405        this_button_width = 410
406        self._translation_editor_button = bui.buttonwidget(
407            parent=self._subcontainer,
408            position=(self._sub_width / 2 - this_button_width / 2, v - 24),
409            size=(this_button_width, 60),
410            label=bui.Lstr(
411                resource=f'{self._r}.translationEditorButtonText',
412                subs=[('${APP_NAME}', bui.Lstr(resource='titleText'))],
413            ),
414            autoselect=True,
415            on_activate_call=bui.Call(
416                bui.open_url, 'https://legacy.ballistica.net/translate'
417            ),
418        )
419
420        self._lang_status_text = bui.textwidget(
421            parent=self._subcontainer,
422            position=(self._sub_width * 0.5, v - 40),
423            size=(0, 0),
424            text='',
425            flatness=1.0,
426            scale=0.63,
427            h_align='center',
428            v_align='center',
429            maxwidth=400.0,
430        )
431        self._update_lang_status()
432        v -= 40
433
434        lang_inform = plus.get_v1_account_misc_val('langInform', False)
435
436        self._language_inform_checkbox = cbw = bui.checkboxwidget(
437            parent=self._subcontainer,
438            position=(50, v - 50),
439            size=(self._sub_width - 100, 30),
440            autoselect=True,
441            maxwidth=430,
442            textcolor=(0.8, 0.8, 0.8),
443            value=lang_inform,
444            text=bui.Lstr(resource=f'{self._r}.translationInformMe'),
445            on_value_change_call=bui.WeakCall(
446                self._on_lang_inform_value_change
447            ),
448        )
449
450        bui.widget(
451            edit=self._translation_editor_button,
452            down_widget=cbw,
453            up_widget=self._language_popup.get_button(),
454        )
455
456        v -= self._spacing * 3.0
457
458        self._kick_idle_players_check_box = ConfigCheckBox(
459            parent=self._subcontainer,
460            position=(50, v),
461            size=(self._sub_width - 100, 30),
462            configkey='Kick Idle Players',
463            displayname=bui.Lstr(resource=f'{self._r}.kickIdlePlayersText'),
464            scale=1.0,
465            maxwidth=430,
466        )
467
468        v -= 42
469        self._show_game_ping_check_box = ConfigCheckBox(
470            parent=self._subcontainer,
471            position=(50, v),
472            size=(self._sub_width - 100, 30),
473            configkey='Show Ping',
474            displayname=bui.Lstr(resource=f'{self._r}.showInGamePingText'),
475            scale=1.0,
476            maxwidth=430,
477        )
478
479        v -= 42
480        self._show_dev_console_button_check_box = ConfigCheckBox(
481            parent=self._subcontainer,
482            position=(50, v),
483            size=(self._sub_width - 100, 30),
484            configkey='Show Dev Console Button',
485            displayname=bui.Lstr(
486                resource=f'{self._r}.showDevConsoleButtonText'
487            ),
488            scale=1.0,
489            maxwidth=430,
490        )
491
492        v -= 42
493        self._disable_camera_shake_check_box = ConfigCheckBox(
494            parent=self._subcontainer,
495            position=(50, v),
496            size=(self._sub_width - 100, 30),
497            configkey='Disable Camera Shake',
498            displayname=bui.Lstr(resource=f'{self._r}.disableCameraShakeText'),
499            scale=1.0,
500            maxwidth=430,
501        )
502
503        self._disable_gyro_check_box: ConfigCheckBox | None = None
504        if self._show_disable_gyro:
505            v -= 42
506            self._disable_gyro_check_box = ConfigCheckBox(
507                parent=self._subcontainer,
508                position=(50, v),
509                size=(self._sub_width - 100, 30),
510                configkey='Disable Camera Gyro',
511                displayname=bui.Lstr(
512                    resource=f'{self._r}.disableCameraGyroscopeMotionText'
513                ),
514                scale=1.0,
515                maxwidth=430,
516            )
517
518        self._always_use_internal_keyboard_check_box: ConfigCheckBox | None
519        if self._show_always_use_internal_keyboard:
520            v -= 42
521            self._always_use_internal_keyboard_check_box = ConfigCheckBox(
522                parent=self._subcontainer,
523                position=(50, v),
524                size=(self._sub_width - 100, 30),
525                configkey='Always Use Internal Keyboard',
526                autoselect=True,
527                displayname=bui.Lstr(
528                    resource=f'{self._r}.alwaysUseInternalKeyboardText'
529                ),
530                scale=1.0,
531                maxwidth=430,
532            )
533            bui.textwidget(
534                parent=self._subcontainer,
535                position=(90, v - 10),
536                size=(0, 0),
537                text=bui.Lstr(
538                    resource=(
539                        f'{self._r}.alwaysUseInternalKeyboardDescriptionText'
540                    )
541                ),
542                maxwidth=400,
543                flatness=1.0,
544                scale=0.65,
545                color=(0.4, 0.9, 0.4, 0.8),
546                h_align='left',
547                v_align='center',
548            )
549            v -= 20
550        else:
551            self._always_use_internal_keyboard_check_box = None
552
553        v -= self._spacing * 2.1
554
555        this_button_width = 410
556        self._modding_guide_button = bui.buttonwidget(
557            parent=self._subcontainer,
558            position=(self._sub_width / 2 - this_button_width / 2, v - 10),
559            size=(this_button_width, 60),
560            autoselect=True,
561            label=bui.Lstr(resource=f'{self._r}.moddingGuideText'),
562            text_scale=1.0,
563            on_activate_call=bui.Call(
564                bui.open_url, 'https://ballistica.net/wiki/modding-guide'
565            ),
566        )
567        if self._show_always_use_internal_keyboard:
568            assert self._always_use_internal_keyboard_check_box is not None
569            bui.widget(
570                edit=self._always_use_internal_keyboard_check_box.widget,
571                down_widget=self._modding_guide_button,
572            )
573            bui.widget(
574                edit=self._modding_guide_button,
575                up_widget=self._always_use_internal_keyboard_check_box.widget,
576            )
577        else:
578            bui.widget(
579                edit=self._modding_guide_button,
580                up_widget=self._kick_idle_players_check_box.widget,
581            )
582            bui.widget(
583                edit=self._kick_idle_players_check_box.widget,
584                down_widget=self._modding_guide_button,
585            )
586
587        v -= self._spacing * 2.0
588
589        self._show_user_mods_button = bui.buttonwidget(
590            parent=self._subcontainer,
591            position=(self._sub_width / 2 - this_button_width / 2, v - 10),
592            size=(this_button_width, 60),
593            autoselect=True,
594            label=bui.Lstr(resource=f'{self._r}.showUserModsText'),
595            text_scale=1.0,
596            on_activate_call=show_user_scripts,
597        )
598
599        v -= self._spacing * 2.0
600
601        self._plugins_button = bui.buttonwidget(
602            parent=self._subcontainer,
603            position=(self._sub_width / 2 - this_button_width / 2, v - 10),
604            size=(this_button_width, 60),
605            autoselect=True,
606            label=bui.Lstr(resource='pluginsText'),
607            text_scale=1.0,
608            on_activate_call=self._on_plugins_button_press,
609        )
610
611        v -= self._spacing * 0.6
612
613        self._vr_test_button: bui.Widget | None
614        if self._do_vr_test_button:
615            v -= self._extra_button_spacing
616            self._vr_test_button = bui.buttonwidget(
617                parent=self._subcontainer,
618                position=(self._sub_width / 2 - this_button_width / 2, v - 14),
619                size=(this_button_width, 60),
620                autoselect=True,
621                label=bui.Lstr(resource=f'{self._r}.vrTestingText'),
622                text_scale=1.0,
623                on_activate_call=self._on_vr_test_press,
624            )
625        else:
626            self._vr_test_button = None
627
628        self._net_test_button: bui.Widget | None
629        if self._do_net_test_button:
630            v -= self._extra_button_spacing
631            self._net_test_button = bui.buttonwidget(
632                parent=self._subcontainer,
633                position=(self._sub_width / 2 - this_button_width / 2, v - 14),
634                size=(this_button_width, 60),
635                autoselect=True,
636                label=bui.Lstr(resource=f'{self._r}.netTestingText'),
637                text_scale=1.0,
638                on_activate_call=self._on_net_test_press,
639            )
640        else:
641            self._net_test_button = None
642
643        v -= 70
644        self._benchmarks_button = bui.buttonwidget(
645            parent=self._subcontainer,
646            position=(self._sub_width / 2 - this_button_width / 2, v - 14),
647            size=(this_button_width, 60),
648            autoselect=True,
649            label=bui.Lstr(resource=f'{self._r}.benchmarksText'),
650            text_scale=1.0,
651            on_activate_call=self._on_benchmark_press,
652        )
653
654        for child in self._subcontainer.get_children():
655            bui.widget(edit=child, show_buffer_bottom=30, show_buffer_top=20)
656
657        if bui.app.ui_v1.use_toolbars:
658            pbtn = bui.get_special_widget('party_button')
659            bui.widget(edit=self._scrollwidget, right_widget=pbtn)
660            if self._back_button is None:
661                bui.widget(
662                    edit=self._scrollwidget,
663                    left_widget=bui.get_special_widget('back_button'),
664                )
665
666        self._restore_state()
667
668    def _show_restart_needed(self, value: Any) -> None:
669        del value  # Unused.
670        bui.screenmessage(
671            bui.Lstr(resource=f'{self._r}.mustRestartText'), color=(1, 1, 0)
672        )
673
674    def _on_lang_inform_value_change(self, val: bool) -> None:
675        plus = bui.app.plus
676        assert plus is not None
677        plus.add_v1_account_transaction(
678            {'type': 'SET_MISC_VAL', 'name': 'langInform', 'value': val}
679        )
680        plus.run_v1_account_transactions()
681
682    def _on_vr_test_press(self) -> None:
683        from bauiv1lib.settings.vrtesting import VRTestingWindow
684
685        self._save_state()
686        bui.containerwidget(edit=self._root_widget, transition='out_left')
687        assert bui.app.classic is not None
688        bui.app.ui_v1.set_main_menu_window(
689            VRTestingWindow(transition='in_right').get_root_widget()
690        )
691
692    def _on_net_test_press(self) -> None:
693        plus = bui.app.plus
694        assert plus is not None
695        from bauiv1lib.settings.nettesting import NetTestingWindow
696
697        # Net-testing requires a signed in v1 account.
698        if plus.get_v1_account_state() != 'signed_in':
699            bui.screenmessage(
700                bui.Lstr(resource='notSignedInErrorText'), color=(1, 0, 0)
701            )
702            bui.getsound('error').play()
703            return
704
705        self._save_state()
706        bui.containerwidget(edit=self._root_widget, transition='out_left')
707        assert bui.app.classic is not None
708        bui.app.ui_v1.set_main_menu_window(
709            NetTestingWindow(transition='in_right').get_root_widget()
710        )
711
712    def _on_friend_promo_code_press(self) -> None:
713        from bauiv1lib import appinvite
714        from bauiv1lib import account
715
716        plus = bui.app.plus
717        assert plus is not None
718
719        if plus.get_v1_account_state() != 'signed_in':
720            account.show_sign_in_prompt()
721            return
722        appinvite.handle_app_invites_press()
723
724    def _on_plugins_button_press(self) -> None:
725        from bauiv1lib.settings.plugins import PluginWindow
726
727        self._save_state()
728        bui.containerwidget(edit=self._root_widget, transition='out_left')
729        assert bui.app.classic is not None
730        bui.app.ui_v1.set_main_menu_window(
731            PluginWindow(origin_widget=self._plugins_button).get_root_widget()
732        )
733
734    def _on_promo_code_press(self) -> None:
735        from bauiv1lib.promocode import PromoCodeWindow
736        from bauiv1lib.account import show_sign_in_prompt
737
738        plus = bui.app.plus
739        assert plus is not None
740
741        # We have to be logged in for promo-codes to work.
742        if plus.get_v1_account_state() != 'signed_in':
743            show_sign_in_prompt()
744            return
745        self._save_state()
746        bui.containerwidget(edit=self._root_widget, transition='out_left')
747        assert bui.app.classic is not None
748        bui.app.ui_v1.set_main_menu_window(
749            PromoCodeWindow(
750                origin_widget=self._promo_code_button
751            ).get_root_widget()
752        )
753
754    def _on_benchmark_press(self) -> None:
755        from bauiv1lib.debug import DebugWindow
756
757        self._save_state()
758        bui.containerwidget(edit=self._root_widget, transition='out_left')
759        assert bui.app.classic is not None
760        bui.app.ui_v1.set_main_menu_window(
761            DebugWindow(transition='in_right').get_root_widget()
762        )
763
764    def _save_state(self) -> None:
765        # pylint: disable=too-many-branches
766        try:
767            sel = self._root_widget.get_selected_child()
768            if sel == self._scrollwidget:
769                sel = self._subcontainer.get_selected_child()
770                if sel == self._vr_test_button:
771                    sel_name = 'VRTest'
772                elif sel == self._net_test_button:
773                    sel_name = 'NetTest'
774                elif sel == self._promo_code_button:
775                    sel_name = 'PromoCode'
776                elif sel == self._benchmarks_button:
777                    sel_name = 'Benchmarks'
778                elif sel == self._kick_idle_players_check_box.widget:
779                    sel_name = 'KickIdlePlayers'
780                elif sel == self._show_game_ping_check_box.widget:
781                    sel_name = 'ShowPing'
782                elif sel == self._disable_camera_shake_check_box.widget:
783                    sel_name = 'DisableCameraShake'
784                elif (
785                    self._always_use_internal_keyboard_check_box is not None
786                    and sel
787                    == self._always_use_internal_keyboard_check_box.widget
788                ):
789                    sel_name = 'AlwaysUseInternalKeyboard'
790                elif (
791                    self._disable_gyro_check_box is not None
792                    and sel == self._disable_gyro_check_box.widget
793                ):
794                    sel_name = 'DisableGyro'
795                elif (
796                    self._language_popup is not None
797                    and sel == self._language_popup.get_button()
798                ):
799                    sel_name = 'Languages'
800                elif sel == self._translation_editor_button:
801                    sel_name = 'TranslationEditor'
802                elif sel == self._show_user_mods_button:
803                    sel_name = 'ShowUserMods'
804                elif sel == self._plugins_button:
805                    sel_name = 'Plugins'
806                elif sel == self._modding_guide_button:
807                    sel_name = 'ModdingGuide'
808                elif sel == self._language_inform_checkbox:
809                    sel_name = 'LangInform'
810                else:
811                    raise ValueError(f'unrecognized selection \'{sel}\'')
812            elif sel == self._back_button:
813                sel_name = 'Back'
814            else:
815                raise ValueError(f'unrecognized selection \'{sel}\'')
816            assert bui.app.classic is not None
817            bui.app.ui_v1.window_states[type(self)] = {'sel_name': sel_name}
818
819        except Exception:
820            logging.exception('Error saving state for %s.', self)
821
822    def _restore_state(self) -> None:
823        # pylint: disable=too-many-branches
824        try:
825            assert bui.app.classic is not None
826            sel_name = bui.app.ui_v1.window_states.get(type(self), {}).get(
827                'sel_name'
828            )
829            if sel_name == 'Back':
830                sel = self._back_button
831            else:
832                bui.containerwidget(
833                    edit=self._root_widget, selected_child=self._scrollwidget
834                )
835                if sel_name == 'VRTest':
836                    sel = self._vr_test_button
837                elif sel_name == 'NetTest':
838                    sel = self._net_test_button
839                elif sel_name == 'PromoCode':
840                    sel = self._promo_code_button
841                elif sel_name == 'Benchmarks':
842                    sel = self._benchmarks_button
843                elif sel_name == 'KickIdlePlayers':
844                    sel = self._kick_idle_players_check_box.widget
845                elif sel_name == 'ShowPing':
846                    sel = self._show_game_ping_check_box.widget
847                elif sel_name == 'DisableCameraShake':
848                    sel = self._disable_camera_shake_check_box.widget
849                elif (
850                    sel_name == 'AlwaysUseInternalKeyboard'
851                    and self._always_use_internal_keyboard_check_box is not None
852                ):
853                    sel = self._always_use_internal_keyboard_check_box.widget
854                elif (
855                    sel_name == 'DisableGyro'
856                    and self._disable_gyro_check_box is not None
857                ):
858                    sel = self._disable_gyro_check_box.widget
859                elif (
860                    sel_name == 'Languages' and self._language_popup is not None
861                ):
862                    sel = self._language_popup.get_button()
863                elif sel_name == 'TranslationEditor':
864                    sel = self._translation_editor_button
865                elif sel_name == 'ShowUserMods':
866                    sel = self._show_user_mods_button
867                elif sel_name == 'Plugins':
868                    sel = self._plugins_button
869                elif sel_name == 'ModdingGuide':
870                    sel = self._modding_guide_button
871                elif sel_name == 'LangInform':
872                    sel = self._language_inform_checkbox
873                else:
874                    sel = None
875                if sel is not None:
876                    bui.containerwidget(
877                        edit=self._subcontainer,
878                        selected_child=sel,
879                        visible_child=sel,
880                    )
881        except Exception:
882            logging.exception('Error restoring state for %s.', self)
883
884    def _on_menu_open(self) -> None:
885        self._menu_open = True
886
887    def _on_menu_close(self) -> None:
888        self._menu_open = False
889
890    def _on_menu_choice(self, choice: str) -> None:
891        bui.app.lang.setlanguage(None if choice == 'Auto' else choice)
892        self._save_state()
893        bui.apptimer(0.1, bui.WeakCall(self._rebuild))
894
895    def _completed_langs_cb(self, results: dict[str, Any] | None) -> None:
896        if results is not None and results['langs'] is not None:
897            self._complete_langs_list = results['langs']
898            self._complete_langs_error = False
899        else:
900            self._complete_langs_list = None
901            self._complete_langs_error = True
902        bui.apptimer(0.001, bui.WeakCall(self._update_lang_status))
903
904    def _do_back(self) -> None:
905        from bauiv1lib.settings.allsettings import AllSettingsWindow
906
907        self._save_state()
908        bui.containerwidget(
909            edit=self._root_widget, transition=self._transition_out
910        )
911        assert bui.app.classic is not None
912        bui.app.ui_v1.set_main_menu_window(
913            AllSettingsWindow(transition='in_left').get_root_widget()
914        )