bauiv1lib.playoptions

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides a window for configuring play options."""
  4
  5from __future__ import annotations
  6
  7import logging
  8from typing import TYPE_CHECKING
  9
 10import bascenev1 as bs
 11import bauiv1 as bui
 12
 13from bauiv1lib.popup import PopupWindow
 14
 15if TYPE_CHECKING:
 16    from typing import Any
 17
 18
 19class PlayOptionsWindow(PopupWindow):
 20    """A popup window for configuring play options."""
 21
 22    def __init__(
 23        self,
 24        sessiontype: type[bs.Session],
 25        playlist: str,
 26        scale_origin: tuple[float, float],
 27        delegate: Any = None,
 28    ):
 29        # FIXME: Tidy this up.
 30        # pylint: disable=too-many-branches
 31        # pylint: disable=too-many-statements
 32        # pylint: disable=too-many-locals
 33        from bascenev1 import filter_playlist, get_map_class
 34        from bauiv1lib.playlist import PlaylistTypeVars
 35
 36        self._r = 'gameListWindow'
 37        self._delegate = delegate
 38        self._pvars = PlaylistTypeVars(sessiontype)
 39        self._transitioning_out = False
 40
 41        # We behave differently if we're being used for playlist selection
 42        # vs starting a game directly (should make this more elegant).
 43        assert bui.app.classic is not None
 44        self._selecting_mode = bui.app.ui_v1.selecting_private_party_playlist
 45
 46        self._do_randomize_val = bui.app.config.get(
 47            self._pvars.config_name + ' Playlist Randomize', 0
 48        )
 49
 50        self._sessiontype = sessiontype
 51        self._playlist = playlist
 52
 53        self._width = 500.0
 54        self._height = 330.0 - 50.0
 55
 56        # In teams games, show the custom names/colors button.
 57        if self._sessiontype is bs.DualTeamSession:
 58            self._height += 50.0
 59
 60        self._row_height = 45.0
 61
 62        # Grab our maps to display.
 63        mesh_opaque = bui.getmesh('level_select_button_opaque')
 64        mesh_transparent = bui.getmesh('level_select_button_transparent')
 65        mask_tex = bui.gettexture('mapPreviewMask')
 66
 67        # Poke into this playlist and see if we can display some of its maps.
 68        map_textures = []
 69        map_texture_entries = []
 70        rows = 0
 71        columns = 0
 72        game_count = 0
 73        scl = 0.35
 74        c_width_total = 0.0
 75        try:
 76            max_columns = 5
 77            name = playlist
 78            if name == '__default__':
 79                plst = self._pvars.get_default_list_call()
 80            else:
 81                try:
 82                    plst = bui.app.config[
 83                        self._pvars.config_name + ' Playlists'
 84                    ][name]
 85                except Exception:
 86                    print(
 87                        'ERROR INFO: self._config_name is:',
 88                        self._pvars.config_name,
 89                    )
 90                    print(
 91                        'ERROR INFO: playlist names are:',
 92                        list(
 93                            bui.app.config[
 94                                self._pvars.config_name + ' Playlists'
 95                            ].keys()
 96                        ),
 97                    )
 98                    raise
 99            plst = filter_playlist(
100                plst,
101                self._sessiontype,
102                remove_unowned=False,
103                mark_unowned=True,
104                name=name,
105            )
106            game_count = len(plst)
107            for entry in plst:
108                mapname = entry['settings']['map']
109                maptype: type[bs.Map] | None
110                try:
111                    maptype = get_map_class(mapname)
112                except bui.NotFoundError:
113                    maptype = None
114                if maptype is not None:
115                    tex_name = maptype.get_preview_texture_name()
116                    if tex_name is not None:
117                        map_textures.append(tex_name)
118                        map_texture_entries.append(entry)
119            rows = (max(0, len(map_textures) - 1) // max_columns) + 1
120            columns = min(max_columns, len(map_textures))
121
122            if len(map_textures) == 1:
123                scl = 1.1
124            elif len(map_textures) == 2:
125                scl = 0.7
126            elif len(map_textures) == 3:
127                scl = 0.55
128            else:
129                scl = 0.35
130            self._row_height = 128.0 * scl
131            c_width_total = scl * 250.0 * columns
132            if map_textures:
133                self._height += self._row_height * rows
134
135        except Exception:
136            logging.exception('Error listing playlist maps.')
137
138        show_shuffle_check_box = game_count > 1
139
140        if show_shuffle_check_box:
141            self._height += 40
142
143        # Creates our _root_widget.
144        uiscale = bui.app.ui_v1.uiscale
145        scale = (
146            1.69
147            if uiscale is bui.UIScale.SMALL
148            else 1.1
149            if uiscale is bui.UIScale.MEDIUM
150            else 0.85
151        )
152        super().__init__(
153            position=scale_origin, size=(self._width, self._height), scale=scale
154        )
155
156        playlist_name: str | bui.Lstr = (
157            self._pvars.default_list_name
158            if playlist == '__default__'
159            else playlist
160        )
161        self._title_text = bui.textwidget(
162            parent=self.root_widget,
163            position=(self._width * 0.5, self._height - 89 + 51),
164            size=(0, 0),
165            text=playlist_name,
166            scale=1.4,
167            color=(1, 1, 1),
168            maxwidth=self._width * 0.7,
169            h_align='center',
170            v_align='center',
171        )
172
173        self._cancel_button = bui.buttonwidget(
174            parent=self.root_widget,
175            position=(25, self._height - 53),
176            size=(50, 50),
177            scale=0.7,
178            label='',
179            color=(0.42, 0.73, 0.2),
180            on_activate_call=self._on_cancel_press,
181            autoselect=True,
182            icon=bui.gettexture('crossOut'),
183            iconscale=1.2,
184        )
185
186        h_offs_img = self._width * 0.5 - c_width_total * 0.5
187        v_offs_img = self._height - 118 - scl * 125.0 + 50
188        bottom_row_buttons = []
189        self._have_at_least_one_owned = False
190
191        for row in range(rows):
192            for col in range(columns):
193                tex_index = row * columns + col
194                if tex_index < len(map_textures):
195                    tex_name = map_textures[tex_index]
196                    h = h_offs_img + scl * 250 * col
197                    v = v_offs_img - self._row_height * row
198                    entry = map_texture_entries[tex_index]
199                    owned = not (
200                        ('is_unowned_map' in entry and entry['is_unowned_map'])
201                        or (
202                            'is_unowned_game' in entry
203                            and entry['is_unowned_game']
204                        )
205                    )
206
207                    if owned:
208                        self._have_at_least_one_owned = True
209
210                    try:
211                        desc = bui.getclass(
212                            entry['type'], subclassof=bs.GameActivity
213                        ).get_settings_display_string(entry)
214                        if not owned:
215                            desc = bui.Lstr(
216                                value='${DESC}\n${UNLOCK}',
217                                subs=[
218                                    ('${DESC}', desc),
219                                    (
220                                        '${UNLOCK}',
221                                        bui.Lstr(
222                                            resource='unlockThisInTheStoreText'
223                                        ),
224                                    ),
225                                ],
226                            )
227                        desc_color = (0, 1, 0) if owned else (1, 0, 0)
228                    except Exception:
229                        desc = bui.Lstr(value='(invalid)')
230                        desc_color = (1, 0, 0)
231
232                    btn = bui.buttonwidget(
233                        parent=self.root_widget,
234                        size=(scl * 240.0, scl * 120.0),
235                        position=(h, v),
236                        texture=bui.gettexture(tex_name if owned else 'empty'),
237                        mesh_opaque=mesh_opaque if owned else None,
238                        on_activate_call=bui.Call(
239                            bui.screenmessage, desc, desc_color
240                        ),
241                        label='',
242                        color=(1, 1, 1),
243                        autoselect=True,
244                        extra_touch_border_scale=0.0,
245                        mesh_transparent=mesh_transparent if owned else None,
246                        mask_texture=mask_tex if owned else None,
247                    )
248                    if row == 0 and col == 0:
249                        bui.widget(edit=self._cancel_button, down_widget=btn)
250                    if row == rows - 1:
251                        bottom_row_buttons.append(btn)
252                    if not owned:
253                        # Ewww; buttons don't currently have alpha so in this
254                        # case we draw an image over our button with an empty
255                        # texture on it.
256                        bui.imagewidget(
257                            parent=self.root_widget,
258                            size=(scl * 260.0, scl * 130.0),
259                            position=(h - 10.0 * scl, v - 4.0 * scl),
260                            draw_controller=btn,
261                            color=(1, 1, 1),
262                            texture=bui.gettexture(tex_name),
263                            mesh_opaque=mesh_opaque,
264                            opacity=0.25,
265                            mesh_transparent=mesh_transparent,
266                            mask_texture=mask_tex,
267                        )
268
269                        bui.imagewidget(
270                            parent=self.root_widget,
271                            size=(scl * 100, scl * 100),
272                            draw_controller=btn,
273                            position=(h + scl * 70, v + scl * 10),
274                            texture=bui.gettexture('lock'),
275                        )
276
277        # Team names/colors.
278        self._custom_colors_names_button: bui.Widget | None
279        if self._sessiontype is bs.DualTeamSession:
280            y_offs = 50 if show_shuffle_check_box else 0
281            self._custom_colors_names_button = bui.buttonwidget(
282                parent=self.root_widget,
283                position=(100, 200 + y_offs),
284                size=(290, 35),
285                on_activate_call=bui.WeakCall(self._custom_colors_names_press),
286                autoselect=True,
287                textcolor=(0.8, 0.8, 0.8),
288                label=bui.Lstr(resource='teamNamesColorText'),
289            )
290            assert bui.app.classic is not None
291            if not bui.app.classic.accounts.have_pro():
292                bui.imagewidget(
293                    parent=self.root_widget,
294                    size=(30, 30),
295                    position=(95, 202 + y_offs),
296                    texture=bui.gettexture('lock'),
297                    draw_controller=self._custom_colors_names_button,
298                )
299        else:
300            self._custom_colors_names_button = None
301
302        # Shuffle.
303        def _cb_callback(val: bool) -> None:
304            self._do_randomize_val = val
305            cfg = bui.app.config
306            cfg[
307                self._pvars.config_name + ' Playlist Randomize'
308            ] = self._do_randomize_val
309            cfg.commit()
310
311        if show_shuffle_check_box:
312            self._shuffle_check_box = bui.checkboxwidget(
313                parent=self.root_widget,
314                position=(110, 200),
315                scale=1.0,
316                size=(250, 30),
317                autoselect=True,
318                text=bui.Lstr(resource=self._r + '.shuffleGameOrderText'),
319                maxwidth=300,
320                textcolor=(0.8, 0.8, 0.8),
321                value=self._do_randomize_val,
322                on_value_change_call=_cb_callback,
323            )
324
325        # Show tutorial.
326        show_tutorial = bool(bui.app.config.get('Show Tutorial', True))
327
328        def _cb_callback_2(val: bool) -> None:
329            cfg = bui.app.config
330            cfg['Show Tutorial'] = val
331            cfg.commit()
332
333        self._show_tutorial_check_box = bui.checkboxwidget(
334            parent=self.root_widget,
335            position=(110, 151),
336            scale=1.0,
337            size=(250, 30),
338            autoselect=True,
339            text=bui.Lstr(resource=self._r + '.showTutorialText'),
340            maxwidth=300,
341            textcolor=(0.8, 0.8, 0.8),
342            value=show_tutorial,
343            on_value_change_call=_cb_callback_2,
344        )
345
346        # Grumble: current autoselect doesn't do a very good job
347        # with checkboxes.
348        if self._custom_colors_names_button is not None:
349            for btn in bottom_row_buttons:
350                bui.widget(
351                    edit=btn, down_widget=self._custom_colors_names_button
352                )
353            if show_shuffle_check_box:
354                bui.widget(
355                    edit=self._custom_colors_names_button,
356                    down_widget=self._shuffle_check_box,
357                )
358                bui.widget(
359                    edit=self._shuffle_check_box,
360                    up_widget=self._custom_colors_names_button,
361                )
362            else:
363                bui.widget(
364                    edit=self._custom_colors_names_button,
365                    down_widget=self._show_tutorial_check_box,
366                )
367                bui.widget(
368                    edit=self._show_tutorial_check_box,
369                    up_widget=self._custom_colors_names_button,
370                )
371
372        self._ok_button = bui.buttonwidget(
373            parent=self.root_widget,
374            position=(70, 44),
375            size=(200, 45),
376            scale=1.8,
377            text_res_scale=1.5,
378            on_activate_call=self._on_ok_press,
379            autoselect=True,
380            label=bui.Lstr(
381                resource='okText' if self._selecting_mode else 'playText'
382            ),
383        )
384
385        bui.widget(
386            edit=self._ok_button, up_widget=self._show_tutorial_check_box
387        )
388
389        bui.containerwidget(
390            edit=self.root_widget,
391            start_button=self._ok_button,
392            cancel_button=self._cancel_button,
393            selected_child=self._ok_button,
394        )
395
396        # Update now and once per second.
397        self._update_timer = bui.AppTimer(
398            1.0, bui.WeakCall(self._update), repeat=True
399        )
400        self._update()
401
402    def _custom_colors_names_press(self) -> None:
403        from bauiv1lib.account import show_sign_in_prompt
404        from bauiv1lib.teamnamescolors import TeamNamesColorsWindow
405        from bauiv1lib.purchase import PurchaseWindow
406
407        plus = bui.app.plus
408        assert plus is not None
409
410        assert bui.app.classic is not None
411        if not bui.app.classic.accounts.have_pro():
412            if plus.get_v1_account_state() != 'signed_in':
413                show_sign_in_prompt()
414            else:
415                PurchaseWindow(items=['pro'])
416            self._transition_out()
417            return
418        assert self._custom_colors_names_button
419        TeamNamesColorsWindow(
420            scale_origin=(
421                self._custom_colors_names_button.get_screen_space_center()
422            )
423        )
424
425    def _does_target_playlist_exist(self) -> bool:
426        if self._playlist == '__default__':
427            return True
428        return self._playlist in bui.app.config.get(
429            self._pvars.config_name + ' Playlists', {}
430        )
431
432    def _update(self) -> None:
433        # All we do here is make sure our targeted playlist still exists,
434        # and close ourself if not.
435        if not self._does_target_playlist_exist():
436            self._transition_out()
437
438    def _transition_out(self, transition: str = 'out_scale') -> None:
439        if not self._transitioning_out:
440            self._transitioning_out = True
441            bui.containerwidget(edit=self.root_widget, transition=transition)
442
443    def on_popup_cancel(self) -> None:
444        bui.getsound('swish').play()
445        self._transition_out()
446
447    def _on_cancel_press(self) -> None:
448        self._transition_out()
449
450    def _on_ok_press(self) -> None:
451        # Disallow if our playlist has disappeared.
452        if not self._does_target_playlist_exist():
453            return
454
455        # Disallow if we have no unlocked games.
456        if not self._have_at_least_one_owned:
457            bui.getsound('error').play()
458            bui.screenmessage(
459                bui.Lstr(resource='playlistNoValidGamesErrorText'),
460                color=(1, 0, 0),
461            )
462            return
463
464        cfg = bui.app.config
465        cfg[self._pvars.config_name + ' Playlist Selection'] = self._playlist
466
467        # Head back to the gather window in playlist-select mode
468        # or start the game in regular mode.
469        if self._selecting_mode:
470            from bauiv1lib.gather import GatherWindow
471
472            if self._sessiontype is bs.FreeForAllSession:
473                typename = 'ffa'
474            elif self._sessiontype is bs.DualTeamSession:
475                typename = 'teams'
476            else:
477                raise RuntimeError('Only teams and ffa currently supported')
478            cfg['Private Party Host Session Type'] = typename
479            bui.getsound('gunCocking').play()
480            assert bui.app.classic is not None
481            bui.app.ui_v1.set_main_menu_window(
482                GatherWindow(transition='in_right').get_root_widget()
483            )
484            self._transition_out(transition='out_left')
485            if self._delegate is not None:
486                self._delegate.on_play_options_window_run_game()
487        else:
488            bui.fade_screen(False, endcall=self._run_selected_playlist)
489            bui.lock_all_input()
490            self._transition_out(transition='out_left')
491            if self._delegate is not None:
492                self._delegate.on_play_options_window_run_game()
493
494        cfg.commit()
495
496    def _run_selected_playlist(self) -> None:
497        bui.unlock_all_input()
498        try:
499            bs.new_host_session(self._sessiontype)
500        except Exception:
501            from bascenev1lib import mainmenu
502
503            logging.exception('Error running session %s.', self._sessiontype)
504
505            # Drop back into a main menu session.
506            bs.new_host_session(mainmenu.MainMenuSession)