bastd.ui.gather

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides UI for inviting/joining friends."""
  4
  5from __future__ import annotations
  6
  7import weakref
  8from enum import Enum
  9from typing import TYPE_CHECKING
 10
 11import ba
 12import ba.internal
 13from bastd.ui.tabs import TabRow
 14
 15if TYPE_CHECKING:
 16    pass
 17
 18
 19class GatherTab:
 20    """Defines a tab for use in the gather UI."""
 21
 22    def __init__(self, window: GatherWindow) -> None:
 23        self._window = weakref.ref(window)
 24
 25    @property
 26    def window(self) -> GatherWindow:
 27        """The GatherWindow that this tab belongs to."""
 28        window = self._window()
 29        if window is None:
 30            raise ba.NotFoundError("GatherTab's window no longer exists.")
 31        return window
 32
 33    def on_activate(
 34        self,
 35        parent_widget: ba.Widget,
 36        tab_button: ba.Widget,
 37        region_width: float,
 38        region_height: float,
 39        region_left: float,
 40        region_bottom: float,
 41    ) -> ba.Widget:
 42        """Called when the tab becomes the active one.
 43
 44        The tab should create and return a container widget covering the
 45        specified region.
 46        """
 47        raise RuntimeError('Should not get here.')
 48
 49    def on_deactivate(self) -> None:
 50        """Called when the tab will no longer be the active one."""
 51
 52    def save_state(self) -> None:
 53        """Called when the parent window is saving state."""
 54
 55    def restore_state(self) -> None:
 56        """Called when the parent window is restoring state."""
 57
 58
 59class GatherWindow(ba.Window):
 60    """Window for joining/inviting friends."""
 61
 62    class TabID(Enum):
 63        """Our available tab types."""
 64
 65        ABOUT = 'about'
 66        INTERNET = 'internet'
 67        PRIVATE = 'private'
 68        NEARBY = 'nearby'
 69        MANUAL = 'manual'
 70
 71    def __init__(
 72        self,
 73        transition: str | None = 'in_right',
 74        origin_widget: ba.Widget | None = None,
 75    ):
 76        # pylint: disable=too-many-statements
 77        # pylint: disable=too-many-locals
 78        # pylint: disable=cyclic-import
 79        from bastd.ui.gather.abouttab import AboutGatherTab
 80        from bastd.ui.gather.manualtab import ManualGatherTab
 81        from bastd.ui.gather.privatetab import PrivateGatherTab
 82        from bastd.ui.gather.publictab import PublicGatherTab
 83        from bastd.ui.gather.nearbytab import NearbyGatherTab
 84
 85        ba.set_analytics_screen('Gather Window')
 86        scale_origin: tuple[float, float] | None
 87        if origin_widget is not None:
 88            self._transition_out = 'out_scale'
 89            scale_origin = origin_widget.get_screen_space_center()
 90            transition = 'in_scale'
 91        else:
 92            self._transition_out = 'out_right'
 93            scale_origin = None
 94        ba.app.ui.set_main_menu_location('Gather')
 95        ba.internal.set_party_icon_always_visible(True)
 96        uiscale = ba.app.ui.uiscale
 97        self._width = 1240 if uiscale is ba.UIScale.SMALL else 1040
 98        x_offs = 100 if uiscale is ba.UIScale.SMALL else 0
 99        self._height = (
100            582
101            if uiscale is ba.UIScale.SMALL
102            else 680
103            if uiscale is ba.UIScale.MEDIUM
104            else 800
105        )
106        self._current_tab: GatherWindow.TabID | None = None
107        extra_top = 20 if uiscale is ba.UIScale.SMALL else 0
108        self._r = 'gatherWindow'
109
110        super().__init__(
111            root_widget=ba.containerwidget(
112                size=(self._width, self._height + extra_top),
113                transition=transition,
114                toolbar_visibility='menu_minimal',
115                scale_origin_stack_offset=scale_origin,
116                scale=(
117                    1.3
118                    if uiscale is ba.UIScale.SMALL
119                    else 0.97
120                    if uiscale is ba.UIScale.MEDIUM
121                    else 0.8
122                ),
123                stack_offset=(0, -11)
124                if uiscale is ba.UIScale.SMALL
125                else (0, 0)
126                if uiscale is ba.UIScale.MEDIUM
127                else (0, 0),
128            )
129        )
130
131        if uiscale is ba.UIScale.SMALL and ba.app.ui.use_toolbars:
132            ba.containerwidget(
133                edit=self._root_widget, on_cancel_call=self._back
134            )
135            self._back_button = None
136        else:
137            self._back_button = btn = ba.buttonwidget(
138                parent=self._root_widget,
139                position=(70 + x_offs, self._height - 74),
140                size=(140, 60),
141                scale=1.1,
142                autoselect=True,
143                label=ba.Lstr(resource='backText'),
144                button_type='back',
145                on_activate_call=self._back,
146            )
147            ba.containerwidget(edit=self._root_widget, cancel_button=btn)
148            ba.buttonwidget(
149                edit=btn,
150                button_type='backSmall',
151                position=(70 + x_offs, self._height - 78),
152                size=(60, 60),
153                label=ba.charstr(ba.SpecialChar.BACK),
154            )
155
156        condensed = uiscale is not ba.UIScale.LARGE
157        t_offs_y = (
158            0 if not condensed else 25 if uiscale is ba.UIScale.MEDIUM else 17
159        )
160        ba.textwidget(
161            parent=self._root_widget,
162            position=(self._width * 0.5, self._height - 42 + t_offs_y),
163            size=(0, 0),
164            color=ba.app.ui.title_color,
165            scale=(
166                1.5
167                if not condensed
168                else 1.0
169                if uiscale is ba.UIScale.MEDIUM
170                else 0.6
171            ),
172            h_align='center',
173            v_align='center',
174            text=ba.Lstr(resource=self._r + '.titleText'),
175            maxwidth=550,
176        )
177
178        scroll_buffer_h = 130 + 2 * x_offs
179        tab_buffer_h = (320 if condensed else 250) + 2 * x_offs
180
181        # Build up the set of tabs we want.
182        tabdefs: list[tuple[GatherWindow.TabID, ba.Lstr]] = [
183            (self.TabID.ABOUT, ba.Lstr(resource=self._r + '.aboutText'))
184        ]
185        if ba.internal.get_v1_account_misc_read_val(
186            'enablePublicParties', True
187        ):
188            tabdefs.append(
189                (self.TabID.INTERNET, ba.Lstr(resource=self._r + '.publicText'))
190            )
191        tabdefs.append(
192            (self.TabID.PRIVATE, ba.Lstr(resource=self._r + '.privateText'))
193        )
194        tabdefs.append(
195            (self.TabID.NEARBY, ba.Lstr(resource=self._r + '.nearbyText'))
196        )
197        tabdefs.append(
198            (self.TabID.MANUAL, ba.Lstr(resource=self._r + '.manualText'))
199        )
200
201        # On small UI, push our tabs up closer to the top of the screen to
202        # save a bit of space.
203        tabs_top_extra = 42 if condensed else 0
204        self._tab_row = TabRow(
205            self._root_widget,
206            tabdefs,
207            pos=(tab_buffer_h * 0.5, self._height - 130 + tabs_top_extra),
208            size=(self._width - tab_buffer_h, 50),
209            on_select_call=ba.WeakCall(self._set_tab),
210        )
211
212        # Now instantiate handlers for these tabs.
213        tabtypes: dict[GatherWindow.TabID, type[GatherTab]] = {
214            self.TabID.ABOUT: AboutGatherTab,
215            self.TabID.MANUAL: ManualGatherTab,
216            self.TabID.PRIVATE: PrivateGatherTab,
217            self.TabID.INTERNET: PublicGatherTab,
218            self.TabID.NEARBY: NearbyGatherTab,
219        }
220        self._tabs: dict[GatherWindow.TabID, GatherTab] = {}
221        for tab_id in self._tab_row.tabs:
222            tabtype = tabtypes.get(tab_id)
223            if tabtype is not None:
224                self._tabs[tab_id] = tabtype(self)
225
226        if ba.app.ui.use_toolbars:
227            ba.widget(
228                edit=self._tab_row.tabs[tabdefs[-1][0]].button,
229                right_widget=ba.internal.get_special_widget('party_button'),
230            )
231            if uiscale is ba.UIScale.SMALL:
232                ba.widget(
233                    edit=self._tab_row.tabs[tabdefs[0][0]].button,
234                    left_widget=ba.internal.get_special_widget('back_button'),
235                )
236
237        self._scroll_width = self._width - scroll_buffer_h
238        self._scroll_height = self._height - 180.0 + tabs_top_extra
239
240        self._scroll_left = (self._width - self._scroll_width) * 0.5
241        self._scroll_bottom = (
242            self._height - self._scroll_height - 79 - 48 + tabs_top_extra
243        )
244        buffer_h = 10
245        buffer_v = 4
246
247        # Not actually using a scroll widget anymore; just an image.
248        ba.imagewidget(
249            parent=self._root_widget,
250            position=(
251                self._scroll_left - buffer_h,
252                self._scroll_bottom - buffer_v,
253            ),
254            size=(
255                self._scroll_width + 2 * buffer_h,
256                self._scroll_height + 2 * buffer_v,
257            ),
258            texture=ba.gettexture('scrollWidget'),
259            model_transparent=ba.getmodel('softEdgeOutside'),
260        )
261        self._tab_container: ba.Widget | None = None
262
263        self._restore_state()
264
265    def __del__(self) -> None:
266        ba.internal.set_party_icon_always_visible(False)
267
268    def playlist_select(self, origin_widget: ba.Widget) -> None:
269        """Called by the private-hosting tab to select a playlist."""
270        from bastd.ui.play import PlayWindow
271
272        self._save_state()
273        ba.containerwidget(edit=self._root_widget, transition='out_left')
274        ba.app.ui.selecting_private_party_playlist = True
275        ba.app.ui.set_main_menu_window(
276            PlayWindow(origin_widget=origin_widget).get_root_widget()
277        )
278
279    def _set_tab(self, tab_id: TabID) -> None:
280        if self._current_tab is tab_id:
281            return
282        prev_tab_id = self._current_tab
283        self._current_tab = tab_id
284
285        # We wanna preserve our current tab between runs.
286        cfg = ba.app.config
287        cfg['Gather Tab'] = tab_id.value
288        cfg.commit()
289
290        # Update tab colors based on which is selected.
291        self._tab_row.update_appearance(tab_id)
292
293        if prev_tab_id is not None:
294            prev_tab = self._tabs.get(prev_tab_id)
295            if prev_tab is not None:
296                prev_tab.on_deactivate()
297
298        # Clear up prev container if it hasn't been done.
299        if self._tab_container:
300            self._tab_container.delete()
301
302        tab = self._tabs.get(tab_id)
303        if tab is not None:
304            self._tab_container = tab.on_activate(
305                self._root_widget,
306                self._tab_row.tabs[tab_id].button,
307                self._scroll_width,
308                self._scroll_height,
309                self._scroll_left,
310                self._scroll_bottom,
311            )
312            return
313
314    def _save_state(self) -> None:
315        try:
316            for tab in self._tabs.values():
317                tab.save_state()
318
319            sel = self._root_widget.get_selected_child()
320            selected_tab_ids = [
321                tab_id
322                for tab_id, tab in self._tab_row.tabs.items()
323                if sel == tab.button
324            ]
325            if sel == self._back_button:
326                sel_name = 'Back'
327            elif selected_tab_ids:
328                assert len(selected_tab_ids) == 1
329                sel_name = f'Tab:{selected_tab_ids[0].value}'
330            elif sel == self._tab_container:
331                sel_name = 'TabContainer'
332            else:
333                raise ValueError(f'unrecognized selection: \'{sel}\'')
334            ba.app.ui.window_states[type(self)] = {
335                'sel_name': sel_name,
336            }
337        except Exception:
338            ba.print_exception(f'Error saving state for {self}.')
339
340    def _restore_state(self) -> None:
341        from efro.util import enum_by_value
342
343        try:
344            for tab in self._tabs.values():
345                tab.restore_state()
346
347            sel: ba.Widget | None
348            winstate = ba.app.ui.window_states.get(type(self), {})
349            sel_name = winstate.get('sel_name', None)
350            assert isinstance(sel_name, (str, type(None)))
351            current_tab = self.TabID.ABOUT
352            gather_tab_val = ba.app.config.get('Gather Tab')
353            try:
354                stored_tab = enum_by_value(self.TabID, gather_tab_val)
355                if stored_tab in self._tab_row.tabs:
356                    current_tab = stored_tab
357            except ValueError:
358                pass
359            self._set_tab(current_tab)
360            if sel_name == 'Back':
361                sel = self._back_button
362            elif sel_name == 'TabContainer':
363                sel = self._tab_container
364            elif isinstance(sel_name, str) and sel_name.startswith('Tab:'):
365                try:
366                    sel_tab_id = enum_by_value(
367                        self.TabID, sel_name.split(':')[-1]
368                    )
369                except ValueError:
370                    sel_tab_id = self.TabID.ABOUT
371                sel = self._tab_row.tabs[sel_tab_id].button
372            else:
373                sel = self._tab_row.tabs[current_tab].button
374            ba.containerwidget(edit=self._root_widget, selected_child=sel)
375        except Exception:
376            ba.print_exception('Error restoring gather-win state.')
377
378    def _back(self) -> None:
379        from bastd.ui.mainmenu import MainMenuWindow
380
381        self._save_state()
382        ba.containerwidget(
383            edit=self._root_widget, transition=self._transition_out
384        )
385        ba.app.ui.set_main_menu_window(
386            MainMenuWindow(transition='in_left').get_root_widget()
387        )