bastd.ui.playlist.edit

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides a window for editing individual game playlists."""
  4
  5from __future__ import annotations
  6
  7from typing import TYPE_CHECKING, cast
  8
  9import ba
 10import _ba
 11
 12if TYPE_CHECKING:
 13    from bastd.ui.playlist.editcontroller import PlaylistEditController
 14
 15
 16class PlaylistEditWindow(ba.Window):
 17    """Window for editing an individual game playlist."""
 18
 19    def __init__(self,
 20                 editcontroller: PlaylistEditController,
 21                 transition: str = 'in_right'):
 22        # pylint: disable=too-many-statements
 23        # pylint: disable=too-many-locals
 24        prev_selection: str | None
 25        self._editcontroller = editcontroller
 26        self._r = 'editGameListWindow'
 27        prev_selection = self._editcontroller.get_edit_ui_selection()
 28
 29        uiscale = ba.app.ui.uiscale
 30        self._width = 770 if uiscale is ba.UIScale.SMALL else 670
 31        x_inset = 50 if uiscale is ba.UIScale.SMALL else 0
 32        self._height = (400 if uiscale is ba.UIScale.SMALL else
 33                        470 if uiscale is ba.UIScale.MEDIUM else 540)
 34
 35        top_extra = 20 if uiscale is ba.UIScale.SMALL else 0
 36        super().__init__(root_widget=ba.containerwidget(
 37            size=(self._width, self._height + top_extra),
 38            transition=transition,
 39            scale=(2.0 if uiscale is ba.UIScale.SMALL else
 40                   1.3 if uiscale is ba.UIScale.MEDIUM else 1.0),
 41            stack_offset=(0, -16) if uiscale is ba.UIScale.SMALL else (0, 0)))
 42        cancel_button = ba.buttonwidget(parent=self._root_widget,
 43                                        position=(35 + x_inset,
 44                                                  self._height - 60),
 45                                        scale=0.8,
 46                                        size=(175, 60),
 47                                        autoselect=True,
 48                                        label=ba.Lstr(resource='cancelText'),
 49                                        text_scale=1.2)
 50        save_button = btn = ba.buttonwidget(
 51            parent=self._root_widget,
 52            position=(self._width - (195 + x_inset), self._height - 60),
 53            scale=0.8,
 54            size=(190, 60),
 55            autoselect=True,
 56            left_widget=cancel_button,
 57            label=ba.Lstr(resource='saveText'),
 58            text_scale=1.2)
 59
 60        if ba.app.ui.use_toolbars:
 61            ba.widget(edit=btn,
 62                      right_widget=_ba.get_special_widget('party_button'))
 63
 64        ba.widget(edit=cancel_button,
 65                  left_widget=cancel_button,
 66                  right_widget=save_button)
 67
 68        ba.textwidget(parent=self._root_widget,
 69                      position=(-10, self._height - 50),
 70                      size=(self._width, 25),
 71                      text=ba.Lstr(resource=self._r + '.titleText'),
 72                      color=ba.app.ui.title_color,
 73                      scale=1.05,
 74                      h_align='center',
 75                      v_align='center',
 76                      maxwidth=270)
 77
 78        v = self._height - 115.0
 79
 80        self._scroll_width = self._width - (205 + 2 * x_inset)
 81
 82        ba.textwidget(parent=self._root_widget,
 83                      text=ba.Lstr(resource=self._r + '.listNameText'),
 84                      position=(196 + x_inset, v + 31),
 85                      maxwidth=150,
 86                      color=(0.8, 0.8, 0.8, 0.5),
 87                      size=(0, 0),
 88                      scale=0.75,
 89                      h_align='right',
 90                      v_align='center')
 91
 92        self._text_field = ba.textwidget(
 93            parent=self._root_widget,
 94            position=(210 + x_inset, v + 7),
 95            size=(self._scroll_width - 53, 43),
 96            text=self._editcontroller.getname(),
 97            h_align='left',
 98            v_align='center',
 99            max_chars=40,
100            autoselect=True,
101            color=(0.9, 0.9, 0.9, 1.0),
102            description=ba.Lstr(resource=self._r + '.listNameText'),
103            editable=True,
104            padding=4,
105            on_return_press_call=self._save_press_with_sound)
106        ba.widget(edit=cancel_button, down_widget=self._text_field)
107
108        self._list_widgets: list[ba.Widget] = []
109
110        h = 40 + x_inset
111        v = self._height - 172.0
112
113        b_color = (0.6, 0.53, 0.63)
114        b_textcolor = (0.75, 0.7, 0.8)
115
116        v -= 2.0
117        v += 63
118
119        scl = (1.03 if uiscale is ba.UIScale.SMALL else
120               1.36 if uiscale is ba.UIScale.MEDIUM else 1.74)
121        v -= 63.0 * scl
122
123        add_game_button = ba.buttonwidget(
124            parent=self._root_widget,
125            position=(h, v),
126            size=(110, 61.0 * scl),
127            on_activate_call=self._add,
128            on_select_call=ba.Call(self._set_ui_selection, 'add_button'),
129            autoselect=True,
130            button_type='square',
131            color=b_color,
132            textcolor=b_textcolor,
133            text_scale=0.8,
134            label=ba.Lstr(resource=self._r + '.addGameText'))
135        ba.widget(edit=add_game_button, up_widget=self._text_field)
136        v -= 63.0 * scl
137
138        self._edit_button = edit_game_button = ba.buttonwidget(
139            parent=self._root_widget,
140            position=(h, v),
141            size=(110, 61.0 * scl),
142            on_activate_call=self._edit,
143            on_select_call=ba.Call(self._set_ui_selection, 'editButton'),
144            autoselect=True,
145            button_type='square',
146            color=b_color,
147            textcolor=b_textcolor,
148            text_scale=0.8,
149            label=ba.Lstr(resource=self._r + '.editGameText'))
150        v -= 63.0 * scl
151
152        remove_game_button = ba.buttonwidget(parent=self._root_widget,
153                                             position=(h, v),
154                                             size=(110, 61.0 * scl),
155                                             text_scale=0.8,
156                                             on_activate_call=self._remove,
157                                             autoselect=True,
158                                             button_type='square',
159                                             color=b_color,
160                                             textcolor=b_textcolor,
161                                             label=ba.Lstr(resource=self._r +
162                                                           '.removeGameText'))
163        v -= 40
164        h += 9
165        ba.buttonwidget(parent=self._root_widget,
166                        position=(h, v),
167                        size=(42, 35),
168                        on_activate_call=self._move_up,
169                        label=ba.charstr(ba.SpecialChar.UP_ARROW),
170                        button_type='square',
171                        color=b_color,
172                        textcolor=b_textcolor,
173                        autoselect=True,
174                        repeat=True)
175        h += 52
176        ba.buttonwidget(parent=self._root_widget,
177                        position=(h, v),
178                        size=(42, 35),
179                        on_activate_call=self._move_down,
180                        autoselect=True,
181                        button_type='square',
182                        color=b_color,
183                        textcolor=b_textcolor,
184                        label=ba.charstr(ba.SpecialChar.DOWN_ARROW),
185                        repeat=True)
186
187        v = self._height - 100
188        scroll_height = self._height - 155
189        scrollwidget = ba.scrollwidget(
190            parent=self._root_widget,
191            position=(160 + x_inset, v - scroll_height),
192            highlight=False,
193            on_select_call=ba.Call(self._set_ui_selection, 'gameList'),
194            size=(self._scroll_width, (scroll_height - 15)))
195        ba.widget(edit=scrollwidget,
196                  left_widget=add_game_button,
197                  right_widget=scrollwidget)
198        self._columnwidget = ba.columnwidget(parent=scrollwidget,
199                                             border=2,
200                                             margin=0)
201        ba.widget(edit=self._columnwidget, up_widget=self._text_field)
202
203        for button in [add_game_button, edit_game_button, remove_game_button]:
204            ba.widget(edit=button,
205                      left_widget=button,
206                      right_widget=scrollwidget)
207
208        self._refresh()
209
210        ba.buttonwidget(edit=cancel_button, on_activate_call=self._cancel)
211        ba.containerwidget(edit=self._root_widget,
212                           cancel_button=cancel_button,
213                           selected_child=scrollwidget)
214
215        ba.buttonwidget(edit=save_button, on_activate_call=self._save_press)
216        ba.containerwidget(edit=self._root_widget, start_button=save_button)
217
218        if prev_selection == 'add_button':
219            ba.containerwidget(edit=self._root_widget,
220                               selected_child=add_game_button)
221        elif prev_selection == 'editButton':
222            ba.containerwidget(edit=self._root_widget,
223                               selected_child=edit_game_button)
224        elif prev_selection == 'gameList':
225            ba.containerwidget(edit=self._root_widget,
226                               selected_child=scrollwidget)
227
228    def _set_ui_selection(self, selection: str) -> None:
229        self._editcontroller.set_edit_ui_selection(selection)
230
231    def _cancel(self) -> None:
232        from bastd.ui.playlist.customizebrowser import (
233            PlaylistCustomizeBrowserWindow)
234        ba.playsound(ba.getsound('powerdown01'))
235        ba.containerwidget(edit=self._root_widget, transition='out_right')
236        ba.app.ui.set_main_menu_window(
237            PlaylistCustomizeBrowserWindow(
238                transition='in_left',
239                sessiontype=self._editcontroller.get_session_type(),
240                select_playlist=self._editcontroller.
241                get_existing_playlist_name()).get_root_widget())
242
243    def _add(self) -> None:
244        # Store list name then tell the session to perform an add.
245        self._editcontroller.setname(
246            cast(str, ba.textwidget(query=self._text_field)))
247        self._editcontroller.add_game_pressed()
248
249    def _edit(self) -> None:
250        # Store list name then tell the session to perform an add.
251        self._editcontroller.setname(
252            cast(str, ba.textwidget(query=self._text_field)))
253        self._editcontroller.edit_game_pressed()
254
255    def _save_press(self) -> None:
256        from bastd.ui.playlist.customizebrowser import (
257            PlaylistCustomizeBrowserWindow)
258        new_name = cast(str, ba.textwidget(query=self._text_field))
259        if (new_name != self._editcontroller.get_existing_playlist_name()
260                and new_name
261                in ba.app.config[self._editcontroller.get_config_name() +
262                                 ' Playlists']):
263            ba.screenmessage(
264                ba.Lstr(resource=self._r + '.cantSaveAlreadyExistsText'))
265            ba.playsound(ba.getsound('error'))
266            return
267        if not new_name:
268            ba.playsound(ba.getsound('error'))
269            return
270        if not self._editcontroller.get_playlist():
271            ba.screenmessage(
272                ba.Lstr(resource=self._r + '.cantSaveEmptyListText'))
273            ba.playsound(ba.getsound('error'))
274            return
275
276        # We couldn't actually replace the default list anyway, but disallow
277        # using its exact name to avoid confusion.
278        if new_name == self._editcontroller.get_default_list_name().evaluate():
279            ba.screenmessage(
280                ba.Lstr(resource=self._r + '.cantOverwriteDefaultText'))
281            ba.playsound(ba.getsound('error'))
282            return
283
284        # If we had an old one, delete it.
285        if self._editcontroller.get_existing_playlist_name() is not None:
286            _ba.add_transaction({
287                'type':
288                    'REMOVE_PLAYLIST',
289                'playlistType':
290                    self._editcontroller.get_config_name(),
291                'playlistName':
292                    self._editcontroller.get_existing_playlist_name()
293            })
294
295        _ba.add_transaction({
296            'type': 'ADD_PLAYLIST',
297            'playlistType': self._editcontroller.get_config_name(),
298            'playlistName': new_name,
299            'playlist': self._editcontroller.get_playlist()
300        })
301        _ba.run_transactions()
302
303        ba.containerwidget(edit=self._root_widget, transition='out_right')
304        ba.playsound(ba.getsound('gunCocking'))
305        ba.app.ui.set_main_menu_window(
306            PlaylistCustomizeBrowserWindow(
307                transition='in_left',
308                sessiontype=self._editcontroller.get_session_type(),
309                select_playlist=new_name).get_root_widget())
310
311    def _save_press_with_sound(self) -> None:
312        ba.playsound(ba.getsound('swish'))
313        self._save_press()
314
315    def _select(self, index: int) -> None:
316        self._editcontroller.set_selected_index(index)
317
318    def _refresh(self) -> None:
319        from ba.internal import getclass
320
321        # Need to grab this here as rebuilding the list will
322        # change it otherwise.
323        old_selection_index = self._editcontroller.get_selected_index()
324
325        while self._list_widgets:
326            self._list_widgets.pop().delete()
327        for index, pentry in enumerate(self._editcontroller.get_playlist()):
328
329            try:
330                cls = getclass(pentry['type'], subclassof=ba.GameActivity)
331                desc = cls.get_settings_display_string(pentry)
332            except Exception:
333                ba.print_exception()
334                desc = "(invalid: '" + pentry['type'] + "')"
335
336            txtw = ba.textwidget(parent=self._columnwidget,
337                                 size=(self._width - 80, 30),
338                                 on_select_call=ba.Call(self._select, index),
339                                 always_highlight=True,
340                                 color=(0.8, 0.8, 0.8, 1.0),
341                                 padding=0,
342                                 maxwidth=self._scroll_width * 0.93,
343                                 text=desc,
344                                 on_activate_call=self._edit_button.activate,
345                                 v_align='center',
346                                 selectable=True)
347            ba.widget(edit=txtw, show_buffer_top=50, show_buffer_bottom=50)
348
349            # Wanna be able to jump up to the text field from the top one.
350            if index == 0:
351                ba.widget(edit=txtw, up_widget=self._text_field)
352            self._list_widgets.append(txtw)
353            if old_selection_index == index:
354                ba.columnwidget(edit=self._columnwidget,
355                                selected_child=txtw,
356                                visible_child=txtw)
357
358    def _move_down(self) -> None:
359        playlist = self._editcontroller.get_playlist()
360        index = self._editcontroller.get_selected_index()
361        if index >= len(playlist) - 1:
362            return
363        tmp = playlist[index]
364        playlist[index] = playlist[index + 1]
365        playlist[index + 1] = tmp
366        index += 1
367        self._editcontroller.set_playlist(playlist)
368        self._editcontroller.set_selected_index(index)
369        self._refresh()
370
371    def _move_up(self) -> None:
372        playlist = self._editcontroller.get_playlist()
373        index = self._editcontroller.get_selected_index()
374        if index < 1:
375            return
376        tmp = playlist[index]
377        playlist[index] = (playlist[index - 1])
378        playlist[index - 1] = tmp
379        index -= 1
380        self._editcontroller.set_playlist(playlist)
381        self._editcontroller.set_selected_index(index)
382        self._refresh()
383
384    def _remove(self) -> None:
385        playlist = self._editcontroller.get_playlist()
386        index = self._editcontroller.get_selected_index()
387        if not playlist:
388            return
389        del playlist[index]
390        if index >= len(playlist):
391            index = len(playlist) - 1
392        self._editcontroller.set_playlist(playlist)
393        self._editcontroller.set_selected_index(index)
394        ba.playsound(ba.getsound('shieldDown'))
395        self._refresh()